django-explain-errors 0.8.0__tar.gz → 0.9.0__tar.gz

{django_explain_errors-0.8.0/django_explain_errors.egg-info → django_explain_errors-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-explain-errors
-Version: 0.8.0
+Version: 0.9.0
 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
@@ -44,14 +44,14 @@ Dynamic: summary
 
 # Django Explain Errors Middleware
 
-This Django middleware captures unhandled errors and exceptions, sends them
-to a language model for explanation, and, when debug mode is enabled, shows
-the explanation on Django's debug page directly under the exception
-headline, as well as printing it to stdout. It works with the OpenAI API
-out of the box, with Anthropic's Claude models through Anthropic's
+When debug mode is on, this Django middleware sends each unhandled exception
+to a language model and shows its explanation of what went wrong and how to
+fix it on Django's debug page, directly under the exception headline. The
+explanation is also printed to stdout. The middleware works with the OpenAI
+API out of the box, with Anthropic's Claude models through Anthropic's
 OpenAI-compatible endpoint, and with any other OpenAI-compatible endpoint
-(Ollama, LM Studio, Azure, or a corporate gateway) by setting a base URL,
-so explanations can run entirely on a local model if you prefer not to send
+(Ollama, LM Studio, Azure, or a corporate gateway) by setting a base URL, so
+explanations can run entirely on a local model if you prefer not to send
 code off your machine.
 
 Enabling RAG is strongly recommended. With it, the middleware retrieves the
@@ -92,6 +92,8 @@ Local development only. It requires `DEBUG = True` and is inert otherwise.
 - Captures Django errors and exceptions
 - Shows the explanation on Django's debug page, directly under the
   exception headline (`EXPLAIN_ERRORS_INJECT_DEBUG_PAGE`, on by default)
+- Copy button on each code block in the explanation, so a suggested fix
+  copies in one click
 - Prints the explanation to stdout, for terminal workflows and logs
   (`EXPLAIN_ERRORS_PRINT_STDOUT`, on by default)
 - Optional JSON 500 response instead of the debug page
@@ -223,6 +225,10 @@ background) so it reads on Django's page. The explanation is HTML-escaped first,
 Markdown subset (inline code, code blocks, bold, lists) is rendered as HTML. Nothing from the
 model is ever marked safe.
 
+Each fenced code block gets a "Copy" button that copies the exact code (via
+`navigator.clipboard` on secure contexts such as `localhost`, or a text-selection fallback
+otherwise, for example when `runserver` is reached by IP over plain HTTP).
+
 **Fails open.** Any problem building or inserting the banner (a missing request, an
 unexpected debug page layout, anything else) logs one warning and leaves Django's normal
 debug page untouched. This code can never turn a working debug page into a broken one.

{django_explain_errors-0.8.0 → django_explain_errors-0.9.0}/README.md

@@ -1,13 +1,13 @@
 # Django Explain Errors Middleware
 
-This Django middleware captures unhandled errors and exceptions, sends them
-to a language model for explanation, and, when debug mode is enabled, shows
-the explanation on Django's debug page directly under the exception
-headline, as well as printing it to stdout. It works with the OpenAI API
-out of the box, with Anthropic's Claude models through Anthropic's
+When debug mode is on, this Django middleware sends each unhandled exception
+to a language model and shows its explanation of what went wrong and how to
+fix it on Django's debug page, directly under the exception headline. The
+explanation is also printed to stdout. The middleware works with the OpenAI
+API out of the box, with Anthropic's Claude models through Anthropic's
 OpenAI-compatible endpoint, and with any other OpenAI-compatible endpoint
-(Ollama, LM Studio, Azure, or a corporate gateway) by setting a base URL,
-so explanations can run entirely on a local model if you prefer not to send
+(Ollama, LM Studio, Azure, or a corporate gateway) by setting a base URL, so
+explanations can run entirely on a local model if you prefer not to send
 code off your machine.
 
 Enabling RAG is strongly recommended. With it, the middleware retrieves the
@@ -48,6 +48,8 @@ Local development only. It requires `DEBUG = True` and is inert otherwise.
 - Captures Django errors and exceptions
 - Shows the explanation on Django's debug page, directly under the
   exception headline (`EXPLAIN_ERRORS_INJECT_DEBUG_PAGE`, on by default)
+- Copy button on each code block in the explanation, so a suggested fix
+  copies in one click
 - Prints the explanation to stdout, for terminal workflows and logs
   (`EXPLAIN_ERRORS_PRINT_STDOUT`, on by default)
 - Optional JSON 500 response instead of the debug page
@@ -179,6 +181,10 @@ background) so it reads on Django's page. The explanation is HTML-escaped first,
 Markdown subset (inline code, code blocks, bold, lists) is rendered as HTML. Nothing from the
 model is ever marked safe.
 
+Each fenced code block gets a "Copy" button that copies the exact code (via
+`navigator.clipboard` on secure contexts such as `localhost`, or a text-selection fallback
+otherwise, for example when `runserver` is reached by IP over plain HTTP).
+
 **Fails open.** Any problem building or inserting the banner (a missing request, an
 unexpected debug page layout, anything else) logs one warning and leaves Django's normal
 debug page untouched. This code can never turn a working debug page into a broken one.

{django_explain_errors-0.8.0 → django_explain_errors-0.9.0/django_explain_errors.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-explain-errors
-Version: 0.8.0
+Version: 0.9.0
 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
@@ -44,14 +44,14 @@ Dynamic: summary
 
 # Django Explain Errors Middleware
 
-This Django middleware captures unhandled errors and exceptions, sends them
-to a language model for explanation, and, when debug mode is enabled, shows
-the explanation on Django's debug page directly under the exception
-headline, as well as printing it to stdout. It works with the OpenAI API
-out of the box, with Anthropic's Claude models through Anthropic's
+When debug mode is on, this Django middleware sends each unhandled exception
+to a language model and shows its explanation of what went wrong and how to
+fix it on Django's debug page, directly under the exception headline. The
+explanation is also printed to stdout. The middleware works with the OpenAI
+API out of the box, with Anthropic's Claude models through Anthropic's
 OpenAI-compatible endpoint, and with any other OpenAI-compatible endpoint
-(Ollama, LM Studio, Azure, or a corporate gateway) by setting a base URL,
-so explanations can run entirely on a local model if you prefer not to send
+(Ollama, LM Studio, Azure, or a corporate gateway) by setting a base URL, so
+explanations can run entirely on a local model if you prefer not to send
 code off your machine.
 
 Enabling RAG is strongly recommended. With it, the middleware retrieves the
@@ -92,6 +92,8 @@ Local development only. It requires `DEBUG = True` and is inert otherwise.
 - Captures Django errors and exceptions
 - Shows the explanation on Django's debug page, directly under the
   exception headline (`EXPLAIN_ERRORS_INJECT_DEBUG_PAGE`, on by default)
+- Copy button on each code block in the explanation, so a suggested fix
+  copies in one click
 - Prints the explanation to stdout, for terminal workflows and logs
   (`EXPLAIN_ERRORS_PRINT_STDOUT`, on by default)
 - Optional JSON 500 response instead of the debug page
@@ -223,6 +225,10 @@ background) so it reads on Django's page. The explanation is HTML-escaped first,
 Markdown subset (inline code, code blocks, bold, lists) is rendered as HTML. Nothing from the
 model is ever marked safe.
 
+Each fenced code block gets a "Copy" button that copies the exact code (via
+`navigator.clipboard` on secure contexts such as `localhost`, or a text-selection fallback
+otherwise, for example when `runserver` is reached by IP over plain HTTP).
+
 **Fails open.** Any problem building or inserting the banner (a missing request, an
 unexpected debug page layout, anything else) logs one warning and leaves Django's normal
 debug page untouched. This code can never turn a working debug page into a broken one.

{django_explain_errors-0.8.0 → django_explain_errors-0.9.0}/explain_errors/debug_page.py

@@ -21,10 +21,78 @@ _PRE_STYLE = (
     "font-family: monospace; background: #eee; padding: 8px; "
     "overflow-x: auto; white-space: pre-wrap; margin: 4px 0;"
 )
+_PRE_WITH_BUTTON_STYLE = (
+    "font-family: monospace; background: #eee; padding: 8px 60px 8px 8px; "
+    "overflow-x: auto; white-space: pre-wrap; margin: 0;"
+)
 _P_STYLE = "margin: 6px 0;"
 _UL_STYLE = "margin: 6px 0; padding-inline-start: 1.5em; list-style: disc;"
 _OL_STYLE = "margin: 6px 0; padding-inline-start: 1.5em; list-style: decimal;"
 _LI_STYLE = "margin: 2px 0;"
+_CODE_WRAPPER_STYLE = "position: relative; margin: 4px 0;"
+_COPY_BUTTON_STYLE = (
+    "position: absolute; top: 4px; right: 4px; font-family: sans-serif; "
+    "font-size: 11px; line-height: 1; padding: 3px 7px; cursor: pointer; "
+    "background: #fff; border: 1px solid #999; border-radius: 3px; color: #333;"
+)
+_COPY_BUTTON_CLASS = "explain-errors-copy-btn"
+_CODE_WRAPPER_CLASS = "explain-errors-code-wrapper"
+
+_COPY_SCRIPT = """
+<script>
+(function () {{
+  var container = document.currentScript && document.currentScript.closest("#explain-errors");
+  if (!container) {{
+    return;
+  }}
+  container.addEventListener("click", function (event) {{
+    var btn = event.target.closest("button[data-copy]");
+    if (!btn) {{
+      return;
+    }}
+    var wrapper = btn.closest(".{wrapper_class}");
+    var code = wrapper && wrapper.querySelector("code");
+    if (!code) {{
+      return;
+    }}
+    var text = code.textContent;
+    var showCopied = function () {{
+      if (btn._explainErrorsTimer) {{
+        clearTimeout(btn._explainErrorsTimer);
+      }}
+      btn.textContent = "Copied";
+      btn._explainErrorsTimer = setTimeout(function () {{
+        btn.textContent = "Copy";
+        btn._explainErrorsTimer = null;
+      }}, 1500);
+    }};
+    var fallbackCopy = function () {{
+      try {{
+        var range = document.createRange();
+        range.selectNodeContents(code);
+        var selection = window.getSelection();
+        selection.removeAllRanges();
+        selection.addRange(range);
+        var ok = document.execCommand("copy");
+        selection.removeAllRanges();
+        if (ok) {{
+          showCopied();
+        }}
+      }} catch (err) {{
+        /* both copy paths failed; do nothing */
+      }}
+    }};
+    if (navigator.clipboard && navigator.clipboard.writeText) {{
+      navigator.clipboard.writeText(text).then(showCopied, fallbackCopy);
+    }} else {{
+      fallbackCopy();
+    }}
+  }});
+}})();
+</script>
+""".format(
+    wrapper_class=_CODE_WRAPPER_CLASS
+)
 
 _LANG_TAG_RE = re.compile(r"^[A-Za-z0-9_+-]*$")
 _INLINE_CODE_RE = re.compile(r"(`[^`\n]*`)")
@@ -55,12 +123,18 @@ def render_explanation_html(text):
 def _render(text):
     parts = text.split("```")
     rendered = []
+    has_copy_button = False
     for index, part in enumerate(parts):
         if index % 2 == 1:
-            rendered.append(_render_code_block(part))
+            block_html, has_button = _render_code_block(part)
+            rendered.append(block_html)
+            has_copy_button = has_copy_button or has_button
         else:
             rendered.append(_render_prose(escape(part)))
-    return "".join(rendered)
+    html = "".join(rendered)
+    if has_copy_button:
+        html += _COPY_SCRIPT
+    return html
 
 
 def _render_code_block(segment):
@@ -71,9 +145,24 @@ def _render_code_block(segment):
             code = rest
     if code.endswith("\n"):
         code = code[:-1]
-    return '<pre dir="ltr" style="{style}"><code dir="ltr">{code}</code></pre>'.format(
-        style=_PRE_STYLE, code=escape(code)
-    )
+    if not code.strip():
+        return (
+            '<pre dir="ltr" style="{pre_style}"><code dir="ltr">{code}</code></pre>'
+        ).format(pre_style=_PRE_STYLE, code=escape(code)), False
+    return (
+        '<div class="{wrapper_class}" style="{wrapper_style}">'
+        '<button type="button" class="{btn_class}" data-copy '
+        'aria-label="Copy code" style="{btn_style}">Copy</button>'
+        '<pre dir="ltr" style="{pre_style}"><code dir="ltr">{code}</code></pre>'
+        "</div>"
+    ).format(
+        wrapper_class=_CODE_WRAPPER_CLASS,
+        wrapper_style=_CODE_WRAPPER_STYLE,
+        btn_class=_COPY_BUTTON_CLASS,
+        btn_style=_COPY_BUTTON_STYLE,
+        pre_style=_PRE_WITH_BUTTON_STYLE,
+        code=escape(code),
+    ), True
 
 
 def _render_prose(escaped_text):

{django_explain_errors-0.8.0 → django_explain_errors-0.9.0}/setup.py

@@ -10,7 +10,7 @@ with open('README.md', encoding='utf-8') as f:
 
 setup(
     name='django-explain-errors',
-    version='0.8.0',
+    version='0.9.0',
     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.8.0 → django_explain_errors-0.9.0}/tests/test_debug_page.py

@@ -1,4 +1,5 @@
 import datetime
+import html as html_module
 from unittest.mock import MagicMock, patch
 
 from django.test import (
@@ -357,6 +358,67 @@ class RenderExplanationHtmlTest(SimpleTestCase):
         self.assertNotIn("<a ", html)
         self.assertIn("[text](url)", html)
 
+    def test_single_code_block_emits_one_copy_button_and_script(self):
+        html = render_explanation_html("```\nx = 1\n```")
+
+        self.assertEqual(html.count("<button"), 1)
+        self.assertEqual(html.count("<script>"), 1)
+
+    def test_multiple_code_blocks_emit_one_button_each_and_exactly_one_script(self):
+        html = render_explanation_html("```\nx = 1\n```\ntext\n```\ny = 2\n```")
+
+        self.assertEqual(html.count("<button"), 2)
+        self.assertEqual(html.count("<script>"), 1)
+
+    def test_copy_button_has_type_button_and_aria_label(self):
+        html = render_explanation_html("```\nx = 1\n```")
+
+        self.assertIn('type="button"', html)
+        self.assertIn('aria-label="Copy code"', html)
+
+    def test_no_code_blocks_emit_no_button_and_no_script(self):
+        html = render_explanation_html("Just prose, no code here.")
+
+        self.assertNotIn("data-copy", html)
+        self.assertNotIn("explain-errors-copy-btn", html)
+        self.assertNotIn("<script>", html)
+
+    def test_copy_source_round_trips_html_special_characters(self):
+        raw_code = """<script>alert("x & 'y'")</script>"""
+        html = render_explanation_html("```\n{}\n```".format(raw_code))
+
+        start = html.index("<code dir=\"ltr\">") + len('<code dir="ltr">')
+        end = html.index("</code>", start)
+        escaped_code = html[start:end]
+
+        self.assertEqual(html_module.unescape(escaped_code), raw_code)
+
+    def test_empty_code_block_emits_pre_without_button(self):
+        html = render_explanation_html("```\n\n```")
+
+        self.assertIn("<pre", html)
+        self.assertNotIn("<button", html)
+        self.assertNotIn("explain-errors-code-wrapper", html)
+
+    def test_whitespace_only_code_block_emits_pre_without_button(self):
+        html = render_explanation_html("```\n   \n```")
+
+        self.assertIn("<pre", html)
+        self.assertNotIn("<button", html)
+        self.assertNotIn("explain-errors-code-wrapper", html)
+
+    def test_all_empty_code_blocks_emit_no_script(self):
+        html = render_explanation_html("```\n\n```\ntext\n```\n  \n```")
+
+        self.assertNotIn("<button", html)
+        self.assertNotIn("<script>", html)
+
+    def test_mix_of_empty_and_nonempty_blocks_emits_button_only_for_nonempty(self):
+        html = render_explanation_html("```\n\n```\ntext\n```\nx = 1\n```")
+
+        self.assertEqual(html.count("<button"), 1)
+        self.assertEqual(html.count("<script>"), 1)
+
     def test_raising_transform_falls_back_to_escaped_plain_text_and_logs(self):
         with patch(
             "explain_errors.debug_page._render", side_effect=RuntimeError("boom")