python-devlog 1.1__tar.gz → 2.0__tar.gz

python_devlog-2.0/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+name: Publish Python distributions to PyPI and TestPyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build setuptools-scm>=8
+    - name: Build package
+      run: python -m build
+    - name: Publish distribution to Test PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository-url: https://test.pypi.org/legacy/
+        skip-existing: true
+    - name: Publish distribution to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

python_devlog-2.0/.github/workflows/python-test.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-cov pytest-asyncio
+        pip install -e .
+    - name: Test with pytest
+      run: pytest

python_devlog-2.0/.gitignore

@@ -0,0 +1,6 @@
+/.idea/.gitignore
+/.idea/devlog.iml
+/.idea/modules.xml
+/.idea/inspectionProfiles/profiles_settings.xml
+/.idea/inspectionProfiles/Project_Default.xml
+/.idea/vcs.xml

python_devlog-2.0/CHANGELOG.txt

@@ -0,0 +1,21 @@
+Change Log
+==========
+1.2 (13/06/2022)
+----------------
+- Add anti log the same exception twice
+- Add custom traceback
+- Now the module can be excluded from the traceback
+
+1.1 (09/06/2022)
+----------------
+- Add unit testing and tested on python 3.6 to 3.10
+- Stable release of the package
+
+1.0b2 (21/05/2022)
+------------------
+- Change the decorator from camelCase to snake_case
+- Treat the no parenthesis decorator as an empty parenthesis decorator
+
+1.0b1 (21/05/2022)
+------------------
+- First Release

python_devlog-2.0/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: python-devlog
+Version: 2.0
+Summary: No more logging in your code business logic with decorators
+Author-email: めがねこ <neko@meganeko.dev>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/MeGaNeKoS/devlog
+Keywords: clean code,decorators,logging
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Dynamic: license-file
+
+[![GitHub latest version](https://img.shields.io/github/v/release/MeGaNeKoS/devlog?style=for-the-badge)](https://github.com/MeGaNeKoS/devlog/releases/latest)
+[![Tests](https://img.shields.io/github/actions/workflow/status/MeGaNeKoS/devlog/python-test.yml?label=Tests&style=for-the-badge)](https://github.com/MeGaNeKoS/devlog/actions/workflows/python-test.yml)
+[![Publish](https://img.shields.io/github/actions/workflow/status/MeGaNeKoS/devlog/python-publish.yml?label=Publish&style=for-the-badge)](https://github.com/MeGaNeKoS/devlog/actions/workflows/python-publish.yml)
+![Size](https://img.shields.io/github/repo-size/MeGaNeKoS/devlog?style=for-the-badge)
+![License](https://img.shields.io/github/license/MeGaNeKoS/devlog?style=for-the-badge)
+
+devlog
+=====
+
+No more logging in your code business logic with python decorators.
+
+Logging is a very powerful tool for debugging and monitoring your code. But if you are often adding logging
+statements, you will quickly find your code overcrowded with them.
+
+Fortunately, you can avoid this by using python decorators. This library provides easy logging for your code without
+stealing readability and maintainability. It also provides stack traces with full local variables, value sanitization,
+and async support.
+
+**Requires Python 3.9+**
+
+Installation
+------------
+
+```bash
+pip install python-devlog
+```
+
+How to use
+----------
+
+Add the decorator to your function. Depending on when you want to log, you can use:
+
+```python
+import logging
+from devlog import log_on_start, log_on_end, log_on_error
+
+logging.basicConfig(level=logging.DEBUG)
+
+
+@log_on_start
+@log_on_end
+def add(a, b):
+    return a + b
+
+
+@log_on_error
+def divide(a, b):
+    return a / b
+
+
+if __name__ == '__main__':
+    add(1, b=2)
+    # INFO:__main__:Start func add with args (1,), kwargs {'b': 2}
+    # INFO:__main__:Successfully run func add with args (1,), kwargs {'b': 2}
+
+    divide("abc", "def")
+    # ERROR:__main__:Error in func divide with args ('abc', 'def'), kwargs {}
+    # 	unsupported operand type(s) for /: 'str' and 'str'.
+```
+
+### Async support
+
+All decorators work with async functions automatically:
+
+```python
+@log_on_start
+@log_on_end
+@log_on_error
+async def fetch_data(url):
+    ...
+```
+
+### Value sanitization
+
+Prevent sensitive values from appearing in logs using `Sensitive` or `sanitize_params`:
+
+```python
+from devlog import log_on_start, Sensitive
+
+
+# Option 1: Wrap the value — function receives the real value, logs show "***"
+@log_on_start
+def login(username, password):
+    ...
+
+login("admin", Sensitive("hunter2"))
+# INFO:__main__:Start func login with args ('admin', '***'), kwargs {}
+
+
+# Option 2: Auto-redact by parameter name
+@log_on_start(sanitize_params={"password", "token", "secret"})
+def connect(host, token):
+    ...
+
+connect("example.com", "sk-abc123")
+# INFO:__main__:Start func connect with args ('example.com', '***'), kwargs {}
+```
+
+`Sensitive` is a transparent proxy — the wrapped function receives the real value. Only devlog log output is redacted.
+
+What devlog can do for you
+---------------------------
+
+### Decorators
+
+devlog provides three decorators:
+
+- **log_on_start**: Log when the function is called.
+- **log_on_end**: Log when the function finishes successfully.
+- **log_on_error**: Log when the function raises an exception.
+
+Use variables in messages
+=========================
+
+The message given to decorators is treated as a format string which takes the function arguments as format
+arguments.
+
+```python
+import logging
+from devlog import log_on_start
+
+logging.basicConfig(level=logging.DEBUG)
+
+
+@log_on_start(logging.INFO, 'Start func {callable.__name__} with args {args}, kwargs {kwargs}')
+def hello(name):
+    print("Hello, {}".format(name))
+
+
+if __name__ == "__main__":
+    hello("World")
+```
+
+Which will print:
+```INFO:__main__:Start func hello with args ('World',), kwargs {}```
+
+### Documentation
+
+#### Format variables
+
+The following variables are available in the format string:
+
+| Default variable name | Description                                             | LogOnStart | LogOnEnd | LogOnError |
+|-----------------------|---------------------------------------------------------|------------|----------|------------|
+| callable              | The function object                                     | Yes        | Yes      | Yes        |
+| *args/kwargs*         | The arguments, key arguments passed to the function     | Yes        | Yes      | Yes        |
+| result                | The return value of the function                        | No         | Yes      | No         |
+| error                 | The error object if the function is finished with error | No         | No       | Yes        |
+
+#### Base arguments
+
+Available arguments in all decorators:
+
+| Argument                 | Description                                                                                                                                                                                   |
+|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| logger                   | The logger object. If no logger is given, devlog will create one with the module name where the function is defined. Default is `logging.getLogger(callable.__module__)`                       |
+| handler                  | A custom log handler object. Only available if no logger object is given.                                                                                                                     |
+| args_kwargs              | Set `True` to use `{args}`, `{kwargs}` format, or `False` to use function parameter names. Default `True`                                                                                    |
+| callable_format_variable | The format variable name for the callable. Default is `callable`                                                                                                                              |
+| trace_stack              | Set to `True` to get the full stack trace. Default is `False`                                                                                                                                 |
+| capture_locals           | Set to `True` to capture local variables in stack frames. Default is `False` (or `trace_stack` on log_on_error)                                                                               |
+| include_decorator        | Set to `True` to include devlog frames in the stack trace. Default is `False`                                                                                                                 |
+| sanitize_params          | A set of parameter names to auto-redact in log messages. Default is `None`                                                                                                                    |
+
+#### log_on_start
+
+| Argument | Description                                                                                                                                                                 |
+|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| level    | The level of the log message. Default is `logging.INFO`                                                                                                                     |
+| message  | The message to log. Can use `{args}` `{kwargs}` or function parameter names, but not both. Default is `Start func {callable.__name__} with args {args}, kwargs {kwargs}`    |
+
+#### log_on_end
+
+| Argument               | Description                                                                                                                                                                            |
+|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| level                  | The level of the log message. Default is `logging.INFO`                                                                                                                                |
+| message                | The message to log. Can use `{args}` `{kwargs}` or function parameter names, but not both. Default is `Successfully run func {callable.__name__} with args {args}, kwargs {kwargs}`    |
+| result_format_variable | The format variable name for the return value. Default is `result`                                                                                                                     |
+
+#### log_on_error
+
+| Argument                  | Description                                                                                                                                                                          |
+|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| level                     | The level of the log message. Default is `logging.ERROR`                                                                                                                             |
+| message                   | The message to log. Can use `{args}` `{kwargs}` or function parameter names, but not both. Default is `Error in func {callable.__name__} with args {args}, kwargs {kwargs}\n{error}` |
+| on_exceptions             | Exception classes to catch and log. Default catches all exceptions.                                                                                                                  |
+| reraise                   | Whether to reraise the exception after logging. Default is `True`                                                                                                                    |
+| exception_format_variable | The format variable name for the exception. Default is `error`                                                                                                                       |
+
+### Extras
+
+#### Custom exception hook
+
+Override the default exception hook to write crash logs with local variable capture:
+
+```python
+import devlog
+
+devlog.system_excepthook_overwrite()  # Overwrite the default exception hook
+```
+
+This replaces `sys.excepthook` with devlog's handler, which writes detailed crash information to a file.
+
+| Argument | Description                                                   |
+|----------|---------------------------------------------------------------|
+| out_file | The path to the file to write the crash log. Default is `crash.log` |

python_devlog-2.0/README.md

@@ -0,0 +1,206 @@
+[![GitHub latest version](https://img.shields.io/github/v/release/MeGaNeKoS/devlog?style=for-the-badge)](https://github.com/MeGaNeKoS/devlog/releases/latest)
+[![Tests](https://img.shields.io/github/actions/workflow/status/MeGaNeKoS/devlog/python-test.yml?label=Tests&style=for-the-badge)](https://github.com/MeGaNeKoS/devlog/actions/workflows/python-test.yml)
+[![Publish](https://img.shields.io/github/actions/workflow/status/MeGaNeKoS/devlog/python-publish.yml?label=Publish&style=for-the-badge)](https://github.com/MeGaNeKoS/devlog/actions/workflows/python-publish.yml)
+![Size](https://img.shields.io/github/repo-size/MeGaNeKoS/devlog?style=for-the-badge)
+![License](https://img.shields.io/github/license/MeGaNeKoS/devlog?style=for-the-badge)
+
+devlog
+=====
+
+No more logging in your code business logic with python decorators.
+
+Logging is a very powerful tool for debugging and monitoring your code. But if you are often adding logging
+statements, you will quickly find your code overcrowded with them.
+
+Fortunately, you can avoid this by using python decorators. This library provides easy logging for your code without
+stealing readability and maintainability. It also provides stack traces with full local variables, value sanitization,
+and async support.
+
+**Requires Python 3.9+**
+
+Installation
+------------
+
+```bash
+pip install python-devlog
+```
+
+How to use
+----------
+
+Add the decorator to your function. Depending on when you want to log, you can use:
+
+```python
+import logging
+from devlog import log_on_start, log_on_end, log_on_error
+
+logging.basicConfig(level=logging.DEBUG)
+
+
+@log_on_start
+@log_on_end
+def add(a, b):
+    return a + b
+
+
+@log_on_error
+def divide(a, b):
+    return a / b
+
+
+if __name__ == '__main__':
+    add(1, b=2)
+    # INFO:__main__:Start func add with args (1,), kwargs {'b': 2}
+    # INFO:__main__:Successfully run func add with args (1,), kwargs {'b': 2}
+
+    divide("abc", "def")
+    # ERROR:__main__:Error in func divide with args ('abc', 'def'), kwargs {}
+    # 	unsupported operand type(s) for /: 'str' and 'str'.
+```
+
+### Async support
+
+All decorators work with async functions automatically:
+
+```python
+@log_on_start
+@log_on_end
+@log_on_error
+async def fetch_data(url):
+    ...
+```
+
+### Value sanitization
+
+Prevent sensitive values from appearing in logs using `Sensitive` or `sanitize_params`:
+
+```python
+from devlog import log_on_start, Sensitive
+
+
+# Option 1: Wrap the value — function receives the real value, logs show "***"
+@log_on_start
+def login(username, password):
+    ...
+
+login("admin", Sensitive("hunter2"))
+# INFO:__main__:Start func login with args ('admin', '***'), kwargs {}
+
+
+# Option 2: Auto-redact by parameter name
+@log_on_start(sanitize_params={"password", "token", "secret"})
+def connect(host, token):
+    ...
+
+connect("example.com", "sk-abc123")
+# INFO:__main__:Start func connect with args ('example.com', '***'), kwargs {}
+```
+
+`Sensitive` is a transparent proxy — the wrapped function receives the real value. Only devlog log output is redacted.
+
+What devlog can do for you
+---------------------------
+
+### Decorators
+
+devlog provides three decorators:
+
+- **log_on_start**: Log when the function is called.
+- **log_on_end**: Log when the function finishes successfully.
+- **log_on_error**: Log when the function raises an exception.
+
+Use variables in messages
+=========================
+
+The message given to decorators is treated as a format string which takes the function arguments as format
+arguments.
+
+```python
+import logging
+from devlog import log_on_start
+
+logging.basicConfig(level=logging.DEBUG)
+
+
+@log_on_start(logging.INFO, 'Start func {callable.__name__} with args {args}, kwargs {kwargs}')
+def hello(name):
+    print("Hello, {}".format(name))
+
+
+if __name__ == "__main__":
+    hello("World")
+```
+
+Which will print:
+```INFO:__main__:Start func hello with args ('World',), kwargs {}```
+
+### Documentation
+
+#### Format variables
+
+The following variables are available in the format string:
+
+| Default variable name | Description                                             | LogOnStart | LogOnEnd | LogOnError |
+|-----------------------|---------------------------------------------------------|------------|----------|------------|
+| callable              | The function object                                     | Yes        | Yes      | Yes        |
+| *args/kwargs*         | The arguments, key arguments passed to the function     | Yes        | Yes      | Yes        |
+| result                | The return value of the function                        | No         | Yes      | No         |
+| error                 | The error object if the function is finished with error | No         | No       | Yes        |
+
+#### Base arguments
+
+Available arguments in all decorators:
+
+| Argument                 | Description                                                                                                                                                                                   |
+|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| logger                   | The logger object. If no logger is given, devlog will create one with the module name where the function is defined. Default is `logging.getLogger(callable.__module__)`                       |
+| handler                  | A custom log handler object. Only available if no logger object is given.                                                                                                                     |
+| args_kwargs              | Set `True` to use `{args}`, `{kwargs}` format, or `False` to use function parameter names. Default `True`                                                                                    |
+| callable_format_variable | The format variable name for the callable. Default is `callable`                                                                                                                              |
+| trace_stack              | Set to `True` to get the full stack trace. Default is `False`                                                                                                                                 |
+| capture_locals           | Set to `True` to capture local variables in stack frames. Default is `False` (or `trace_stack` on log_on_error)                                                                               |
+| include_decorator        | Set to `True` to include devlog frames in the stack trace. Default is `False`                                                                                                                 |
+| sanitize_params          | A set of parameter names to auto-redact in log messages. Default is `None`                                                                                                                    |
+
+#### log_on_start
+
+| Argument | Description                                                                                                                                                                 |
+|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| level    | The level of the log message. Default is `logging.INFO`                                                                                                                     |
+| message  | The message to log. Can use `{args}` `{kwargs}` or function parameter names, but not both. Default is `Start func {callable.__name__} with args {args}, kwargs {kwargs}`    |
+
+#### log_on_end
+
+| Argument               | Description                                                                                                                                                                            |
+|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| level                  | The level of the log message. Default is `logging.INFO`                                                                                                                                |
+| message                | The message to log. Can use `{args}` `{kwargs}` or function parameter names, but not both. Default is `Successfully run func {callable.__name__} with args {args}, kwargs {kwargs}`    |
+| result_format_variable | The format variable name for the return value. Default is `result`                                                                                                                     |
+
+#### log_on_error
+
+| Argument                  | Description                                                                                                                                                                          |
+|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| level                     | The level of the log message. Default is `logging.ERROR`                                                                                                                             |
+| message                   | The message to log. Can use `{args}` `{kwargs}` or function parameter names, but not both. Default is `Error in func {callable.__name__} with args {args}, kwargs {kwargs}\n{error}` |
+| on_exceptions             | Exception classes to catch and log. Default catches all exceptions.                                                                                                                  |
+| reraise                   | Whether to reraise the exception after logging. Default is `True`                                                                                                                    |
+| exception_format_variable | The format variable name for the exception. Default is `error`                                                                                                                       |
+
+### Extras
+
+#### Custom exception hook
+
+Override the default exception hook to write crash logs with local variable capture:
+
+```python
+import devlog
+
+devlog.system_excepthook_overwrite()  # Overwrite the default exception hook
+```
+
+This replaces `sys.excepthook` with devlog's handler, which writes detailed crash information to a file.
+
+| Argument | Description                                                   |
+|----------|---------------------------------------------------------------|
+| out_file | The path to the file to write the crash log. Default is `crash.log` |

{python-devlog-1.1 → python_devlog-2.0}/devlog/__init__.py

@@ -1,9 +1,8 @@
 from .custom_excepthook import system_excepthook_overwrite
-from .decorator import LogOnStart, LogOnError, LogOnEnd
-from .stack_trace import set_stack_removal_frames, set_stack_start_frames
+from .decorators import LogOnStart, LogOnError, LogOnEnd
+from .sanitize import Sensitive
 
-__all__ = ["log_on_start", "log_on_end", "log_on_error", "system_excepthook_overwrite", "set_stack_removal_frames",
-           "set_stack_start_frames"]
+__all__ = ["log_on_start", "log_on_end", "log_on_error", "system_excepthook_overwrite", "Sensitive"]
 
 
 def log_on_start(*args, **kwargs):