Skip to content

Commit ba07621

Browse files
committed
fix flake8 E501
1 parent 5bc4062 commit ba07621

6 files changed

Lines changed: 8 additions & 8 deletions

File tree

.github/workflows/python-test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ jobs:
4747
run: |
4848
# Stop the build if there are Python syntax errors or undefined names
4949
flake8 ./objwatch ./examples --count --select=E9,F63,F7,F82 --show-source --statistics
50-
# Exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
51-
flake8 ./objwatch ./examples --count --exit-zero --max-complexity=16 --max-line-length=127 --statistics
50+
# The GitHub editor is 127 chars wide
51+
flake8 ./objwatch ./examples --count --max-complexity=16 --max-line-length=127 --statistics
5252
5353
- name: Type check with mypy
5454
run: |

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ ObjWatch offers customizable logging formats and tracing options to suit various
7171
- `exclude_targets` (list, optional): Files or modules to exclude from monitoring.
7272
- `with_locals` (bool, optional): Enable tracing and logging of local variables within functions during their execution.
7373
- `with_globals` (bool, optional): Enable tracing and logging of global variables across function calls. When you input the global variables in the `targets` list, you need to enable this option.
74-
- `output` (str, optional): Path to a file for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
74+
- `output` (str, optional): File path for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
7575
- `output_json` (str, optional): Path to the JSON file for writing structured logs. If specified, tracing information will be saved in a nested JSON format for easy analysis.
7676
- `level` (str, optional): Logging level (e.g., `logging.DEBUG`, `logging.INFO`, `force` etc.). To ensure logs are captured even if the logger is disabled or removed by external libraries, you can set `level` to "force", which will bypass standard logging handlers and use `print()` to output log messages directly to the console, ensuring that critical debugging information is not lost.
7777
- `simple` (bool, optional): Defaults to True, disable simple logging mode with the format `"[{time}] [{level}] objwatch: {msg}"`.

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Parameters
7575
- `exclude_targets` (list, optional): Files or modules to exclude from monitoring.
7676
- `with_locals` (bool, optional): Enable tracing and logging of local variables within functions during their execution.
7777
- `with_globals` (bool, optional): Enable tracing and logging of global variables across function calls. When you input the global variables in the `targets` list, you need to enable this option.
78-
- `output` (str, optional): Path to a file for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
78+
- `output` (str, optional): File path for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
7979
- `output_json` (str, optional): Path to the JSON file for writing structured logs. If specified, tracing information will be saved in a nested JSON format for easy analysis.
8080
- `level` (str, optional): Logging level (e.g., `logging.DEBUG`, `logging.INFO`, `force` etc.). To ensure logs are captured even if the logger is disabled or removed by external libraries, you can set `level` to "force", which will bypass standard logging handlers and use `print()` to output log messages directly to the console, ensuring that critical debugging information is not lost.
8181
- `simple` (bool, optional): Defaults to True, disable simple logging mode with the format `"[{time}] [{level}] objwatch: {msg}"`.

objwatch/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class ObjWatchConfig:
1717
exclude_targets (Optional[List[Union[str, ModuleType]]]): Files or modules to exclude from monitoring.
1818
with_locals (bool): Enable tracing and logging of local variables within functions.
1919
with_globals (bool): Enable tracing and logging of global variables across function calls.
20-
output (Optional[str]): Path to a file for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
20+
output (Optional[str]): File path for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
2121
output_json (Optional[str]): Path to the JSON file for writing structured logs.
2222
level (int): Logging level (e.g., logging.DEBUG, logging.INFO).
2323
simple (bool): Defaults to True, disable simple logging mode with the format "[{time}] [{level}] objwatch: {msg}".

objwatch/core.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def __init__(
3939
exclude_targets (Optional[List[Union[str, ModuleType]]]): Files or modules to exclude from monitoring.
4040
with_locals (bool): Enable tracing and logging of local variables within functions.
4141
with_globals (bool): Enable tracing and logging of global variables across function calls.
42-
output (Optional[str]): Path to a file for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
42+
output (Optional[str]): File path for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
4343
output_json (Optional[str]): Path to the JSON file for writing structured logs.
4444
level (int): Logging level (e.g., logging.DEBUG, logging.INFO).
4545
simple (bool): Defaults to True, disable simple logging mode with the format "[{time}] [{level}] objwatch: {msg}".
@@ -114,7 +114,7 @@ def watch(
114114
exclude_targets (Optional[List[Union[str, ModuleType]]]): Files or modules to exclude from monitoring.
115115
with_locals (bool): Enable tracing and logging of local variables within functions.
116116
with_globals (bool): Enable tracing and logging of global variables across function calls.
117-
output (Optional[str]): Path to a file for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
117+
output (Optional[str]): File path for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
118118
output_json (Optional[str]): Path to the JSON file for writing structured logs.
119119
level (int): Logging level (e.g., logging.DEBUG, logging.INFO).
120120
simple (bool): Defaults to True, disable simple logging mode with the format "[{time}] [{level}] objwatch: {msg}".

objwatch/utils/logger.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def create_logger(
1717
1818
Args:
1919
name (str): Name of the logger.
20-
output (Optional[str]): Path to a file for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
20+
output (Optional[str]): File path for writing logs, must end with '.objwatch' for ObjWatch Log Viewer extension.
2121
level (Union[int, str]): Logging level (e.g., logging.DEBUG, logging.INFO, "force").
2222
simple (bool): Defaults to True, disable simple logging mode with the format "[{time}] [{level}] objwatch: {msg}".
2323
"""

0 commit comments

Comments
 (0)