django-explain-errors 0.10.0__tar.gz → 0.10.1__tar.gz

{django_explain_errors-0.10.0/django_explain_errors.egg-info → django_explain_errors-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-explain-errors
-Version: 0.10.0
+Version: 0.10.1
 Summary: Django middleware that explains unhandled exceptions in DEBUG using an LLM, optionally grounded in your own project source via a local vector index. Works with OpenAI, Claude, or any OpenAI-compatible endpoint including local models.
 Home-page: https://github.com/topunix/django-explain-errors
 Author: topunix

{django_explain_errors-0.10.0 → django_explain_errors-0.10.1/django_explain_errors.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-explain-errors
-Version: 0.10.0
+Version: 0.10.1
 Summary: Django middleware that explains unhandled exceptions in DEBUG using an LLM, optionally grounded in your own project source via a local vector index. Works with OpenAI, Claude, or any OpenAI-compatible endpoint including local models.
 Home-page: https://github.com/topunix/django-explain-errors
 Author: topunix

{django_explain_errors-0.10.0 → django_explain_errors-0.10.1}/django_explain_errors.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ explain_errors/rag/__init__.py
 explain_errors/rag/indexer.py
 explain_errors/rag/retriever.py
 explain_errors/rag/store.py
+tests/test_async_marking.py
 tests/test_build_error_index.py
 tests/test_client.py
 tests/test_debug_page.py

{django_explain_errors-0.10.0 → django_explain_errors-0.10.1}/explain_errors/middleware.py

@@ -5,7 +5,7 @@ from collections import OrderedDict
 
 from django.conf import settings
 from django.http import JsonResponse
-from asgiref.sync import sync_to_async
+from asgiref.sync import markcoroutinefunction, sync_to_async
 
 from .client import get_openai_client
 from .debug_page import ExplainErrorsExceptionReporter
@@ -71,6 +71,10 @@ class ExplainErrorsMiddleware:
     def __init__(self, get_response):
         self.get_response = get_response
         self._is_async = asyncio.iscoroutinefunction(get_response)
+        if self._is_async:
+            # Without this, iscoroutinefunction(self) is False and middleware
+            # above this one runs in sync mode and receives a coroutine.
+            markcoroutinefunction(self)
         self.openai_client = None
         self.throttle = None
         self.dedup_enabled = False

{django_explain_errors-0.10.0 → django_explain_errors-0.10.1}/setup.py

@@ -10,7 +10,7 @@ with open('README.md', encoding='utf-8') as f:
 
 setup(
     name='django-explain-errors',
-    version='0.10.0',
+    version='0.10.1',
     packages=find_packages(exclude=['tests', 'tests.*', 'evals', 'evals.*']),
     description='Django middleware that explains unhandled exceptions in DEBUG using an LLM, optionally grounded in your own project source via a local vector index. Works with OpenAI, Claude, or any OpenAI-compatible endpoint including local models.',
     long_description_content_type='text/markdown',

django_explain_errors-0.10.1/tests/test_async_marking.py

@@ -0,0 +1,82 @@
+from unittest.mock import MagicMock, patch
+
+from asgiref.sync import iscoroutinefunction
+from django.http import HttpResponse
+from django.test import AsyncClient, Client, SimpleTestCase, override_settings
+
+from explain_errors.middleware import ExplainErrorsMiddleware
+
+
+def _mock_openai():
+    patcher = patch("openai.OpenAI")
+    mock_cls = patcher.start()
+    client = MagicMock()
+    client.chat.completions.create.return_value = MagicMock(
+        choices=[MagicMock(message=MagicMock(content="Mocked explanation."))]
+    )
+    mock_cls.return_value = client
+    return patcher
+
+
+@override_settings(
+    DEBUG=True,
+    OPENAI_API_KEY="test-key",
+    ROOT_URLCONF="tests.urls_debug_page",
+    MIDDLEWARE=[
+        "django.middleware.common.CommonMiddleware",
+        "explain_errors.middleware.ExplainErrorsMiddleware",
+    ],
+)
+class AsyncCoroutineMarkingRequestCycleTest(SimpleTestCase):
+    """Through the real handler chain, with an async-capable middleware
+    above ExplainErrorsMiddleware, as in a default project."""
+
+    def setUp(self):
+        patcher = _mock_openai()
+        self.addCleanup(patcher.stop)
+
+    def _assert_banner_500(self, response):
+        self.assertEqual(response.status_code, 500)
+        content = response.content.decode()
+        self.assertIn('id="explain-errors"', content)
+        self.assertIn("Mocked explanation.", content)
+
+    async def test_async_client_sync_view(self):
+        response = await AsyncClient(raise_request_exception=False).get("/boom/")
+        self._assert_banner_500(response)
+
+    async def test_async_client_async_view(self):
+        response = await AsyncClient(raise_request_exception=False).get("/boom-async/")
+        self._assert_banner_500(response)
+
+    async def test_async_client_async_view_no_exception(self):
+        response = await AsyncClient().get("/ok-async/")
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, b"ok")
+
+    def test_sync_client_sync_view(self):
+        response = Client(raise_request_exception=False).get("/boom/")
+        self._assert_banner_500(response)
+
+    def test_sync_client_async_view(self):
+        response = Client(raise_request_exception=False).get("/boom-async/")
+        self._assert_banner_500(response)
+
+
+@override_settings(DEBUG=True, OPENAI_API_KEY="test-key")
+class AsyncCoroutineMarkingInstanceTest(SimpleTestCase):
+    def setUp(self):
+        patcher = _mock_openai()
+        self.addCleanup(patcher.stop)
+
+    def test_marked_as_coroutine_function_when_get_response_is_async(self):
+        async def get_response(request):
+            return HttpResponse("ok")
+
+        self.assertTrue(iscoroutinefunction(ExplainErrorsMiddleware(get_response)))
+
+    def test_not_marked_when_get_response_is_sync(self):
+        def get_response(request):
+            return HttpResponse("ok")
+
+        self.assertFalse(iscoroutinefunction(ExplainErrorsMiddleware(get_response)))