django-debug-toolbar 4.4.4__tar.gz → 4.4.6__tar.gz

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/.pre-commit-config.yaml

@@ -44,13 +44,13 @@ repos:
         args:
         - --fix
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.5.0'
+    rev: 'v0.5.1'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
 -   repo: https://github.com/tox-dev/pyproject-fmt
-    rev: 2.1.3
+    rev: 2.1.4
     hooks:
       - id: pyproject-fmt
 -   repo: https://github.com/abravalheri/validate-pyproject

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-debug-toolbar
-Version: 4.4.4
+Version: 4.4.6
 Summary: A configurable set of panels that display various debug information about the current request/response.
 Project-URL: Download, https://pypi.org/project/django-debug-toolbar/
 Project-URL: Homepage, https://github.com/jazzband/django-debug-toolbar
@@ -74,7 +74,7 @@ Here's a screenshot of the toolbar in action:
 In addition to the built-in panels, a number of third-party panels are
 contributed by the community.
 
-The current stable version of the Debug Toolbar is 4.4.4. It works on
+The current stable version of the Debug Toolbar is 4.4.6. It works on
 Django ≥ 4.2.0.
 
 The Debug Toolbar does not currently support `Django's asynchronous views

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/README.rst

@@ -44,7 +44,7 @@ Here's a screenshot of the toolbar in action:
 In addition to the built-in panels, a number of third-party panels are
 contributed by the community.
 
-The current stable version of the Debug Toolbar is 4.4.4. It works on
+The current stable version of the Debug Toolbar is 4.4.6. It works on
 Django ≥ 4.2.0.
 
 The Debug Toolbar does not currently support `Django's asynchronous views

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/debug_toolbar/__init__.py

@@ -4,7 +4,7 @@ APP_NAME = "djdt"
 
 # Do not use pkg_resources to find the version but set it here directly!
 # see issue #1446
-VERSION = "4.4.4"
+VERSION = "4.4.6"
 
 # Code that discovers files or modules in INSTALLED_APPS imports this module.
 urls = "debug_toolbar.urls", APP_NAME

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/debug_toolbar/middleware.py

@@ -11,9 +11,7 @@ from django.utils.module_loading import import_string
 
 from debug_toolbar import settings as dt_settings
 from debug_toolbar.toolbar import DebugToolbar
-from debug_toolbar.utils import clear_stack_trace_caches
-
-_HTML_TYPES = ("text/html", "application/xhtml+xml")
+from debug_toolbar.utils import clear_stack_trace_caches, is_processable_html_response
 
 
 def show_toolbar(request):
@@ -102,13 +100,7 @@ class DebugToolbarMiddleware:
             response.headers[header] = value
 
         # Check for responses where the toolbar can't be inserted.
-        content_encoding = response.get("Content-Encoding", "")
-        content_type = response.get("Content-Type", "").split(";")[0]
-        if (
-            getattr(response, "streaming", False)
-            or content_encoding != ""
-            or content_type not in _HTML_TYPES
-        ):
+        if not is_processable_html_response(response):
             return response
 
         # Insert the toolbar in the response.

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/debug_toolbar/panels/alerts.py

@@ -3,6 +3,7 @@ from html.parser import HTMLParser
 from django.utils.translation import gettext_lazy as _
 
 from debug_toolbar.panels import Panel
+from debug_toolbar.utils import is_processable_html_response
 
 
 class FormParser(HTMLParser):
@@ -83,8 +84,7 @@ class AlertsPanel(Panel):
 
     @property
     def nav_subtitle(self):
-        alerts = self.get_stats()["alerts"]
-        if alerts:
+        if alerts := self.get_stats().get("alerts"):
             alert_text = "alert" if len(alerts) == 1 else "alerts"
             return f"{len(alerts)} {alert_text}"
         else:
@@ -139,8 +139,7 @@ class AlertsPanel(Panel):
         return self.alerts
 
     def generate_stats(self, request, response):
-        # check if streaming response
-        if getattr(response, "streaming", True):
+        if not is_processable_html_response(response):
             return
 
         html_content = response.content.decode(response.charset)

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/debug_toolbar/panels/templates/panel.py

@@ -1,4 +1,5 @@
 from contextlib import contextmanager
+from importlib.util import find_spec
 from os.path import normpath
 from pprint import pformat, saferepr
 
@@ -14,7 +15,11 @@ from django.utils.translation import gettext_lazy as _
 from debug_toolbar.panels import Panel
 from debug_toolbar.panels.sql.tracking import SQLQueryTriggered, allow_sql
 from debug_toolbar.panels.templates import views
-from debug_toolbar.panels.templates.jinja2 import patch_jinja_render
+
+if find_spec("jinja2"):
+    from debug_toolbar.panels.templates.jinja2 import patch_jinja_render
+
+    patch_jinja_render()
 
 # Monkey-patch to enable the template_rendered signal. The receiver returns
 # immediately when the panel is disabled to keep the overhead small.
@@ -26,8 +31,6 @@ if Template._render != instrumented_test_render:
     Template.original_render = Template._render
     Template._render = instrumented_test_render
 
-patch_jinja_render()
-
 # Monkey-patch to store items added by template context processors. The
 # overhead is sufficiently small to justify enabling it unconditionally.
 

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/debug_toolbar/utils.py

@@ -353,3 +353,16 @@ def get_stack_trace(*, skip=0):
 def clear_stack_trace_caches():
     if hasattr(_local_data, "stack_trace_recorder"):
         del _local_data.stack_trace_recorder
+
+
+_HTML_TYPES = ("text/html", "application/xhtml+xml")
+
+
+def is_processable_html_response(response):
+    content_encoding = response.get("Content-Encoding", "")
+    content_type = response.get("Content-Type", "").split(";")[0]
+    return (
+        not getattr(response, "streaming", False)
+        and content_encoding == ""
+        and content_type in _HTML_TYPES
+    )

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/docs/changes.rst

@@ -4,6 +4,19 @@ Change log
 Pending
 -------
 
+4.4.6 (2024-07-10)
+------------------
+
+* Changed ordering (and grammatical number) of panels and their titles in
+  documentation to match actual panel ordering and titles.
+* Skipped processing the alerts panel when response isn't a HTML response.
+
+4.4.5 (2024-07-05)
+------------------
+
+* Avoided crashing when the alerts panel was skipped.
+* Removed the inadvertently added hard dependency on Jinja2.
+
 4.4.4 (2024-07-05)
 ------------------
 

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/docs/conf.py

@@ -25,7 +25,7 @@ copyright = "{}, Django Debug Toolbar developers and contributors"
 copyright = copyright.format(datetime.date.today().year)
 
 # The full version, including alpha/beta/rc tags
-release = "4.4.4"
+release = "4.4.6"
 
 
 # -- General configuration ---------------------------------------------------

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/docs/panels.rst

@@ -9,17 +9,6 @@ Default built-in panels
 
 The following panels are enabled by default.
 
-Alerts
-~~~~~~~
-
-.. class:: debug_toolbar.panels.alerts.AlertsPanel
-
-This panel shows alerts for a set of pre-defined cases:
-
-- Alerts when the response has a form without the
-  ``enctype="multipart/form-data"`` attribute and the form contains
-  a file input.
-
 History
 ~~~~~~~
 
@@ -33,8 +22,8 @@ snapshot of the toolbar to view that request's stats.
    ``True`` or if the server runs with multiple processes, the History Panel
    will be disabled.
 
-Version
-~~~~~~~
+Versions
+~~~~~~~~
 
 .. class:: debug_toolbar.panels.versions.VersionsPanel
 
@@ -80,19 +69,30 @@ SQL
 
 SQL queries including time to execute and links to EXPLAIN each query.
 
-Template
-~~~~~~~~
+Static files
+~~~~~~~~~~~~
+
+.. class:: debug_toolbar.panels.staticfiles.StaticFilesPanel
+
+Used static files and their locations (via the ``staticfiles`` finders).
+
+Templates
+~~~~~~~~~
 
 .. class:: debug_toolbar.panels.templates.TemplatesPanel
 
 Templates and context used, and their template paths.
 
-Static files
-~~~~~~~~~~~~
+Alerts
+~~~~~~~
 
-.. class:: debug_toolbar.panels.staticfiles.StaticFilesPanel
+.. class:: debug_toolbar.panels.alerts.AlertsPanel
 
-Used static files and their locations (via the ``staticfiles`` finders).
+This panel shows alerts for a set of pre-defined cases:
+
+- Alerts when the response has a form without the
+  ``enctype="multipart/form-data"`` attribute and the form contains
+  a file input.
 
 Cache
 ~~~~~
@@ -101,8 +101,8 @@ Cache
 
 Cache queries. Is incompatible with Django's per-site caching.
 
-Signal
-~~~~~~
+Signals
+~~~~~~~
 
 .. class:: debug_toolbar.panels.signals.SignalsPanel
 

{django_debug_toolbar-4.4.4 → django_debug_toolbar-4.4.6}/tests/forms.py

@@ -6,4 +6,4 @@ class TemplateReprForm(forms.Form):
     user = forms.ModelChoiceField(queryset=User.objects.all())
 
     def __repr__(self):
-        return repr(self)
+        return str(self)