mh_structlog 0.0.41__tar.gz → 0.0.44__tar.gz

{mh_structlog-0.0.41 → mh_structlog-0.0.44}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mh_structlog
-Version: 0.0.41
+Version: 0.0.44
 Summary: Some Structlog configuration and wrappers to easily use structlog.
 Author: Mathieu Hinderyckx
 Author-email: Mathieu Hinderyckx <mathieu.hinderyckx@gmail.com>
@@ -8,14 +8,15 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Dist: orjson>=3.11.5
-Requires-Dist: rich>=14.0.0
+Requires-Dist: rich>=14.2.0
 Requires-Dist: structlog>=25.5.0
-Requires-Dist: structlog-sentry>=2.2.1
 Requires-Dist: aws-lambda-powertools>=3.23.0 ; extra == 'aws'
 Requires-Dist: django>=5.0 ; extra == 'django'
-Requires-Python: >=3.11
+Requires-Dist: structlog-sentry>=2.2.1 ; extra == 'sentry'
+Requires-Python: >=3.10
 Provides-Extra: aws
 Provides-Extra: django
+Provides-Extra: sentry
 Description-Content-Type: text/markdown
 
 # MH-Structlog
@@ -187,3 +188,17 @@ setup(
 )
 
 ```
+
+## Development
+
+Install the environment:
+
+```shell
+uv sync --python-preference only-managed --frozen --all-extras --all-groups
+```
+
+Run the unittests:
+
+```shell
+uv run pytest -s --pdb --pdbcls=IPython.terminal.debugger:Pdb
+```

{mh_structlog-0.0.41 → mh_structlog-0.0.44}/README.md

@@ -167,3 +167,17 @@ setup(
 )
 
 ```
+
+## Development
+
+Install the environment:
+
+```shell
+uv sync --python-preference only-managed --frozen --all-extras --all-groups
+```
+
+Run the unittests:
+
+```shell
+uv run pytest -s --pdb --pdbcls=IPython.terminal.debugger:Pdb
+```

{mh_structlog-0.0.41 → mh_structlog-0.0.44}/pyproject.toml

@@ -8,9 +8,9 @@ authors = [
     { name = "Mathieu Hinderyckx", email = "mathieu.hinderyckx@gmail.com" },
 ]
 description = "Some Structlog configuration and wrappers to easily use structlog."
-version = "0.0.41"
+version = "0.0.44"
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.10"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",
@@ -18,9 +18,8 @@ classifiers = [
 ]
 dependencies = [
     "orjson>=3.11.5",
-    "rich>=14.0.0",
+    "rich>=14.2.0",
     "structlog>=25.5.0",
-    "structlog-sentry>=2.2.1",
 ]
 [project.optional-dependencies]
 django = [
@@ -29,42 +28,34 @@ django = [
 aws = [
     "aws-lambda-powertools>=3.23.0",
 ]
+sentry = [
+    "structlog-sentry>=2.2.1",
+]
 
 [tool.setuptools_scm]
 version_file = "src/mh_structlog/_version.py"
 
 [dependency-groups]
-dev = ["ipdb>=0.13.13", "ipython>=8.18.1", "pre-commit>=4.0.1", "ruff>=0.12.1"]
+dev = [
+    "ipdb>=0.13.13",
+    "ipython>=8.18.1",
+    "ruff>=0.14.9",
+]
 tests = [
-    "coverage>=7.5.3",
+    "coverage>=7.13.0",
+    "django>=5",
+    "freezegun>=1.5.5",
     "pytest>=9.0.2",
     "pytest-cov>=7.0.0",
     "pytest-django>=4.11.1",
     "pytest-env>=1.2.0",
-    "pytest-randomly>=3.15.0",
+    "pytest-randomly>=4.0.1",
     "pytest-sugar>=1.1.1",
-    "django>=5.2",
-    "freezegun>=1.5.5",
-]
-pages = [
-    "black>=24.10.0",
-    "mkdocs-literate-nav>=0.6.1",
-    "mkdocs-gen-files>=0.5.0",
-    "mkdocstrings[python]>=0.26.2",
-    "pymdown-extensions>=10.12",
-    "mkdocs-include-dir-to-nav>=1.2.0",
-    "mkdocs-git-authors-plugin>=0.9.2",
-    "mkdocs-glightbox>=0.4.0",
-    "mkdocs-git-revision-date-localized-plugin>=1.3.0",
-    "mkdocs-roamlinks-plugin>=0.3.2",
-    "mkdocs>=1.6.1",
-    "mkdocs-material>=9.5.44",
 ]
 
 [tool.uv]
-required-version = ">=0.9.11"
+required-version = ">=0.9.17"
 package = true
-cache-keys = [{ file = "pyproject.toml" }]
 environments = [
     "sys_platform == 'darwin'",
     "sys_platform == 'linux'",
@@ -76,8 +67,8 @@ environments = [
 line-length = 120
 indent-width = 4
 preview = false
-required-version = ">=0.4.5"
-target-version = "py39"
+required-version = ">=0.12"
+target-version = "py310"
 unsafe-fixes = true
 
 # Overwritten in CI/CD

{mh_structlog-0.0.41 → mh_structlog-0.0.44}/src/mh_structlog/__init__.py

@@ -5,6 +5,7 @@ from logging import CRITICAL, DEBUG, ERROR, FATAL, INFO, WARN, WARNING
 import structlog
 
 from .config import filter_named_logger, setup
+from .processors import FieldDropper, FieldRenamer, FieldsAdder
 from .utils import determine_name_for_logger
 
 
@@ -28,6 +29,9 @@ __all__ = [
     "INFO",
     "WARN",
     "WARNING",
+    "FieldDropper",
+    "FieldRenamer",
+    "FieldsAdder",
     "filter_named_logger",
     "getLogger",
     "getLogger",

{mh_structlog-0.0.41 → mh_structlog-0.0.44}/src/mh_structlog/config.py

@@ -30,6 +30,7 @@ def setup(  # noqa: PLR0912, PLR0915, C901
     testing_mode: bool = False,  # noqa: FBT001, FBT002
     max_frames: int = 100,
     sentry_config: dict | None = None,
+    additional_processors: list | None = None,  # noqa: FBT001, FBT002
 ) -> None:
     """This method configures structlog and the standard library logging module."""
     global SELECTED_LOG_FORMAT  # noqa: PLW0603
@@ -49,6 +50,9 @@ def setup(  # noqa: PLR0912, PLR0915, C901
         structlog.contextvars.merge_contextvars,  # add variables and bound data from global context
     ]
 
+    if additional_processors:
+        shared_processors.extend(additional_processors)
+
     if max_frames <= 0:
         raise StructlogLoggingConfigExceptionError("max_frames should be a positive integer.")
 
@@ -61,13 +65,20 @@ def setup(  # noqa: PLR0912, PLR0915, C901
     SELECTED_LOG_FORMAT = log_format
 
     if sentry_config and sentry_config.get('active', True):
+        try:
+            from . import sentry  # noqa: PLC0415
+        except ImportError as e:
+            raise StructlogLoggingConfigExceptionError(
+                "sentry_config was provided, but mh_structlog.sentry could not be imported. "
+                "Make sure this package is installed with its 'sentry' extra."
+            ) from e
         # By default, ignore our own request access logger (which is only used when you use the Django access logger from this package in your project).
         # When a request errors, there are normally other exceptions that show up in Sentry for it; adding the
         # access log at the end only results in a duplicate event.
         #
         # When you specify ignore_loggers manually, it is not ignored anymore, so you should add it yourself (when wanted).
         sentry_config.setdefault('ignore_loggers', ['mh_structlog.django.access'])
-        shared_processors.append(processors.SentryProcessor(**sentry_config))
+        shared_processors.append(sentry.SentryProcessor(**sentry_config))
     else:
         # In case logging statements add sentry_skip, but Sentry isn't configured at all, we do not want to output that key.
         shared_processors.append(processors.FieldDropper(['sentry_skip']))

{mh_structlog-0.0.41 → mh_structlog-0.0.44}/src/mh_structlog/processors.py

@@ -4,7 +4,6 @@ import orjson
 import structlog
 from structlog.processors import CallsiteParameter
 from structlog.typing import EventDict
-from structlog_sentry import SentryProcessor as _SentryProcessor
 
 
 # Inspect a default logging library record so we can find out which keys on a LogRecord are 'extra' and not default ones.
@@ -40,6 +39,21 @@ def render_orjson(logger: structlog.BoundLogger, name: str, event_dict: dict) ->
     return orjson.dumps(event_dict, default=repr).decode()
 
 
+class FieldsAdder:
+    """Add static fields to each event dict.
+
+    E.g. you can configure it to add {"service": "my-service", "env": "production"} to each log at program startup,
+    instead of having to configure them on every logger.
+    """
+
+    def __init__(self, data: dict):  # noqa: D107
+        self.data = data
+
+    def __call__(self, logger: logging.Logger, name: str, event_dict: EventDict) -> EventDict:  # noqa: D102,ARG001,ARG002
+        event_dict.update(self.data)
+        return event_dict
+
+
 class FieldDropper:
     """Drop fields from the event dict if present."""
 
@@ -81,26 +95,3 @@ class CapExceptionFrames:
         if self.max_frames is not None and 'exception' in event_dict and 'frames' in event_dict["exception"]:
             event_dict['exception']['frames'] = event_dict['exception']['frames'][-self.max_frames :]
         return event_dict
-
-
-class SentryProcessor(_SentryProcessor):
-    """The SentryProcessor but with some of our own defaults and slight customization applied."""
-
-    def __init__(self, **kwargs):  # noqa: D107
-        # Unless otherwise specified, add all extra attributes from the log to Sentry as tags.
-        # Explicitly pass tag_keys=None to avoid this behaviour.
-        if 'tag_keys' not in kwargs:
-            kwargs['tag_keys'] = '__all__'
-        super().__init__(**kwargs)
-
-    def _get_event_and_hint(self, event_dict: EventDict) -> tuple[dict, dict]:
-        """Filter out tag_keys which are not primitive types, because Sentry gives an error otherwise."""
-
-        event, hint = super()._get_event_and_hint(event_dict)
-
-        if 'tags' in event:
-            for k in list(event['tags'].keys()):
-                if not isinstance(event['tags'][k], (bool, str, int, float, type(None))):  # noqa: UP038
-                    del event['tags'][k]
-
-        return event, hint

mh_structlog-0.0.44/src/mh_structlog/sentry.py

@@ -0,0 +1,25 @@
+from structlog.typing import EventDict
+from structlog_sentry import SentryProcessor as _SentryProcessor
+
+
+class SentryProcessor(_SentryProcessor):
+    """The SentryProcessor but with some of our own defaults and slight customization applied."""
+
+    def __init__(self, **kwargs):  # noqa: D107
+        # Unless otherwise specified, add all extra attributes from the log to Sentry as tags.
+        # Explicitly pass tag_keys=None to avoid this behaviour.
+        if 'tag_keys' not in kwargs:
+            kwargs['tag_keys'] = '__all__'
+        super().__init__(**kwargs)
+
+    def _get_event_and_hint(self, event_dict: EventDict) -> tuple[dict, dict]:
+        """Filter out tag_keys which are not primitive types, because Sentry gives an error otherwise."""
+
+        event, hint = super()._get_event_and_hint(event_dict)
+
+        if 'tags' in event:
+            for k in list(event['tags'].keys()):
+                if not isinstance(event['tags'][k], (bool, str, int, float, type(None))):  # noqa: UP038
+                    del event['tags'][k]
+
+        return event, hint

{mh_structlog-0.0.41 → mh_structlog-0.0.44}/src/mh_structlog/utils.py

@@ -1,4 +1,5 @@
 import inspect
+from pathlib import Path
 
 
 def determine_name_for_logger():
@@ -10,13 +11,12 @@ def determine_name_for_logger():
         if 'mh_structlog' not in f[1]:
             break
 
-    # Make a name ourselves
+    # Make a name ourselves based on the path in the stackframe
     name: str = frame[1].lstrip('/').rstrip('.py').replace('/', '.')
 
     # Strip away some common 'prefixes' paths
-    for location in ['var.task', 'src', 'code', 'app']:
-        if f'{location}.' in name:
-            _, _, name = name.partition(f'{location}.')
-            break
+    cwd = str(Path.cwd()).lstrip('/').rstrip('.py').replace('/', '.')
+    for location in [cwd, 'var.task', 'src', 'code', 'app']:
+        name = name.removeprefix(f'{location}.')
 
     return name