django-structlog 6.1.0.dev1__tar.gz → 7.0.0.dev1__tar.gz

{django-structlog-6.1.0.dev1/django_structlog.egg-info → django-structlog-7.0.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-structlog
-Version: 6.1.0.dev1
+Version: 7.0.0.dev1
 Summary: Structured Logging for Django
 Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
 License: MIT
@@ -29,7 +29,7 @@ License-File: LICENSE.rst
 Requires-Dist: django>=3.2
 Requires-Dist: structlog>=21.4.0
 Requires-Dist: asgiref>=3.6.0
-Requires-Dist: django-ipware
+Requires-Dist: django-ipware>=6.0.2
 Provides-Extra: celery
 Requires-Dist: celery>=5.1; extra == "celery"
 Provides-Extra: commands
@@ -399,6 +399,17 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_7.0:
+
+Upgrading to 7.0+
+^^^^^^^^^^^^^^^^^
+
+The dependency `django-ipware <https://github.com/un33k/django-ipware>`_ was upgraded to version 6. This library is used to retrieve the request's ip address.
+
+Version 6 may have some `breaking changes <https://github.com/un33k/django-ipware/compare/v5.0.2...v6.0.2#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R97>`_ if you did customizations.
+
+It should not affect most of the users but if you did some customizations, you might need to update your configurations.
+
 .. _upgrade_6.0:
 
 Upgrading to 6.0+

{django-structlog-6.1.0.dev1 → django-structlog-7.0.0.dev1}/README.rst

@@ -362,6 +362,17 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_7.0:
+
+Upgrading to 7.0+
+^^^^^^^^^^^^^^^^^
+
+The dependency `django-ipware <https://github.com/un33k/django-ipware>`_ was upgraded to version 6. This library is used to retrieve the request's ip address.
+
+Version 6 may have some `breaking changes <https://github.com/un33k/django-ipware/compare/v5.0.2...v6.0.2#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R97>`_ if you did customizations.
+
+It should not affect most of the users but if you did some customizations, you might need to update your configurations.
+
 .. _upgrade_6.0:
 
 Upgrading to 6.0+

{django-structlog-6.1.0.dev1 → django-structlog-7.0.0.dev1}/django_structlog/__init__.py

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

{django-structlog-6.1.0.dev1 → django-structlog-7.0.0.dev1}/django_structlog/celery/receivers.py

@@ -1,4 +1,16 @@
 import structlog
+from celery import current_app
+from celery.signals import (
+    before_task_publish,
+    after_task_publish,
+    task_prerun,
+    task_retry,
+    task_success,
+    task_failure,
+    task_revoked,
+    task_unknown,
+    task_rejected,
+)
 
 from . import signals
 
@@ -19,9 +31,7 @@ class CeleryReceiver:
         routing_key=None,
         **kwargs,
     ):
-        import celery
-
-        if celery.current_app.conf.task_protocol < 2:
+        if current_app.conf.task_protocol < 2:
             return
 
         context = structlog.contextvars.get_merged_contextvars(logger)
@@ -128,27 +138,10 @@ class CeleryReceiver:
         )
 
     def connect_signals(self):
-        from celery.signals import (
-            before_task_publish,
-            after_task_publish,
-        )
-
         before_task_publish.connect(self.receiver_before_task_publish)
         after_task_publish.connect(self.receiver_after_task_publish)
 
     def connect_worker_signals(self):
-        from celery.signals import (
-            before_task_publish,
-            after_task_publish,
-            task_prerun,
-            task_retry,
-            task_success,
-            task_failure,
-            task_revoked,
-            task_unknown,
-            task_rejected,
-        )
-
         before_task_publish.connect(self.receiver_before_task_publish)
         after_task_publish.connect(self.receiver_after_task_publish)
         task_prerun.connect(self.receiver_task_prerun)

{django-structlog-6.1.0.dev1 → django-structlog-7.0.0.dev1}/django_structlog/commands.py

@@ -1,6 +1,8 @@
 import structlog
 import uuid
 
+from django_extensions.management.signals import pre_command, post_command
+
 logger = structlog.getLogger(__name__)
 
 
@@ -32,10 +34,5 @@ class DjangoCommandReceiver:
             structlog.contextvars.reset_contextvars(**tokens)
 
     def connect_signals(self):
-        try:
-            from django_extensions.management.signals import pre_command, post_command
-        except ModuleNotFoundError:  # pragma: no cover
-            return
-
         pre_command.connect(self.pre_receiver)
         post_command.connect(self.post_receiver)

{django-structlog-6.1.0.dev1 → django-structlog-7.0.0.dev1}/django_structlog/middlewares/request.py

@@ -1,10 +1,11 @@
+import asyncio
 import logging
 import uuid
 
 import structlog
 from asgiref.sync import iscoroutinefunction, markcoroutinefunction
 from django.core.exceptions import PermissionDenied
-from django.http import Http404
+from django.http import Http404, StreamingHttpResponse
 from asgiref import sync
 
 from .. import signals
@@ -20,13 +21,69 @@ def get_request_header(request, header_key, meta_key):
     return request.META.get(meta_key)
 
 
-class BaseRequestMiddleWare:
+def sync_streaming_content_wrapper(streaming_content, context):
+    with structlog.contextvars.bound_contextvars(**context):
+        logger.info("streaming_started")
+        try:
+            for chunk in streaming_content:
+                yield chunk
+        except Exception:
+            logger.exception("streaming_failed")
+        else:
+            logger.info("streaming_finished")
+
+
+async def async_streaming_content_wrapper(streaming_content, context):
+    with structlog.contextvars.bound_contextvars(**context):
+        logger.info("streaming_started")
+        try:
+            async for chunk in streaming_content:
+                yield chunk
+        except asyncio.CancelledError:
+            logger.warning("streaming_cancelled")
+            raise
+        except Exception:
+            logger.exception("streaming_failed")
+        else:
+            logger.info("streaming_finished")
+
+
+class RequestMiddleware:
+    """``RequestMiddleware`` adds request metadata to ``structlog``'s logger context automatically.
+
+    >>> MIDDLEWARE = [
+    ...     # ...
+    ...     'django_structlog.middlewares.RequestMiddleware',
+    ... ]
+
+    """
+
+    sync_capable = True
+    async_capable = True
+
     def __init__(self, get_response):
         self.get_response = get_response
+        if iscoroutinefunction(self.get_response):
+            markcoroutinefunction(self)
+
+    def __call__(self, request):
+        if iscoroutinefunction(self):
+            return self.__acall__(request)
+        self.prepare(request)
+        response = self.get_response(request)
+        self.handle_response(request, response)
+        return response
+
+    async def __acall__(self, request):
+        await sync.sync_to_async(self.prepare)(request)
+        response = await self.get_response(request)
+        await sync.sync_to_async(self.handle_response)(request, response)
+        return response
 
     def handle_response(self, request, response):
         if not hasattr(request, "_raised_exception"):
             self.bind_user_id(request)
+            context = structlog.contextvars.get_merged_contextvars(logger)
             signals.bind_extra_request_finished_metadata.send(
                 sender=self.__class__,
                 request=request,
@@ -45,6 +102,19 @@ class BaseRequestMiddleWare:
                 code=response.status_code,
                 request=self.format_request(request),
             )
+            if isinstance(response, StreamingHttpResponse):
+                streaming_content = response.streaming_content
+                try:
+                    iter(streaming_content)
+                except TypeError:
+                    response.streaming_content = async_streaming_content_wrapper(
+                        streaming_content, context
+                    )
+                else:
+                    response.streaming_content = sync_streaming_content_wrapper(
+                        streaming_content, context
+                    )
+
         else:
             exception = getattr(request, "_raised_exception")
             delattr(request, "_raised_exception")
@@ -85,6 +155,16 @@ class BaseRequestMiddleWare:
     def format_request(request):
         return f"{request.method} {request.get_full_path()}"
 
+    @staticmethod
+    def bind_user_id(request):
+        if hasattr(request, "user") and request.user is not None:
+            user_id = None
+            if hasattr(request.user, "pk"):
+                user_id = request.user.pk
+                if isinstance(user_id, uuid.UUID):
+                    user_id = str(user_id)
+            structlog.contextvars.bind_contextvars(user_id=user_id)
+
     def process_exception(self, request, exception):
         if isinstance(exception, (Http404, PermissionDenied)):
             # We don't log an exception here, and we don't set that we handled
@@ -105,46 +185,3 @@ class BaseRequestMiddleWare:
             code=500,
             request=self.format_request(request),
         )
-
-    @staticmethod
-    def bind_user_id(request):
-        if hasattr(request, "user") and request.user is not None:
-            user_id = None
-            if hasattr(request.user, "pk"):
-                user_id = request.user.pk
-                if isinstance(user_id, uuid.UUID):
-                    user_id = str(user_id)
-            structlog.contextvars.bind_contextvars(user_id=user_id)
-
-
-class RequestMiddleware(BaseRequestMiddleWare):
-    """``RequestMiddleware`` adds request metadata to ``structlog``'s logger context automatically.
-
-    >>> MIDDLEWARE = [
-    ...     # ...
-    ...     'django_structlog.middlewares.RequestMiddleware',
-    ... ]
-
-    """
-
-    sync_capable = True
-    async_capable = True
-
-    def __init__(self, get_response):
-        super().__init__(get_response)
-        if iscoroutinefunction(self.get_response):
-            markcoroutinefunction(self)
-
-    def __call__(self, request):
-        if iscoroutinefunction(self):
-            return self.__acall__(request)
-        self.prepare(request)
-        response = self.get_response(request)
-        self.handle_response(request, response)
-        return response
-
-    async def __acall__(self, request):
-        await sync.sync_to_async(self.prepare)(request)
-        response = await self.get_response(request)
-        await sync.sync_to_async(self.handle_response)(request, response)
-        return response

{django-structlog-6.1.0.dev1 → django-structlog-7.0.0.dev1/django_structlog.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-structlog
-Version: 6.1.0.dev1
+Version: 7.0.0.dev1
 Summary: Structured Logging for Django
 Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
 License: MIT
@@ -29,7 +29,7 @@ License-File: LICENSE.rst
 Requires-Dist: django>=3.2
 Requires-Dist: structlog>=21.4.0
 Requires-Dist: asgiref>=3.6.0
-Requires-Dist: django-ipware
+Requires-Dist: django-ipware>=6.0.2
 Provides-Extra: celery
 Requires-Dist: celery>=5.1; extra == "celery"
 Provides-Extra: commands
@@ -399,6 +399,17 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_7.0:
+
+Upgrading to 7.0+
+^^^^^^^^^^^^^^^^^
+
+The dependency `django-ipware <https://github.com/un33k/django-ipware>`_ was upgraded to version 6. This library is used to retrieve the request's ip address.
+
+Version 6 may have some `breaking changes <https://github.com/un33k/django-ipware/compare/v5.0.2...v6.0.2#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R97>`_ if you did customizations.
+
+It should not affect most of the users but if you did some customizations, you might need to update your configurations.
+
 .. _upgrade_6.0:
 
 Upgrading to 6.0+

{django-structlog-6.1.0.dev1 → django-structlog-7.0.0.dev1}/django_structlog.egg-info/requires.txt

@@ -1,7 +1,7 @@
 django>=3.2
 structlog>=21.4.0
 asgiref>=3.6.0
-django-ipware
+django-ipware>=6.0.2
 
 [celery]
 celery>=5.1

{django-structlog-6.1.0.dev1 → django-structlog-7.0.0.dev1}/pyproject.toml

@@ -16,7 +16,7 @@ build-backend = "setuptools.build_meta"
     "django>=3.2",
     "structlog>=21.4.0",
     "asgiref>=3.6.0",
-    "django-ipware",
+    "django-ipware>=6.0.2",
   ]
   classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -129,7 +129,7 @@ build-backend = "setuptools.build_meta"
         django32: Django >=3.2, <4.0
         django41: Django >=4.1, <4.2
         django42: Django >=4.2, <5.0
-        django50: Django ==5.0a1
+        django50: Django >=5.0, <5.1
         -r{toxinidir}/requirements/ci.txt
 
     commands = pytest --cov=./test_app --cov=./django_structlog --cov-append test_app