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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-debug-toolbar
-Version: 4.4.3
+Version: 4.4.4
 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.3. It works on
+The current stable version of the Debug Toolbar is 4.4.4. It works on
 Django ≥ 4.2.0.
 
 The Debug Toolbar does not currently support `Django's asynchronous views

{django_debug_toolbar-4.4.3 → django_debug_toolbar-4.4.4}/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.3. It works on
+The current stable version of the Debug Toolbar is 4.4.4. It works on
 Django ≥ 4.2.0.
 
 The Debug Toolbar does not currently support `Django's asynchronous views

{django_debug_toolbar-4.4.3 → django_debug_toolbar-4.4.4}/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.3"
+VERSION = "4.4.4"
 
 # Code that discovers files or modules in INSTALLED_APPS imports this module.
 urls = "debug_toolbar.urls", APP_NAME

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

@@ -1,148 +1,152 @@
-from html.parser import HTMLParser
-
-from django.utils.translation import gettext_lazy as _
-
-from debug_toolbar.panels import Panel
-
-
-class FormParser(HTMLParser):
-    """
-    HTML form parser, used to check for invalid configurations of forms that
-    take file inputs.
-    """
-
-    def __init__(self):
-        super().__init__()
-        self.in_form = False
-        self.current_form = {}
-        self.forms = []
-        self.form_ids = []
-        self.referenced_file_inputs = []
-
-    def handle_starttag(self, tag, attrs):
-        attrs = dict(attrs)
-        if tag == "form":
-            self.in_form = True
-            form_id = attrs.get("id")
-            if form_id:
-                self.form_ids.append(form_id)
-            self.current_form = {
-                "file_form": False,
-                "form_attrs": attrs,
-                "submit_element_attrs": [],
-            }
-        elif (
-            self.in_form
-            and tag == "input"
-            and attrs.get("type") == "file"
-            and (not attrs.get("form") or attrs.get("form") == "")
-        ):
-            self.current_form["file_form"] = True
-        elif (
-            self.in_form
-            and (
-                (tag == "input" and attrs.get("type") in {"submit", "image"})
-                or tag == "button"
-            )
-            and (not attrs.get("form") or attrs.get("form") == "")
-        ):
-            self.current_form["submit_element_attrs"].append(attrs)
-        elif tag == "input" and attrs.get("form"):
-            self.referenced_file_inputs.append(attrs)
-
-    def handle_endtag(self, tag):
-        if tag == "form" and self.in_form:
-            self.forms.append(self.current_form)
-            self.in_form = False
-
-
-class AlertsPanel(Panel):
-    """
-    A panel to alert users to issues.
-    """
-
-    messages = {
-        "form_id_missing_enctype": _(
-            'Form with id "{form_id}" contains file input, but does not have the attribute enctype="multipart/form-data".'
-        ),
-        "form_missing_enctype": _(
-            'Form contains file input, but does not have the attribute enctype="multipart/form-data".'
-        ),
-        "input_refs_form_missing_enctype": _(
-            'Input element references form with id "{form_id}", but the form does not have the attribute enctype="multipart/form-data".'
-        ),
-    }
-
-    title = _("Alerts")
-
-    template = "debug_toolbar/panels/alerts.html"
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.alerts = []
-
-    @property
-    def nav_subtitle(self):
-        alerts = self.get_stats()["alerts"]
-        if alerts:
-            alert_text = "alert" if len(alerts) == 1 else "alerts"
-            return f"{len(alerts)} {alert_text}"
-        else:
-            return ""
-
-    def add_alert(self, alert):
-        self.alerts.append(alert)
-
-    def check_invalid_file_form_configuration(self, html_content):
-        """
-        Inspects HTML content for a form that includes a file input but does
-        not have the encoding type set to multipart/form-data, and warns the
-        user if so.
-        """
-        parser = FormParser()
-        parser.feed(html_content)
-
-        # Check for file inputs directly inside a form that do not reference
-        # any form through the form attribute
-        for form in parser.forms:
-            if (
-                form["file_form"]
-                and form["form_attrs"].get("enctype") != "multipart/form-data"
-                and not any(
-                    elem.get("formenctype") == "multipart/form-data"
-                    for elem in form["submit_element_attrs"]
-                )
-            ):
-                if form_id := form["form_attrs"].get("id"):
-                    alert = self.messages["form_id_missing_enctype"].format(
-                        form_id=form_id
-                    )
-                else:
-                    alert = self.messages["form_missing_enctype"]
-                self.add_alert({"alert": alert})
-
-        # Check for file inputs that reference a form
-        form_attrs_by_id = {
-            form["form_attrs"].get("id"): form["form_attrs"] for form in parser.forms
-        }
-
-        for attrs in parser.referenced_file_inputs:
-            form_id = attrs.get("form")
-            if form_id and attrs.get("type") == "file":
-                form_attrs = form_attrs_by_id.get(form_id)
-                if form_attrs and form_attrs.get("enctype") != "multipart/form-data":
-                    alert = self.messages["input_refs_form_missing_enctype"].format(
-                        form_id=form_id
-                    )
-                    self.add_alert({"alert": alert})
-
-        return self.alerts
-
-    def generate_stats(self, request, response):
-        html_content = response.content.decode(response.charset)
-        self.check_invalid_file_form_configuration(html_content)
-
-        # Further alert checks can go here
-
-        # Write all alerts to record_stats
-        self.record_stats({"alerts": self.alerts})
+from html.parser import HTMLParser
+
+from django.utils.translation import gettext_lazy as _
+
+from debug_toolbar.panels import Panel
+
+
+class FormParser(HTMLParser):
+    """
+    HTML form parser, used to check for invalid configurations of forms that
+    take file inputs.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.in_form = False
+        self.current_form = {}
+        self.forms = []
+        self.form_ids = []
+        self.referenced_file_inputs = []
+
+    def handle_starttag(self, tag, attrs):
+        attrs = dict(attrs)
+        if tag == "form":
+            self.in_form = True
+            form_id = attrs.get("id")
+            if form_id:
+                self.form_ids.append(form_id)
+            self.current_form = {
+                "file_form": False,
+                "form_attrs": attrs,
+                "submit_element_attrs": [],
+            }
+        elif (
+            self.in_form
+            and tag == "input"
+            and attrs.get("type") == "file"
+            and (not attrs.get("form") or attrs.get("form") == "")
+        ):
+            self.current_form["file_form"] = True
+        elif (
+            self.in_form
+            and (
+                (tag == "input" and attrs.get("type") in {"submit", "image"})
+                or tag == "button"
+            )
+            and (not attrs.get("form") or attrs.get("form") == "")
+        ):
+            self.current_form["submit_element_attrs"].append(attrs)
+        elif tag == "input" and attrs.get("form"):
+            self.referenced_file_inputs.append(attrs)
+
+    def handle_endtag(self, tag):
+        if tag == "form" and self.in_form:
+            self.forms.append(self.current_form)
+            self.in_form = False
+
+
+class AlertsPanel(Panel):
+    """
+    A panel to alert users to issues.
+    """
+
+    messages = {
+        "form_id_missing_enctype": _(
+            'Form with id "{form_id}" contains file input, but does not have the attribute enctype="multipart/form-data".'
+        ),
+        "form_missing_enctype": _(
+            'Form contains file input, but does not have the attribute enctype="multipart/form-data".'
+        ),
+        "input_refs_form_missing_enctype": _(
+            'Input element references form with id "{form_id}", but the form does not have the attribute enctype="multipart/form-data".'
+        ),
+    }
+
+    title = _("Alerts")
+
+    template = "debug_toolbar/panels/alerts.html"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.alerts = []
+
+    @property
+    def nav_subtitle(self):
+        alerts = self.get_stats()["alerts"]
+        if alerts:
+            alert_text = "alert" if len(alerts) == 1 else "alerts"
+            return f"{len(alerts)} {alert_text}"
+        else:
+            return ""
+
+    def add_alert(self, alert):
+        self.alerts.append(alert)
+
+    def check_invalid_file_form_configuration(self, html_content):
+        """
+        Inspects HTML content for a form that includes a file input but does
+        not have the encoding type set to multipart/form-data, and warns the
+        user if so.
+        """
+        parser = FormParser()
+        parser.feed(html_content)
+
+        # Check for file inputs directly inside a form that do not reference
+        # any form through the form attribute
+        for form in parser.forms:
+            if (
+                form["file_form"]
+                and form["form_attrs"].get("enctype") != "multipart/form-data"
+                and not any(
+                    elem.get("formenctype") == "multipart/form-data"
+                    for elem in form["submit_element_attrs"]
+                )
+            ):
+                if form_id := form["form_attrs"].get("id"):
+                    alert = self.messages["form_id_missing_enctype"].format(
+                        form_id=form_id
+                    )
+                else:
+                    alert = self.messages["form_missing_enctype"]
+                self.add_alert({"alert": alert})
+
+        # Check for file inputs that reference a form
+        form_attrs_by_id = {
+            form["form_attrs"].get("id"): form["form_attrs"] for form in parser.forms
+        }
+
+        for attrs in parser.referenced_file_inputs:
+            form_id = attrs.get("form")
+            if form_id and attrs.get("type") == "file":
+                form_attrs = form_attrs_by_id.get(form_id)
+                if form_attrs and form_attrs.get("enctype") != "multipart/form-data":
+                    alert = self.messages["input_refs_form_missing_enctype"].format(
+                        form_id=form_id
+                    )
+                    self.add_alert({"alert": alert})
+
+        return self.alerts
+
+    def generate_stats(self, request, response):
+        # check if streaming response
+        if getattr(response, "streaming", True):
+            return
+
+        html_content = response.content.decode(response.charset)
+        self.check_invalid_file_form_configuration(html_content)
+
+        # Further alert checks can go here
+
+        # Write all alerts to record_stats
+        self.record_stats({"alerts": self.alerts})

django_debug_toolbar-4.4.4/debug_toolbar/panels/templates/jinja2.py

@@ -0,0 +1,23 @@
+import functools
+
+from django.template.backends.jinja2 import Template as JinjaTemplate
+from django.template.context import make_context
+from django.test.signals import template_rendered
+
+
+def patch_jinja_render():
+    orig_render = JinjaTemplate.render
+
+    @functools.wraps(orig_render)
+    def wrapped_render(self, context=None, request=None):
+        # This patching of render only instruments the rendering
+        # of the immediate template. It won't include the parent template(s).
+        self.name = self.template.name
+        template_rendered.send(
+            sender=self, template=self, context=make_context(context, request)
+        )
+        return orig_render(self, context, request)
+
+    if JinjaTemplate.render != wrapped_render:
+        JinjaTemplate.original_render = JinjaTemplate.render
+        JinjaTemplate.render = wrapped_render

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

@@ -14,6 +14,7 @@ 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
 
 # Monkey-patch to enable the template_rendered signal. The receiver returns
 # immediately when the panel is disabled to keep the overhead small.
@@ -25,6 +26,7 @@ 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.3 → django_debug_toolbar-4.4.4}/docs/changes.rst

@@ -4,10 +4,18 @@ Change log
 Pending
 -------
 
+4.4.4 (2024-07-05)
+------------------
+
+* Added check for StreamingHttpResponse in alerts panel.
+* Instrument the Django Jinja2 template backend. This only instruments
+  the immediate template that's rendered. It will not provide stats on
+  any parent templates.
+
 4.4.3 (2024-07-04)
 ------------------
 
-* Added alert panel with warning when form is using file fields
+* Added alerts panel with warning when form is using file fields
   without proper encoding type.
 * Fixed overriding font-family for both light and dark themes.
 * Restored compatibility with ``iptools.IpRangeList``.

{django_debug_toolbar-4.4.3 → django_debug_toolbar-4.4.4}/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.3"
+release = "4.4.4"
 
 
 # -- General configuration ---------------------------------------------------

{django_debug_toolbar-4.4.3 → django_debug_toolbar-4.4.4}/example/settings.py

@@ -41,6 +41,12 @@ ROOT_URLCONF = "example.urls"
 STATIC_URL = "/static/"
 
 TEMPLATES = [
+    {
+        "NAME": "jinja2",
+        "BACKEND": "django.template.backends.jinja2.Jinja2",
+        "APP_DIRS": True,
+        "DIRS": [os.path.join(BASE_DIR, "example", "templates", "jinja2")],
+    },
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
         "APP_DIRS": True,
@@ -54,7 +60,7 @@ TEMPLATES = [
                 "django.contrib.messages.context_processors.messages",
             ],
         },
-    }
+    },
 ]
 
 USE_TZ = True

{django_debug_toolbar-4.4.3 → django_debug_toolbar-4.4.4}/example/templates/index.html

@@ -9,6 +9,7 @@
     <h1>Index of Tests</h1>
     {% cache 10 index_cache %}
       <ul>
+        <li><a href="{% url 'jinja' %}">Jinja2</a></li>
         <li><a href="/jquery/">jQuery 3.3.1</a></li>
         <li><a href="/mootools/">MooTools 1.6.0</a></li>
         <li><a href="/prototype/">Prototype 1.7.3.0</a></li>

django_debug_toolbar-4.4.4/example/templates/jinja2/index.jinja

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8">
+    <title>jinja Test</title>
+  </head>
+  <body>
+    <h1>jinja Test</h1>
+    {{ foo }}
+    {% for i in range(10) %}{{ i }}{% endfor %} {# Jinja2 supports range(), Django templates do not #}
+  </body>
+</html>

{django_debug_toolbar-4.4.3 → django_debug_toolbar-4.4.4}/example/urls.py

@@ -3,7 +3,7 @@ from django.urls import path
 from django.views.generic import TemplateView
 
 from debug_toolbar.toolbar import debug_toolbar_urls
-from example.views import increment
+from example.views import increment, jinja2_view
 
 urlpatterns = [
     path("", TemplateView.as_view(template_name="index.html"), name="home"),
@@ -12,6 +12,7 @@ urlpatterns = [
         TemplateView.as_view(template_name="bad_form.html"),
         name="bad_form",
     ),
+    path("jinja/", jinja2_view, name="jinja"),
     path("jquery/", TemplateView.as_view(template_name="jquery/index.html")),
     path("mootools/", TemplateView.as_view(template_name="mootools/index.html")),
     path("prototype/", TemplateView.as_view(template_name="prototype/index.html")),

{django_debug_toolbar-4.4.3 → django_debug_toolbar-4.4.4}/example/views.py

@@ -1,4 +1,5 @@
 from django.http import JsonResponse
+from django.shortcuts import render
 
 
 def increment(request):
@@ -8,3 +9,7 @@ def increment(request):
         value = 1
     request.session["value"] = value
     return JsonResponse({"value": value})
+
+
+def jinja2_view(request):
+    return render(request, "index.jinja", {"foo": "bar"}, using="jinja2")