django-explain-errors 0.3.0__tar.gz → 0.3.1__tar.gz

{django_explain_errors-0.3.0/django_explain_errors.egg-info → django_explain_errors-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-explain-errors
-Version: 0.3.0
+Version: 0.3.1
 Summary: Django middleware that captures errors and exceptions, sends them to OpenAI for a detailed explanation, and prints the explanation to stdout when debug mode is enabled. Supports both sync and async views.
 Home-page: https://github.com/topunix/django-explain-errors
 Author: topunix

{django_explain_errors-0.3.0 → django_explain_errors-0.3.1/django_explain_errors.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-explain-errors
-Version: 0.3.0
+Version: 0.3.1
 Summary: Django middleware that captures errors and exceptions, sends them to OpenAI for a detailed explanation, and prints the explanation to stdout when debug mode is enabled. Supports both sync and async views.
 Home-page: https://github.com/topunix/django-explain-errors
 Author: topunix

{django_explain_errors-0.3.0 → django_explain_errors-0.3.1}/django_explain_errors.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ explain_errors/rag/__init__.py
 explain_errors/rag/indexer.py
 explain_errors/rag/retriever.py
 explain_errors/rag/store.py
+tests/test_build_error_index.py
 tests/test_middleware.py
 tests/test_rag.py
 tests/test_sanitize.py

django_explain_errors-0.3.1/explain_errors/management/commands/build_error_index.py

@@ -0,0 +1,28 @@
+from django.core.management.base import BaseCommand, CommandError
+
+from explain_errors.rag.indexer import build_index
+
+
+class Command(BaseCommand):
+    help = (
+        "Build (or rebuild) the local vector index used to ground "
+        "explain_errors explanations in project source code."
+    )
+
+    def handle(self, *args, **options):
+        # Imported lazily to mirror the indexer's optional-dependency pattern.
+        from openai import OpenAIError
+
+        try:
+            result = build_index()
+        except OpenAIError as exc:
+            code = getattr(exc, "code", None) or type(exc).__name__
+            raise CommandError(
+                f"OpenAI API request failed ({code}). Check your API key and "
+                "billing at platform.openai.com. Index not built."
+            ) from exc
+        self.stdout.write(
+            f"explain_errors: scanned {result['files_scanned']} files, "
+            f"embedded {result['chunks_embedded']} chunks.\n"
+            f"Index written to {result['index_path']}"
+        )

{django_explain_errors-0.3.0 → django_explain_errors-0.3.1}/setup.py

@@ -10,7 +10,7 @@ with open('README.md', encoding='utf-8') as f:
 
 setup(
     name='django-explain-errors',
-    version='0.3.0',
+    version='0.3.1',
     packages=find_packages(exclude=['tests', 'tests.*']),
     description='Django middleware that captures errors and exceptions, sends them to OpenAI for a detailed explanation, and prints the explanation to stdout when debug mode is enabled. Supports both sync and async views.',
     long_description_content_type='text/markdown',

django_explain_errors-0.3.1/tests/test_build_error_index.py

@@ -0,0 +1,74 @@
+from io import StringIO
+from unittest.mock import patch
+
+from django.core.management import call_command
+from django.core.management.base import CommandError
+from django.test import SimpleTestCase
+from openai import APIConnectionError, OpenAIError, RateLimitError
+
+COMMAND_BUILD_INDEX = "explain_errors.management.commands.build_error_index.build_index"
+
+
+class _FakeAPIError(OpenAIError):
+    """Stands in for a real SDK error. Constructed directly rather than via
+    RateLimitError/APIConnectionError, whose signatures require an HTTP client
+    Request/Response object that changed libraries in openai 3.0 (httpx ->
+    httpx2). The command only cares about the OpenAIError base class and .code,
+    so this keeps the suite green across openai majors."""
+
+    def __init__(self, message, code=None):
+        super().__init__(message)
+        self.code = code
+
+
+class _FakeConnectionError(OpenAIError):
+    """An OpenAIError with no .code, to exercise the class-name fallback."""
+
+
+class BuildErrorIndexCommandTest(SimpleTestCase):
+    """The command must fail with a one-line message and nonzero exit when the
+    OpenAI API errors, instead of dying with a raw traceback (issue #1)."""
+
+    def test_real_sdk_errors_are_caught_by_the_base_class(self):
+        """Guards the assumption the fakes rely on."""
+        self.assertTrue(issubclass(RateLimitError, OpenAIError))
+        self.assertTrue(issubclass(APIConnectionError, OpenAIError))
+
+    @patch(COMMAND_BUILD_INDEX)
+    def test_rate_limit_error_becomes_one_line_command_error(self, mock_build):
+        mock_build.side_effect = _FakeAPIError(
+            "You exceeded your current quota", code="insufficient_quota"
+        )
+        with self.assertRaises(CommandError) as ctx:
+            call_command("build_error_index")
+        msg = str(ctx.exception)
+        self.assertIn("OpenAI API request failed", msg)
+        self.assertIn("insufficient_quota", msg)
+        self.assertIn("Index not built", msg)
+        self.assertEqual(ctx.exception.returncode, 1)
+
+    @patch(COMMAND_BUILD_INDEX)
+    def test_error_without_code_falls_back_to_class_name(self, mock_build):
+        mock_build.side_effect = _FakeConnectionError("connection failed")
+        with self.assertRaises(CommandError) as ctx:
+            call_command("build_error_index")
+        self.assertIn("_FakeConnectionError", str(ctx.exception))
+
+    @patch(COMMAND_BUILD_INDEX)
+    def test_success_path_unchanged(self, mock_build):
+        mock_build.return_value = {
+            "files_scanned": 2,
+            "chunks_embedded": 5,
+            "index_path": "/tmp/index.db",
+        }
+        out = StringIO()
+        call_command("build_error_index", stdout=out)
+        self.assertIn("scanned 2 files", out.getvalue())
+        self.assertIn("embedded 5 chunks", out.getvalue())
+
+    @patch(COMMAND_BUILD_INDEX)
+    def test_non_openai_errors_still_raise(self, mock_build):
+        """Config errors (e.g. missing BASE_DIR) are not silently reworded."""
+        mock_build.side_effect = ValueError("EXPLAIN_ERRORS_RAG_INCLUDE is not set")
+        with self.assertRaises(ValueError):
+            call_command("build_error_index")

django_explain_errors-0.3.0/explain_errors/management/commands/build_error_index.py

@@ -1,18 +0,0 @@
-from django.core.management.base import BaseCommand
-
-from explain_errors.rag.indexer import build_index
-
-
-class Command(BaseCommand):
-    help = (
-        "Build (or rebuild) the local vector index used to ground "
-        "explain_errors explanations in project source code."
-    )
-
-    def handle(self, *args, **options):
-        result = build_index()
-        self.stdout.write(
-            f"explain_errors: scanned {result['files_scanned']} files, "
-            f"embedded {result['chunks_embedded']} chunks.\n"
-            f"Index written to {result['index_path']}"
-        )