django-debug-toolbar 5.0.1__tar.gz → 5.2.0__tar.gz

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/.github/workflows/release.yml

@@ -69,7 +69,7 @@ jobs:
         name: python-package-distributions
         path: dist/
     - name: Sign the dists with Sigstore
-      uses: sigstore/gh-action-sigstore-python@v3
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
       with:
         inputs: >-
           ./dist/*.tar.gz

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/.pre-commit-config.yaml

@@ -14,46 +14,36 @@ repos:
     hooks:
     -   id: doc8
 -   repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.22.2
+    rev: 1.24.0
     hooks:
     -   id: django-upgrade
         args: [--target-version, "4.2"]
+-   repo: https://github.com/adamchainz/djade-pre-commit
+    rev: "1.4.0"
+    hooks:
+    -   id: djade
+        args: [--target-version, "4.2"]
 -   repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:
     -   id: rst-backticks
     -   id: rst-directive-colons
--   repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v4.0.0-alpha.8
-    hooks:
-    -   id: prettier
-        entry: env PRETTIER_LEGACY_CLI=1 prettier
-        types_or: [javascript, css]
-        args:
-        - --trailing-comma=es5
--   repo: https://github.com/pre-commit/mirrors-eslint
-    rev: v9.17.0
-    hooks:
-    -   id: eslint
-        additional_dependencies:
-            - "eslint@v9.17.0"
-            - "@eslint/js@v9.17.0"
-            - "globals"
-        files: \.js?$
-        types: [file]
-        args:
-        - --fix
+-   repo: https://github.com/biomejs/pre-commit
+    rev: v1.9.4
+    hooks:
+      - id: biome-check
+        verbose: true
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.8.6'
+    rev: 'v0.11.7'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
 -   repo: https://github.com/tox-dev/pyproject-fmt
-    rev: v2.5.0
+    rev: v2.5.1
     hooks:
       - id: pyproject-fmt
 -   repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.23
+    rev: v0.24.1
     hooks:
       - id: validate-pyproject

django_debug_toolbar-5.2.0/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing to Django Debug Toolbar
+
+This is a [Django Commons](https://github.com/django-commons/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md).
+
+## Documentation
+
+For detailed contributing guidelines, please see our [Documentation](https://django-debug-toolbar.readthedocs.io/en/latest/contributing.html).
+
+## Additional Resources
+
+Please see the [README](https://github.com/django-commons/membership/blob/main/README.md) for more help.

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/Makefile

@@ -1,23 +1,24 @@
-.PHONY: example test coverage translatable_strings update_translations
+.PHONY: example test coverage translatable_strings update_translations help
+.DEFAULT_GOAL := help
 
-example:
+example:  ## Run the example application
 	python example/manage.py migrate --noinput
 	-DJANGO_SUPERUSER_PASSWORD=p python example/manage.py createsuperuser \
 		--noinput --username="$(USER)" --email="$(USER)@mailinator.com"
 	python example/manage.py runserver
 
-example_test:
+example_test:  ## Run the test suite for the example application
 	python example/manage.py test example
 
-test:
+test:  ## Run the test suite
 	DJANGO_SETTINGS_MODULE=tests.settings \
 		python -m django test $${TEST_ARGS:-tests}
 
-test_selenium:
+test_selenium:  ## Run frontend tests written with Selenium
 	DJANGO_SELENIUM_TESTS=true DJANGO_SETTINGS_MODULE=tests.settings \
 		python -m django test $${TEST_ARGS:-tests}
 
-coverage:
+coverage:  ## Run the test suite with coverage enabled
 	python --version
 	DJANGO_SETTINGS_MODULE=tests.settings \
 		python -b -W always -m coverage run -m django test -v2 $${TEST_ARGS:-tests}
@@ -25,15 +26,19 @@ coverage:
 	coverage html
 	coverage xml
 
-translatable_strings:
+translatable_strings:  ## Update the English '.po' file
 	cd debug_toolbar && python -m django makemessages -l en --no-obsolete
 	@echo "Please commit changes and run 'tx push -s' (or wait for Transifex to pick them)"
 
-update_translations:
+update_translations:  ## Download updated '.po' files from Transifex
 	tx pull -a --minimum-perc=10
 	cd debug_toolbar && python -m django compilemessages
 
 .PHONY: example/django-debug-toolbar.png
-example/django-debug-toolbar.png: example/screenshot.py
+example/django-debug-toolbar.png: example/screenshot.py  ## Update the screenshot in 'README.rst'
 	python $< --browser firefox --headless -o $@
 	optipng $@
+
+help:  ## Help message for targets
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
+		| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/PKG-INFO

@@ -1,9 +1,13 @@
 Metadata-Version: 2.4
 Name: django-debug-toolbar
-Version: 5.0.1
+Version: 5.2.0
 Summary: A configurable set of panels that display various debug information about the current request/response.
+Project-URL: Changelog, https://django-debug-toolbar.readthedocs.io/en/latest/changes.html
+Project-URL: Documentation, https://django-debug-toolbar.readthedocs.io/
 Project-URL: Download, https://pypi.org/project/django-debug-toolbar/
 Project-URL: Homepage, https://github.com/django-commons/django-debug-toolbar
+Project-URL: Issues, https://github.com/django-commons/django-debug-toolbar/issues
+Project-URL: Source, https://github.com/django-commons/django-debug-toolbar
 Author: Rob Hudson
 License: BSD-3-Clause
 License-File: LICENSE
@@ -13,6 +17,7 @@ Classifier: Framework :: Django
 Classifier: Framework :: Django :: 4.2
 Classifier: Framework :: Django :: 5.0
 Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
@@ -71,7 +76,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 5.0.1. It works on
+The current stable version of the Debug Toolbar is 5.2.0. It works on
 Django ≥ 4.2.0.
 
 The Debug Toolbar has experimental support for `Django's asynchronous views

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/README.rst

@@ -40,7 +40,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 5.0.1. It works on
+The current stable version of the Debug Toolbar is 5.2.0. It works on
 Django ≥ 4.2.0.
 
 The Debug Toolbar has experimental support for `Django's asynchronous views

django_debug_toolbar-5.2.0/biome.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+    "formatter": {
+        "enabled": true,
+        "useEditorconfig": true
+    },
+    "organizeImports": {
+        "enabled": true
+    },
+    "linter": {
+        "enabled": true,
+        "rules": {
+            "recommended": true
+        }
+    },
+    "javascript": {
+        "formatter": {
+            "trailingCommas": "es5",
+            "quoteStyle": "double"
+        }
+    }
+}

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

django_debug_toolbar-5.2.0/debug_toolbar/decorators.py

@@ -0,0 +1,48 @@
+import functools
+
+from asgiref.sync import iscoroutinefunction
+from django.http import Http404
+from django.utils.translation import get_language, override as language_override
+
+from debug_toolbar import settings as dt_settings
+
+
+def require_show_toolbar(view):
+    """
+    Async compatible decorator to restrict access to a view
+    based on the Debug Toolbar's visibility settings.
+    """
+    from debug_toolbar.middleware import get_show_toolbar
+
+    if iscoroutinefunction(view):
+
+        @functools.wraps(view)
+        async def inner(request, *args, **kwargs):
+            show_toolbar = get_show_toolbar(async_mode=True)
+            if not await show_toolbar(request):
+                raise Http404
+
+            return await view(request, *args, **kwargs)
+    else:
+
+        @functools.wraps(view)
+        def inner(request, *args, **kwargs):
+            show_toolbar = get_show_toolbar(async_mode=False)
+            if not show_toolbar(request):
+                raise Http404
+
+            return view(request, *args, **kwargs)
+
+    return inner
+
+
+def render_with_toolbar_language(view):
+    """Force any rendering within the view to use the toolbar's language."""
+
+    @functools.wraps(view)
+    def inner(request, *args, **kwargs):
+        lang = dt_settings.get_config()["TOOLBAR_LANGUAGE"] or get_language()
+        with language_override(lang):
+            return view(request, *args, **kwargs)
+
+    return inner

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/debug_toolbar/locale/ru/LC_MESSAGES/django.po

@@ -3,17 +3,18 @@
 #
 #
 # Translators:
+# Andrei Satsevich, 2025
 # Dmitri Bogomolov <4glitch@gmail.com>, 2014
 # Ilya Baryshev <baryshev@gmail.com>, 2013
 # Mikhail Korobov, 2009
-# Алексей Борискин <sun.void@gmail.com>, 2013,2015
+# Алексей Борискин <sun.void@gmail.com>, 2013,2015,2024
 msgid ""
 msgstr ""
 "Project-Id-Version: Django Debug Toolbar\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2024-08-06 07:12-0500\n"
 "PO-Revision-Date: 2010-11-30 00:00+0000\n"
-"Last-Translator: Алексей Борискин <sun.void@gmail.com>, 2013,2015\n"
+"Last-Translator: Andrei Satsevich, 2025\n"
 "Language-Team: Russian (http://app.transifex.com/django-debug-toolbar/django-debug-toolbar/language/ru/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -30,24 +31,24 @@ msgstr "Панель отладки"
 msgid ""
 "Form with id \"{form_id}\" contains file input, but does not have the "
 "attribute enctype=\"multipart/form-data\"."
-msgstr ""
+msgstr "Форма с идентификатором \"{form_id}\" содержит файл, но не имеет атрибута enctype=\"multipart/form-data\"."
 
 #: panels/alerts.py:70
 msgid ""
 "Form contains file input, but does not have the attribute "
 "enctype=\"multipart/form-data\"."
-msgstr ""
+msgstr "Форма содержит файл, но не имеет атрибута enctype=\"multipart/form-data\"."
 
 #: panels/alerts.py:73
 #, python-brace-format
 msgid ""
 "Input element references form with id \"{form_id}\", but the form does not "
 "have the attribute enctype=\"multipart/form-data\"."
-msgstr ""
+msgstr "Элемент ввода ссылается на форму с id \"{form_id}\", но форма не имеет атрибута enctype=\"multipart/form-data\"."
 
 #: panels/alerts.py:77
 msgid "Alerts"
-msgstr ""
+msgstr "Оповещения"
 
 #: panels/cache.py:168
 msgid "Cache"
@@ -77,7 +78,7 @@ msgstr "Заголовки"
 
 #: panels/history/panel.py:19 panels/history/panel.py:20
 msgid "History"
-msgstr ""
+msgstr "История"
 
 #: panels/profiling.py:140
 msgid "Profiling"
@@ -106,7 +107,7 @@ msgstr "Настройки"
 #: panels/settings.py:20
 #, python-format
 msgid "Settings from %s"
-msgstr ""
+msgstr "Настройки из %s"
 
 #: panels/signals.py:57
 #, python-format
@@ -178,19 +179,19 @@ msgstr "SQL"
 #, python-format
 msgid "%(query_count)d query in %(sql_time).2fms"
 msgid_plural "%(query_count)d queries in %(sql_time).2fms"
-msgstr[0] ""
-msgstr[1] ""
-msgstr[2] ""
-msgstr[3] ""
+msgstr[0] "%(query_count)d запрос за %(sql_time).2f мс "
+msgstr[1] "%(query_count)d запросов за %(sql_time).2f мс"
+msgstr[2] "%(query_count)d запросов за %(sql_time).2f мс"
+msgstr[3] "%(query_count)d запросов за %(sql_time).2f мс"
 
 #: panels/sql/panel.py:180
 #, python-format
 msgid "SQL queries from %(count)d connection"
 msgid_plural "SQL queries from %(count)d connections"
-msgstr[0] ""
-msgstr[1] ""
-msgstr[2] ""
-msgstr[3] ""
+msgstr[0] "SQL-запросы из %(count)d соединения"
+msgstr[1] "SQL-запросы из %(count)d соединений"
+msgstr[2] "SQL-запросы из %(count)d соединений"
+msgstr[3] "SQL-запросы из %(count)d соединений"
 
 #: panels/staticfiles.py:82
 #, python-format
@@ -221,7 +222,7 @@ msgstr "Шаблоны (обработано %(num_templates)s)"
 
 #: panels/templates/panel.py:195
 msgid "No origin"
-msgstr ""
+msgstr "Без происхождения"
 
 #: panels/timer.py:27
 #, python-format
@@ -299,7 +300,7 @@ msgstr "Скрыть"
 
 #: templates/debug_toolbar/base.html:25 templates/debug_toolbar/base.html:26
 msgid "Toggle Theme"
-msgstr ""
+msgstr "Переключатель темы"
 
 #: templates/debug_toolbar/base.html:35
 msgid "Show toolbar"
@@ -315,11 +316,11 @@ msgstr "Включить для последующих запросов"
 
 #: templates/debug_toolbar/panels/alerts.html:4
 msgid "Alerts found"
-msgstr ""
+msgstr "Найдены оповещения"
 
 #: templates/debug_toolbar/panels/alerts.html:11
 msgid "No alerts found"
-msgstr ""
+msgstr "Оповещения не найдены"
 
 #: templates/debug_toolbar/panels/cache.html:2
 msgid "Summary"
@@ -417,11 +418,11 @@ msgstr "Путь"
 
 #: templates/debug_toolbar/panels/history.html:12
 msgid "Request Variables"
-msgstr ""
+msgstr "Запрос переменных"
 
 #: templates/debug_toolbar/panels/history.html:13
 msgid "Status"
-msgstr ""
+msgstr "Статус"
 
 #: templates/debug_toolbar/panels/history.html:14
 #: templates/debug_toolbar/panels/sql.html:37
@@ -524,14 +525,14 @@ msgstr[3] "%(num)s запросов"
 msgid ""
 "including <abbr title=\"Similar queries are queries with the same SQL, but "
 "potentially different parameters.\">%(count)s similar</abbr>"
-msgstr ""
+msgstr "включая <abbr title=\"Similar queries are queries with the same SQL, but potentially different parameters.\">%(count)s похожий</abbr>"
 
 #: templates/debug_toolbar/panels/sql.html:12
 #, python-format
 msgid ""
 "and <abbr title=\"Duplicate queries are identical to each other: they "
 "execute exactly the same SQL and parameters.\">%(dupes)s duplicates</abbr>"
-msgstr ""
+msgstr "и <abbr title=\"Duplicate queries are identical to each other: they execute exactly the same SQL and parameters.\">%(dupes)s дубликаты</abbr>"
 
 #: templates/debug_toolbar/panels/sql.html:34
 msgid "Query"
@@ -545,12 +546,12 @@ msgstr "Временная диаграмма"
 #: templates/debug_toolbar/panels/sql.html:52
 #, python-format
 msgid "%(count)s similar queries."
-msgstr ""
+msgstr "%(count)s похожих запросов."
 
 #: templates/debug_toolbar/panels/sql.html:58
 #, python-format
 msgid "Duplicated %(dupes)s times."
-msgstr ""
+msgstr "Дублируется %(dupes)s раз."
 
 #: templates/debug_toolbar/panels/sql.html:95
 msgid "Connection:"
@@ -710,7 +711,7 @@ msgstr "С начала навигации в мс (+продолжительн
 
 #: templates/debug_toolbar/panels/versions.html:10
 msgid "Package"
-msgstr ""
+msgstr "Пакет"
 
 #: templates/debug_toolbar/panels/versions.html:11
 msgid "Name"

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/debug_toolbar/middleware.py

@@ -6,7 +6,12 @@ import re
 import socket
 from functools import cache
 
-from asgiref.sync import iscoroutinefunction, markcoroutinefunction
+from asgiref.sync import (
+    async_to_sync,
+    iscoroutinefunction,
+    markcoroutinefunction,
+    sync_to_async,
+)
 from django.conf import settings
 from django.utils.module_loading import import_string
 
@@ -47,7 +52,12 @@ def show_toolbar(request):
 
 
 @cache
-def get_show_toolbar():
+def show_toolbar_func_or_path():
+    """
+    Fetch the show toolbar callback from settings
+
+    Cached to avoid importing multiple times.
+    """
     # If SHOW_TOOLBAR_CALLBACK is a string, which is the recommended
     # setup, resolve it to the corresponding callable.
     func_or_path = dt_settings.get_config()["SHOW_TOOLBAR_CALLBACK"]
@@ -57,6 +67,23 @@ def get_show_toolbar():
         return func_or_path
 
 
+def get_show_toolbar(async_mode):
+    """
+    Get the callback function to show the toolbar.
+
+    Will wrap the function with sync_to_async or
+    async_to_sync depending on the status of async_mode
+    and whether the underlying function is a coroutine.
+    """
+    show_toolbar = show_toolbar_func_or_path()
+    is_coroutine = iscoroutinefunction(show_toolbar)
+    if is_coroutine and not async_mode:
+        show_toolbar = async_to_sync(show_toolbar)
+    elif not is_coroutine and async_mode:
+        show_toolbar = sync_to_async(show_toolbar)
+    return show_toolbar
+
+
 class DebugToolbarMiddleware:
     """
     Middleware to set up Debug Toolbar on incoming request and render toolbar
@@ -82,7 +109,8 @@ class DebugToolbarMiddleware:
         if self.async_mode:
             return self.__acall__(request)
         # Decide whether the toolbar is active for this request.
-        show_toolbar = get_show_toolbar()
+        show_toolbar = get_show_toolbar(async_mode=self.async_mode)
+
         if not show_toolbar(request) or DebugToolbar.is_toolbar_request(request):
             return self.get_response(request)
         toolbar = DebugToolbar(request, self.get_response)
@@ -103,8 +131,9 @@ class DebugToolbarMiddleware:
 
     async def __acall__(self, request):
         # Decide whether the toolbar is active for this request.
-        show_toolbar = get_show_toolbar()
-        if not show_toolbar(request) or DebugToolbar.is_toolbar_request(request):
+        show_toolbar = get_show_toolbar(async_mode=self.async_mode)
+
+        if not await show_toolbar(request) or DebugToolbar.is_toolbar_request(request):
             response = await self.get_response(request)
             return response
 

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/debug_toolbar/panels/cache.py

@@ -68,7 +68,7 @@ class CachePanel(Panel):
         self.hits = 0
         self.misses = 0
         self.calls = []
-        self.counts = {name: 0 for name in WRAPPED_CACHE_METHODS}
+        self.counts = dict.fromkeys(WRAPPED_CACHE_METHODS, 0)
 
     @classmethod
     def current_instance(cls):

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/debug_toolbar/panels/redirects.py

@@ -22,20 +22,8 @@ class RedirectsPanel(Panel):
         Common response processing logic.
         """
         if 300 <= response.status_code < 400:
-            redirect_to = response.get("Location")
-            if redirect_to:
-                status_line = f"{response.status_code} {response.reason_phrase}"
-                cookies = response.cookies
-                context = {
-                    "redirect_to": redirect_to,
-                    "status_line": status_line,
-                    "toolbar": self.toolbar,
-                }
-                # Using SimpleTemplateResponse avoids running global context processors.
-                response = SimpleTemplateResponse(
-                    "debug_toolbar/redirect.html", context
-                )
-                response.cookies = cookies
+            if redirect_to := response.get("Location"):
+                response = self.get_interception_response(response, redirect_to)
                 response.render()
         return response
 
@@ -53,3 +41,22 @@ class RedirectsPanel(Panel):
         if iscoroutine(response):
             return self.aprocess_request(request, response)
         return self._process_response(response)
+
+    def get_interception_response(self, response, redirect_to):
+        """
+        Hook method to allow subclasses to customize the interception response.
+        """
+        status_line = f"{response.status_code} {response.reason_phrase}"
+        cookies = response.cookies
+        original_response = response
+        context = {
+            "redirect_to": redirect_to,
+            "status_line": status_line,
+            "toolbar": self.toolbar,
+            "original_response": original_response,
+        }
+        # Using SimpleTemplateResponse avoids running global context processors.
+        response = SimpleTemplateResponse("debug_toolbar/redirect.html", context)
+        response.cookies = cookies
+        response.original_response = original_response
+        return response

{django_debug_toolbar-5.0.1 → django_debug_toolbar-5.2.0}/debug_toolbar/panels/request.py

@@ -3,7 +3,7 @@ from django.urls import resolve
 from django.utils.translation import gettext_lazy as _
 
 from debug_toolbar.panels import Panel
-from debug_toolbar.utils import get_name_from_obj, get_sorted_request_variable
+from debug_toolbar.utils import get_name_from_obj, sanitize_and_sort_request_vars
 
 
 class RequestPanel(Panel):
@@ -26,9 +26,9 @@ class RequestPanel(Panel):
     def generate_stats(self, request, response):
         self.record_stats(
             {
-                "get": get_sorted_request_variable(request.GET),
-                "post": get_sorted_request_variable(request.POST),
-                "cookies": get_sorted_request_variable(request.COOKIES),
+                "get": sanitize_and_sort_request_vars(request.GET),
+                "post": sanitize_and_sort_request_vars(request.POST),
+                "cookies": sanitize_and_sort_request_vars(request.COOKIES),
             }
         )
 
@@ -59,13 +59,5 @@ class RequestPanel(Panel):
         self.record_stats(view_info)
 
         if hasattr(request, "session"):
-            try:
-                session_list = [
-                    (k, request.session.get(k)) for k in sorted(request.session.keys())
-                ]
-            except TypeError:
-                session_list = [
-                    (k, request.session.get(k))
-                    for k in request.session.keys()  # (it's not a dict)
-                ]
-            self.record_stats({"session": {"list": session_list}})
+            session_data = dict(request.session)
+            self.record_stats({"session": sanitize_and_sort_request_vars(session_data)})