risclog.logging 2.2.2__tar.gz → 2.3.0__tar.gz

{risclog.logging-2.2.2 → risclog_logging-2.3.0}/CHANGES.rst

@@ -3,6 +3,20 @@ Change log for risclog.logging
 ==============================
 
 
+2.3.0 (2026-07-01)
+==================
+
+- Sanitize ``log_decorator`` values by redacting secrets and truncating large
+  arguments, keyword arguments, return values and exception messages, including
+  S3-compatible credentials from environment variables.
+
+
+2.2.3 (2026-06-30)
+==================
+
+- Reenable uvicorn logger.
+
+
 2.2.2 (2026-04-13)
 ==================
 

{risclog.logging-2.2.2 → risclog_logging-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: risclog.logging
-Version: 2.2.2
+Version: 2.3.0
 Summary: A logger based on structlog
 Home-page: https://github.com/risclog-solution/risclog.logging
 Author: riscLOG Solution GmbH
@@ -12,13 +12,9 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: German
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-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.8
+Requires-Python: >=3.12
 License-File: LICENSE
 License-File: AUTHORS.rst
 Requires-Dist: structlog
@@ -29,18 +25,29 @@ Requires-Dist: Sphinx; extra == "docs"
 Provides-Extra: test
 Requires-Dist: pytest-cache; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: pytest-flake8; extra == "test"
 Requires-Dist: pytest-rerunfailures; extra == "test"
 Requires-Dist: pytest-sugar; extra == "test"
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: coverage; extra == "test"
-Requires-Dist: flake8<4; extra == "test"
+Requires-Dist: ruff; extra == "test"
 Requires-Dist: mock; extra == "test"
 Requires-Dist: requests; extra == "test"
 Requires-Dist: httpx; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"
 Requires-Dist: fastapi; extra == "test"
 Requires-Dist: uvicorn; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ===================
 risclog.logging
@@ -212,6 +219,56 @@ The ``@log_decorator`` automatically logs function execution with comprehensive
         pass
     # Logs: [Decorator error in risky_operation] error='division by zero'
 
+**Sanitizing decorator values:**
+
+Decorator logs sanitize ``args``, ``kwargs``, ``result`` and exception strings
+before they are written. Sensitive field names such as ``password``, ``token``,
+``api_key``, ``authorization``, ``cookie``, ``secret``, ``access_key`` and
+``secret_key`` are replaced with ``***REDACTED***``. Secret values from matching
+environment variables such as ``S3_SECRET_KEY`` or ``MINIO_ACCESS_KEY`` are also
+redacted when they appear inside log strings. Long strings, large containers,
+binary data, private key blocks and recursive structures are shortened
+automatically.
+
+Example:
+
+.. code-block:: python
+
+    import os
+    from risclog.logging import log_decorator
+
+    os.environ["S3_SECRET_KEY"] = "storage-secret-value"
+
+    @log_decorator
+    def upload_file(password: str, headers: dict) -> dict:
+        return {
+            "bucket": "documents",
+            "secret_key": "storage-secret-value",
+            "preview": "x" * 1000,
+        }
+
+    upload_file(
+        password="plain-password",
+        headers={"Authorization": "Bearer request-token"},
+    )
+
+    # Logs password='***REDACTED***'
+    # Logs headers={'Authorization': '***REDACTED***'}
+    # Logs result.secret_key='***REDACTED***'
+    # Logs result.preview='xxxxx...[truncated](chars=1000)'
+
+The default limits can be adjusted via environment variables:
+
+.. code-block:: bash
+
+    export LOG_DECORATOR_MAX_STRING_LENGTH=500
+    export LOG_DECORATOR_MAX_COLLECTION_ITEMS=20
+    export LOG_DECORATOR_MAX_DEPTH=4
+    export LOG_DECORATOR_MAX_EXCEPTION_LENGTH=8000
+    export LOG_DECORATOR_MIN_SECRET_VALUE_LENGTH=8
+    export LOG_DECORATOR_REDACT_KEYS="iban,customer_secret"
+    export LOG_DECORATOR_REDACT_ENV_VARS="CUSTOM_S3_SECRET"
+
 Using the Decorator in Classes
 ------------------------------
 
@@ -496,6 +553,20 @@ Change log for risclog.logging
 ==============================
 
 
+2.3.0 (2026-07-01)
+==================
+
+- Sanitize ``log_decorator`` values by redacting secrets and truncating large
+  arguments, keyword arguments, return values and exception messages, including
+  S3-compatible credentials from environment variables.
+
+
+2.2.3 (2026-06-30)
+==================
+
+- Reenable uvicorn logger.
+
+
 2.2.2 (2026-04-13)
 ==================
 

{risclog.logging-2.2.2 → risclog_logging-2.3.0}/README.rst

@@ -168,6 +168,56 @@ The ``@log_decorator`` automatically logs function execution with comprehensive
         pass
     # Logs: [Decorator error in risky_operation] error='division by zero'
 
+**Sanitizing decorator values:**
+
+Decorator logs sanitize ``args``, ``kwargs``, ``result`` and exception strings
+before they are written. Sensitive field names such as ``password``, ``token``,
+``api_key``, ``authorization``, ``cookie``, ``secret``, ``access_key`` and
+``secret_key`` are replaced with ``***REDACTED***``. Secret values from matching
+environment variables such as ``S3_SECRET_KEY`` or ``MINIO_ACCESS_KEY`` are also
+redacted when they appear inside log strings. Long strings, large containers,
+binary data, private key blocks and recursive structures are shortened
+automatically.
+
+Example:
+
+.. code-block:: python
+
+    import os
+    from risclog.logging import log_decorator
+
+    os.environ["S3_SECRET_KEY"] = "storage-secret-value"
+
+    @log_decorator
+    def upload_file(password: str, headers: dict) -> dict:
+        return {
+            "bucket": "documents",
+            "secret_key": "storage-secret-value",
+            "preview": "x" * 1000,
+        }
+
+    upload_file(
+        password="plain-password",
+        headers={"Authorization": "Bearer request-token"},
+    )
+
+    # Logs password='***REDACTED***'
+    # Logs headers={'Authorization': '***REDACTED***'}
+    # Logs result.secret_key='***REDACTED***'
+    # Logs result.preview='xxxxx...[truncated](chars=1000)'
+
+The default limits can be adjusted via environment variables:
+
+.. code-block:: bash
+
+    export LOG_DECORATOR_MAX_STRING_LENGTH=500
+    export LOG_DECORATOR_MAX_COLLECTION_ITEMS=20
+    export LOG_DECORATOR_MAX_DEPTH=4
+    export LOG_DECORATOR_MAX_EXCEPTION_LENGTH=8000
+    export LOG_DECORATOR_MIN_SECRET_VALUE_LENGTH=8
+    export LOG_DECORATOR_REDACT_KEYS="iban,customer_secret"
+    export LOG_DECORATOR_REDACT_ENV_VARS="CUSTOM_S3_SECRET"
+
 Using the Decorator in Classes
 ------------------------------
 

{risclog.logging-2.2.2 → risclog_logging-2.3.0}/pyproject.toml

@@ -37,7 +37,7 @@ exclude_lines = [
 
 [tool.black]
 line-length = 79
-target-version = ['py39']
+target-version = ['py312']
 exclude = '''
 /(
     \.eggs

{risclog.logging-2.2.2 → risclog_logging-2.3.0}/setup.py

@@ -13,17 +13,13 @@ with open("CHANGES.rst") as history_file:
 setup(
     author="riscLOG Solution GmbH",
     author_email="info@risclog.de",
-    python_requires=">=3.8",
+    python_requires=">=3.12",
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
         "Natural Language :: German",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "Programming Language :: Python :: 3.13",
     ],
@@ -41,13 +37,12 @@ setup(
         "test": [
             "pytest-cache",
             "pytest-cov",
-            "pytest-flake8",
             "pytest-rerunfailures",
             "pytest-sugar",
             "pytest",
             "coverage",
             # https://github.com/PyCQA/flake8/issues/1419#issuecomment-947243876
-            "flake8<4",
+            "ruff",
             "mock",
             "requests",
             "httpx",
@@ -62,9 +57,8 @@ setup(
     keywords="risclog.logging",
     name="risclog.logging",
     packages=find_namespace_packages("src", include=["risclog.*"]),
-    namespace_packages=["risclog"],
     package_dir={"": "src"},
     url="https://github.com/risclog-solution/risclog.logging",
-    version="2.2.2",
+    version="2.3.0",
     zip_safe=False,
 )