django-structlog 9.0.0.dev1__tar.gz → 9.0.1__tar.gz

{django_structlog-9.0.0.dev1/django_structlog.egg-info → django_structlog-9.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: django-structlog
-Version: 9.0.0.dev1
+Version: 9.0.1
 Summary: Structured Logging for Django
 Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
 License: MIT
@@ -44,8 +44,14 @@ django-structlog
 
 | |pypi| |wheels| |build-status| |docs| |coverage| |open_issues| |pull_requests|
 | |django| |python| |license| |black| |ruff|
+| |django_packages|
 | |watchers| |stars| |forks|
 
+
+.. |django_packages| image:: https://img.shields.io/badge/Published%20on-Django%20Packages-0c3c26
+   :target: https://djangopackages.org/packages/p/django-structlog/
+   :alt: Published on Django Packages
+
 .. |build-status| image:: https://github.com/jrobichaud/django-structlog/actions/workflows/main.yml/badge.svg?branch=main
    :target: https://github.com/jrobichaud/django-structlog/actions
    :alt: Build Status
@@ -408,6 +414,44 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_9.0:
+
+Upgrading to 9.0+
+^^^^^^^^^^^^^^^^^
+
+Minimum requirements
+~~~~~~~~~~~~~~~~~~~~
+- requires python 3.9+
+- django 4.2 and 5.0+ are supported
+
+
+Type hints
+~~~~~~~~~~
+
+``django-structlog`` now uses `python type hints <https://docs.python.org/3/library/typing.html>`_ and is being validated with `mypy <https://mypy.readthedocs.io/en/stable/>`_ ``--strict``.
+
+
+For ``drf-standardized-errors`` users
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Now unhandled exceptions when using `drf-standardized-errors <https://github.com/ghazi-git/drf-standardized-errors>`_ will be intercepted and the exception logged properly.
+
+If you also use `structlog-sentry <https://github.com/kiwicom/structlog-sentry>`_, the exception will now be propagated as expected.
+
+Other libraries alike may be affected by this change.
+
+Internal changes in how ``RequestMiddleware`` handles exceptions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrided the ``process_exception`` method.
+
+Did you?
+
+If so:
+
+   - ``RequestMiddleware.process_exception`` was renamed to ``RequestMiddleware._process_exception``, you should to the same in the middleware.
+
+
 .. _upgrade_8.0:
 
 Upgrading to 8.0+

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/README.rst

@@ -5,8 +5,14 @@ django-structlog
 
 | |pypi| |wheels| |build-status| |docs| |coverage| |open_issues| |pull_requests|
 | |django| |python| |license| |black| |ruff|
+| |django_packages|
 | |watchers| |stars| |forks|
 
+
+.. |django_packages| image:: https://img.shields.io/badge/Published%20on-Django%20Packages-0c3c26
+   :target: https://djangopackages.org/packages/p/django-structlog/
+   :alt: Published on Django Packages
+
 .. |build-status| image:: https://github.com/jrobichaud/django-structlog/actions/workflows/main.yml/badge.svg?branch=main
    :target: https://github.com/jrobichaud/django-structlog/actions
    :alt: Build Status
@@ -369,6 +375,44 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_9.0:
+
+Upgrading to 9.0+
+^^^^^^^^^^^^^^^^^
+
+Minimum requirements
+~~~~~~~~~~~~~~~~~~~~
+- requires python 3.9+
+- django 4.2 and 5.0+ are supported
+
+
+Type hints
+~~~~~~~~~~
+
+``django-structlog`` now uses `python type hints <https://docs.python.org/3/library/typing.html>`_ and is being validated with `mypy <https://mypy.readthedocs.io/en/stable/>`_ ``--strict``.
+
+
+For ``drf-standardized-errors`` users
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Now unhandled exceptions when using `drf-standardized-errors <https://github.com/ghazi-git/drf-standardized-errors>`_ will be intercepted and the exception logged properly.
+
+If you also use `structlog-sentry <https://github.com/kiwicom/structlog-sentry>`_, the exception will now be propagated as expected.
+
+Other libraries alike may be affected by this change.
+
+Internal changes in how ``RequestMiddleware`` handles exceptions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrided the ``process_exception`` method.
+
+Did you?
+
+If so:
+
+   - ``RequestMiddleware.process_exception`` was renamed to ``RequestMiddleware._process_exception``, you should to the same in the middleware.
+
+
 .. _upgrade_8.0:
 
 Upgrading to 8.0+

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/django_structlog/__init__.py

@@ -3,6 +3,6 @@
 
 name = "django_structlog"
 
-VERSION = (9, 0, 0, "dev1")
+VERSION = (9, 0, 1)
 
 __version__ = ".".join(str(v) for v in VERSION)

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/django_structlog/celery/receivers.py

@@ -1,24 +1,22 @@
-from __future__ import annotations
-
-from typing import Type, Any, Optional, cast, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Optional, Type, cast
 
 import structlog
 from celery import current_app
 from celery.signals import (
-    before_task_publish,
     after_task_publish,
+    before_task_publish,
+    task_failure,
     task_prerun,
+    task_rejected,
     task_retry,
-    task_success,
-    task_failure,
     task_revoked,
+    task_success,
     task_unknown,
-    task_rejected,
 )
 
 from . import signals
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from types import TracebackType
 
 logger = structlog.getLogger(__name__)
@@ -35,7 +33,7 @@ class CeleryReceiver:
         sender: Optional[Type[Any]] = None,
         headers: Optional[dict[str, Any]] = None,
         body: Optional[dict[str, str]] = None,
-        properties: Optional[dict[str, Optional[str]]] = None,
+        properties: Optional[dict[str, Any]] = None,
         routing_key: Optional[str] = None,
         **kwargs: dict[str, str],
     ) -> None:
@@ -54,8 +52,7 @@ class CeleryReceiver:
         )
         if properties:
             self._priority = properties.get("priority", None)
-        if headers is not None:
-            headers["__django_structlog__"] = context
+        cast(dict[str, Any], headers)["__django_structlog__"] = context
 
     def receiver_after_task_publish(
         self,
@@ -119,7 +116,7 @@ class CeleryReceiver:
         self,
         task_id: Optional[str] = None,
         exception: Optional[Exception] = None,
-        traceback: Optional[TracebackType] = None,
+        traceback: Optional["TracebackType"] = None,
         einfo: Optional[Any] = None,
         sender: Optional[Type[Any]] = None,
         *args: Any,

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/django_structlog/celery/signals.py

@@ -1,6 +1,5 @@
 import django.dispatch
 
-
 bind_extra_task_metadata = django.dispatch.Signal()
 """ Signal to add extra ``structlog`` bindings from ``celery``'s task.
 

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/django_structlog/commands.py

@@ -1,21 +1,23 @@
-from __future__ import annotations
-
-from typing import List, Tuple, Mapping, Any, Type, TYPE_CHECKING
-
-import structlog
 import uuid
+from typing import TYPE_CHECKING, Any, List, Mapping, Tuple, Type
 
-from django_extensions.management.signals import pre_command, post_command
+import structlog
+from django_extensions.management.signals import (  # type: ignore[import-untyped]
+    post_command,
+    pre_command,
+)
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     import contextvars
 
 logger = structlog.getLogger(__name__)
 
 
 class DjangoCommandReceiver:
+    stack: List[Tuple[str, Mapping[str, "contextvars.Token[Any]"]]]
+
     def __init__(self) -> None:
-        self.stack: List[Tuple[str, Mapping[str, contextvars.Token[Any]]]] = []
+        self.stack = []
 
     def pre_receiver(self, sender: Type[Any], *args: Any, **kwargs: Any) -> None:
         command_id = str(uuid.uuid4())

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/django_structlog/middlewares/__init__.py

@@ -1 +1,5 @@
 from .request import RequestMiddleware  # noqa F401
+
+__all__ = [
+    "RequestMiddleware",
+]

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/django_structlog/middlewares/request.py

@@ -1,36 +1,50 @@
-from __future__ import annotations
-
 import asyncio
 import logging
+import sys
 import uuid
 from typing import (
+    TYPE_CHECKING,
     Any,
-    Generator,
     AsyncGenerator,
+    AsyncIterator,
+    Awaitable,
     Callable,
+    Generator,
+    Iterator,
+    Type,
     Union,
-    Awaitable,
     cast,
-    Iterator,
-    TYPE_CHECKING,
 )
 
 import structlog
-from asgiref.sync import iscoroutinefunction, markcoroutinefunction
+from asgiref import sync
 from django.core.exceptions import PermissionDenied
+from django.core.signals import got_request_exception
 from django.http import Http404, StreamingHttpResponse
-from asgiref import sync
 
 from .. import signals
 from ..app_settings import app_settings
 
-if TYPE_CHECKING:
+if sys.version_info >= (3, 12, 0):
+    from inspect import (  # type: ignore[attr-defined]
+        iscoroutinefunction,
+        markcoroutinefunction,
+    )
+else:
+    from asgiref.sync import (  # type: ignore[no-redef]
+        iscoroutinefunction,
+        markcoroutinefunction,
+    )
+
+if TYPE_CHECKING:  # pragma: no cover
+    from types import TracebackType
+
     from django.http import HttpRequest, HttpResponse
 
 logger = structlog.getLogger(__name__)
 
 
-def get_request_header(request: HttpRequest, header_key: str, meta_key: str) -> Any:
+def get_request_header(request: "HttpRequest", header_key: str, meta_key: str) -> Any:
     if hasattr(request, "headers"):
         return request.headers.get(header_key)
 
@@ -38,8 +52,8 @@ def get_request_header(request: HttpRequest, header_key: str, meta_key: str) ->
 
 
 def sync_streaming_content_wrapper(
-    streaming_content: Any, context: Any
-) -> Generator[Any, None, None]:
+    streaming_content: Iterator[bytes], context: Any
+) -> Generator[bytes, None, None]:
     with structlog.contextvars.bound_contextvars(**context):
         logger.info("streaming_started")
         try:
@@ -47,13 +61,14 @@ def sync_streaming_content_wrapper(
                 yield chunk
         except Exception:
             logger.exception("streaming_failed")
+            raise
         else:
             logger.info("streaming_finished")
 
 
 async def async_streaming_content_wrapper(
-    streaming_content: Any, context: Any
-) -> AsyncGenerator[Any, None]:
+    streaming_content: AsyncIterator[bytes], context: Any
+) -> AsyncGenerator[bytes, Any]:
     with structlog.contextvars.bound_contextvars(**context):
         logger.info("streaming_started")
         try:
@@ -64,6 +79,7 @@ async def async_streaming_content_wrapper(
             raise
         except Exception:
             logger.exception("streaming_failed")
+            raise
         else:
             logger.info("streaming_finished")
 
@@ -84,24 +100,25 @@ class RequestMiddleware:
     def __init__(
         self,
         get_response: Callable[
-            [HttpRequest], Union[HttpResponse, Awaitable[HttpResponse]]
+            ["HttpRequest"], Union["HttpResponse", Awaitable["HttpResponse"]]
         ],
     ) -> None:
         self.get_response = get_response
         if iscoroutinefunction(self.get_response):
             markcoroutinefunction(self)
+        got_request_exception.connect(self.process_got_request_exception)
 
     def __call__(
-        self, request: HttpRequest
-    ) -> Union[HttpResponse, Awaitable[HttpResponse]]:
+        self, request: "HttpRequest"
+    ) -> Union["HttpResponse", Awaitable["HttpResponse"]]:
         if iscoroutinefunction(self):
-            return cast(RequestMiddleware, self).__acall__(request)  # type: ignore[redundant-cast,unused-ignore]
+            return cast(RequestMiddleware, self).__acall__(request)
         self.prepare(request)
         response = cast("HttpResponse", self.get_response(request))
         self.handle_response(request, response)
         return response
 
-    async def __acall__(self, request: HttpRequest) -> HttpResponse:
+    async def __acall__(self, request: "HttpRequest") -> "HttpResponse":
         await sync.sync_to_async(self.prepare)(request)
         try:
             response = await cast(Awaitable["HttpResponse"], self.get_response(request))
@@ -111,7 +128,7 @@ class RequestMiddleware:
         await sync.sync_to_async(self.handle_response)(request, response)
         return response
 
-    def handle_response(self, request: HttpRequest, response: HttpResponse) -> None:
+    def handle_response(self, request: "HttpRequest", response: "HttpResponse") -> None:
         if not hasattr(request, "_raised_exception"):
             self.bind_user_id(request)
             context = structlog.contextvars.get_merged_contextvars(logger)
@@ -140,15 +157,13 @@ class RequestMiddleware:
             )
             if isinstance(response, StreamingHttpResponse):
                 streaming_content = response.streaming_content
-                try:
-                    iter(cast(Iterator[bytes], streaming_content))
-                except TypeError:
+                if response.is_async:
                     response.streaming_content = async_streaming_content_wrapper(
-                        streaming_content, context
+                        cast(AsyncIterator[bytes], streaming_content), context
                     )
                 else:
                     response.streaming_content = sync_streaming_content_wrapper(
-                        streaming_content, context
+                        cast(Iterator[bytes], streaming_content), context
                     )
 
         else:
@@ -163,8 +178,8 @@ class RequestMiddleware:
             )
         structlog.contextvars.clear_contextvars()
 
-    def prepare(self, request: HttpRequest) -> None:
-        from ipware import get_client_ip
+    def prepare(self, request: "HttpRequest") -> None:
+        from ipware import get_client_ip  # type: ignore[import-untyped]
 
         request_id = get_request_header(
             request, "x-request-id", "HTTP_X_REQUEST_ID"
@@ -188,11 +203,11 @@ class RequestMiddleware:
         logger.info("request_started", **log_kwargs)
 
     @staticmethod
-    def format_request(request: HttpRequest) -> str:
+    def format_request(request: "HttpRequest") -> str:
         return f"{request.method} {request.get_full_path()}"
 
     @staticmethod
-    def bind_user_id(request: HttpRequest) -> None:
+    def bind_user_id(request: "HttpRequest") -> None:
         user_id_field = app_settings.USER_ID_FIELD
         if hasattr(request, "user") and request.user is not None and user_id_field:
             user_id = None
@@ -202,7 +217,17 @@ class RequestMiddleware:
                     user_id = str(user_id)
             structlog.contextvars.bind_contextvars(user_id=user_id)
 
-    def process_exception(self, request: HttpRequest, exception: Exception) -> None:
+    def process_got_request_exception(
+        self, sender: Type[Any], request: "HttpRequest", **kwargs: Any
+    ) -> None:
+        if not hasattr(request, "_raised_exception"):
+            ex = cast(
+                tuple[Type[Exception], Exception, "TracebackType"],
+                sys.exc_info(),
+            )
+            self._process_exception(request, ex[1])
+
+    def _process_exception(self, request: "HttpRequest", exception: Exception) -> None:
         if isinstance(exception, (Http404, PermissionDenied)):
             # We don't log an exception here, and we don't set that we handled
             # an error as we want the standard `request_finished` log message

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/django_structlog/signals.py

@@ -1,6 +1,5 @@
 import django.dispatch
 
-
 bind_extra_request_metadata = django.dispatch.Signal()
 """ Signal to add extra ``structlog`` bindings from ``django``'s request.
 

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1/django_structlog.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: django-structlog
-Version: 9.0.0.dev1
+Version: 9.0.1
 Summary: Structured Logging for Django
 Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
 License: MIT
@@ -44,8 +44,14 @@ django-structlog
 
 | |pypi| |wheels| |build-status| |docs| |coverage| |open_issues| |pull_requests|
 | |django| |python| |license| |black| |ruff|
+| |django_packages|
 | |watchers| |stars| |forks|
 
+
+.. |django_packages| image:: https://img.shields.io/badge/Published%20on-Django%20Packages-0c3c26
+   :target: https://djangopackages.org/packages/p/django-structlog/
+   :alt: Published on Django Packages
+
 .. |build-status| image:: https://github.com/jrobichaud/django-structlog/actions/workflows/main.yml/badge.svg?branch=main
    :target: https://github.com/jrobichaud/django-structlog/actions
    :alt: Build Status
@@ -408,6 +414,44 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_9.0:
+
+Upgrading to 9.0+
+^^^^^^^^^^^^^^^^^
+
+Minimum requirements
+~~~~~~~~~~~~~~~~~~~~
+- requires python 3.9+
+- django 4.2 and 5.0+ are supported
+
+
+Type hints
+~~~~~~~~~~
+
+``django-structlog`` now uses `python type hints <https://docs.python.org/3/library/typing.html>`_ and is being validated with `mypy <https://mypy.readthedocs.io/en/stable/>`_ ``--strict``.
+
+
+For ``drf-standardized-errors`` users
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Now unhandled exceptions when using `drf-standardized-errors <https://github.com/ghazi-git/drf-standardized-errors>`_ will be intercepted and the exception logged properly.
+
+If you also use `structlog-sentry <https://github.com/kiwicom/structlog-sentry>`_, the exception will now be propagated as expected.
+
+Other libraries alike may be affected by this change.
+
+Internal changes in how ``RequestMiddleware`` handles exceptions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrided the ``process_exception`` method.
+
+Did you?
+
+If so:
+
+   - ``RequestMiddleware.process_exception`` was renamed to ``RequestMiddleware._process_exception``, you should to the same in the middleware.
+
+
 .. _upgrade_8.0:
 
 Upgrading to 8.0+

{django_structlog-9.0.0.dev1 → django_structlog-9.0.1}/pyproject.toml

@@ -158,17 +158,10 @@ include = [
 python_version=3.9
 strict=true
 packages=[
-  "django_structlog"
+  "django_structlog",
+  "test_app",
 ]
-disallow_subclassing_any=false
-
-[[tool.mypy.overrides]]
-module = [
-  "django_extensions.*",
-  "ipware",
-  "django.*",
-  "structlog.*",
-  "celery.*",
-  "asgiref.*",
-]
-ignore_missing_imports = true
+
+[tool.isort]
+profile = "black"
+filter_files = true