django-debug-toolbar 4.2.0__tar.gz → 4.4.1__tar.gz

django_debug_toolbar-4.4.1/.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Keep GitHub Actions up to date with GitHub's Dependabot...
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    groups:
+      github-actions:
+        patterns:
+          - "*"  # Group all Actions updates into a single larger pull request
+    schedule:
+      interval: weekly

django_debug_toolbar-4.4.1/.github/workflows/coverage.yml

@@ -0,0 +1,33 @@
+# .github/workflows/coverage.yml
+name: Post coverage comment
+
+on:
+  workflow_run:
+    workflows: ["Test"]
+    types:
+      - completed
+
+jobs:
+  test:
+    name: Run tests & display coverage
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
+      # Gives the action the necessary permissions for looking up the
+      # workflow that launched this workflow, and download the related
+      # artifact that contains the comment to be published
+      actions: read
+    steps:
+      # DO NOT run actions/checkout here, for security reasons
+      # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+      - name: Post comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/.github/workflows/release.yml

@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: 3.8
 

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       max-parallel: 5
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     services:
       mariadb:
@@ -30,12 +30,13 @@ jobs:
         - 3306:3306
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
 
     - name: Get pip cache dir
       id: pip-cache
@@ -43,7 +44,7 @@ jobs:
         echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
 
     - name: Cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.dir }}
         key:
@@ -65,11 +66,6 @@ jobs:
         DB_HOST: 127.0.0.1
         DB_PORT: 3306
 
-    - name: Upload coverage data
-      uses: actions/upload-artifact@v3
-      with:
-        name: coverage-data
-        path: ".coverage.*"
 
   postgres:
     runs-on: ubuntu-latest
@@ -77,14 +73,16 @@ jobs:
       fail-fast: false
       max-parallel: 5
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
         database: [postgresql, postgis]
-        # Add psycopg3 to our matrix for 3.10 and 3.11
+        # Add psycopg3 to our matrix for modern python versions
         include:
             - python-version: '3.10'
               database: psycopg3
             - python-version: '3.11'
               database: psycopg3
+            - python-version: '3.12'
+              database: psycopg3
 
     services:
       postgres:
@@ -102,12 +100,13 @@ jobs:
           --health-retries 5
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
 
     - name: Get pip cache dir
       id: pip-cache
@@ -115,7 +114,7 @@ jobs:
         echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
 
     - name: Cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.dir }}
         key:
@@ -140,27 +139,22 @@ jobs:
         DB_HOST: localhost
         DB_PORT: 5432
 
-    - name: Upload coverage data
-      uses: actions/upload-artifact@v3
-      with:
-        name: coverage-data
-        path: ".coverage.*"
-
   sqlite:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       max-parallel: 5
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
 
     - name: Get pip cache dir
       id: pip-cache
@@ -168,7 +162,7 @@ jobs:
         echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
 
     - name: Cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.dir }}
         key:
@@ -187,53 +181,16 @@ jobs:
         DB_BACKEND: sqlite3
         DB_NAME: ":memory:"
 
-    - name: Upload coverage data
-      uses: actions/upload-artifact@v3
-      with:
-        name: coverage-data
-        path: ".coverage.*"
-
-  coverage:
-    name: Check coverage.
-    runs-on: "ubuntu-latest"
-    needs: [sqlite, mysql, postgres]
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          # Use latest, so it understands all syntax.
-          python-version: "3.11"
-
-      - run: python -m pip install --upgrade coverage[toml]
-
-      - name: Download coverage data.
-        uses: actions/download-artifact@v3
-        with:
-          name: coverage-data
-
-      - name: Combine coverage & check percentage
-        run: |
-          python -m coverage combine
-          python -m coverage html
-          python -m coverage report
-
-      - name: Upload HTML report if check failed.
-        uses: actions/upload-artifact@v3
-        with:
-          name: html-report
-          path: htmlcov
-        if: ${{ failure() }}
-
   lint:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.8
 
@@ -243,7 +200,7 @@ jobs:
         echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
 
     - name: Cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.dir }}
         key:

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
     -   id: check-toml
     -   id: check-yaml
@@ -14,46 +14,46 @@ repos:
     hooks:
     -   id: doc8
 -   repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.14.0
+    rev: 1.16.0
     hooks:
     -   id: django-upgrade
-        args: [--target-version, "3.2"]
+        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: v3.0.1
+    rev: v4.0.0-alpha.8
     hooks:
     -   id: prettier
+        entry: env PRETTIER_LEGACY_CLI=1 prettier
         types_or: [javascript, css]
         args:
-        -  --trailing-comma=es5
+        - --trailing-comma=es5
 -   repo: https://github.com/pre-commit/mirrors-eslint
-    rev: v8.46.0
+    rev: v9.0.0
     hooks:
     -   id: eslint
+        additional_dependencies:
+            - "eslint@v9.0.0-beta.1"
+            - "@eslint/js@v9.0.0-beta.1"
+            - "globals"
         files: \.js?$
         types: [file]
         args:
         - --fix
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.0.282'
+    rev: 'v0.3.7'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
--   repo: https://github.com/psf/black
-    rev: 23.7.0
-    hooks:
-    -   id: black
-        language_version: python3
-        entry: black --target-version=py38
+      - id: ruff-format
 -   repo: https://github.com/tox-dev/pyproject-fmt
-    rev: 0.13.0
+    rev: 1.7.0
     hooks:
       - id: pyproject-fmt
 -   repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.13
+    rev: v0.16
     hooks:
       - id: validate-pyproject

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/Makefile

@@ -6,6 +6,9 @@ example:
 		--noinput --username="$(USER)" --email="$(USER)@mailinator.com"
 	python example/manage.py runserver
 
+example_test:
+	python example/manage.py test example
+
 test:
 	DJANGO_SETTINGS_MODULE=tests.settings \
 		python -m django test $${TEST_ARGS:-tests}

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: django-debug-toolbar
-Version: 4.2.0
+Version: 4.4.1
 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
@@ -10,10 +10,8 @@ License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.0
-Classifier: Framework :: Django :: 4.1
 Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
@@ -23,9 +21,10 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
-Requires-Dist: django>=3.2.4
+Requires-Dist: django>=4.2.9
 Requires-Dist: sqlparse>=0.2
 Description-Content-Type: text/x-rst
 
@@ -75,8 +74,11 @@ 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.1.0. It works on
-Django ≥ 3.2.4.
+The current stable version of the Debug Toolbar is 4.4.1. It works on
+Django ≥ 4.2.0.
+
+The Debug Toolbar does not currently support `Django's asynchronous views
+<https://docs.djangoproject.com/en/dev/topics/async/>`_.
 
 Documentation, including installation and configuration instructions, is
 available at https://django-debug-toolbar.readthedocs.io/.

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/README.rst

@@ -44,8 +44,11 @@ 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.1.0. It works on
-Django ≥ 3.2.4.
+The current stable version of the Debug Toolbar is 4.4.1. It works on
+Django ≥ 4.2.0.
+
+The Debug Toolbar does not currently support `Django's asynchronous views
+<https://docs.djangoproject.com/en/dev/topics/async/>`_.
 
 Documentation, including installation and configuration instructions, is
 available at https://django-debug-toolbar.readthedocs.io/.

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

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/debug_toolbar/apps.py

@@ -3,7 +3,7 @@ import mimetypes
 
 from django.apps import AppConfig
 from django.conf import settings
-from django.core.checks import Warning, register
+from django.core.checks import Error, Warning, register
 from django.middleware.gzip import GZipMiddleware
 from django.utils.module_loading import import_string
 from django.utils.translation import gettext_lazy as _
@@ -177,7 +177,7 @@ def check_panels(app_configs, **kwargs):
     return errors
 
 
-@register()
+@register
 def js_mimetype_check(app_configs, **kwargs):
     """
     Check that JavaScript files are resolving to the correct content type.
@@ -206,3 +206,40 @@ def js_mimetype_check(app_configs, **kwargs):
             )
         ]
     return []
+
+
+@register
+def debug_toolbar_installed_when_running_tests_check(app_configs, **kwargs):
+    """
+    Check that the toolbar is not being used when tests are running
+    """
+    if not settings.DEBUG and dt_settings.get_config()["IS_RUNNING_TESTS"]:
+        return [
+            Error(
+                "The Django Debug Toolbar can't be used with tests",
+                hint="Django changes the DEBUG setting to False when running "
+                "tests. By default the Django Debug Toolbar is installed because "
+                "DEBUG is set to True. For most cases, you need to avoid installing "
+                "the toolbar when running tests. If you feel this check is in error, "
+                "you can set `DEBUG_TOOLBAR_CONFIG['IS_RUNNING_TESTS'] = False` to "
+                "bypass this check.",
+                id="debug_toolbar.E001",
+            )
+        ]
+    else:
+        return []
+
+
+@register
+def check_settings(app_configs, **kwargs):
+    errors = []
+    USER_CONFIG = getattr(settings, "DEBUG_TOOLBAR_CONFIG", {})
+    if "OBSERVE_REQUEST_CALLBACK" in USER_CONFIG:
+        errors.append(
+            Warning(
+                "The deprecated OBSERVE_REQUEST_CALLBACK setting is present in DEBUG_TOOLBAR_CONFIG.",
+                hint="Use the UPDATE_ON_FETCH and/or SHOW_TOOLBAR_CALLBACK settings instead.",
+                id="debug_toolbar.W008",
+            )
+        )
+    return errors

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/debug_toolbar/middleware.py

@@ -3,6 +3,7 @@ Debug Toolbar middleware
 """
 
 import re
+import socket
 from functools import lru_cache
 
 from django.conf import settings
@@ -19,7 +20,22 @@ def show_toolbar(request):
     """
     Default function to determine whether to show the toolbar on a given page.
     """
-    return settings.DEBUG and request.META.get("REMOTE_ADDR") in settings.INTERNAL_IPS
+    internal_ips = settings.INTERNAL_IPS.copy()
+
+    try:
+        # This is a hack for docker installations. It attempts to look
+        # up the IP address of the docker host.
+        # This is not guaranteed to work.
+        docker_ip = (
+            # Convert the last segment of the IP address to be .1
+            ".".join(socket.gethostbyname("host.docker.internal").rsplit(".")[:-1])
+            + ".1"
+        )
+        internal_ips.append(docker_ip)
+    except socket.gaierror:
+        # It's fine if the lookup errored since they may not be using docker
+        pass
+    return settings.DEBUG and request.META.get("REMOTE_ADDR") in internal_ips
 
 
 @lru_cache(maxsize=None)

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/debug_toolbar/panels/profiling.py

@@ -42,10 +42,14 @@ class FunctionCall:
         """
         if hasattr(settings, "BASE_DIR"):
             file_name, _, _ = self.func
-            return (
-                str(settings.BASE_DIR) in file_name
-                and "/site-packages/" not in file_name
-                and "/dist-packages/" not in file_name
+            base_dir = str(settings.BASE_DIR)
+
+            file_name = os.path.normpath(file_name)
+            base_dir = os.path.normpath(base_dir)
+
+            return file_name.startswith(base_dir) and not any(
+                directory in file_name.split(os.path.sep)
+                for directory in ["site-packages", "dist-packages"]
             )
         return None
 
@@ -82,12 +86,10 @@ class FunctionCall:
             )
 
     def subfuncs(self):
-        i = 0
         h, s, v = self.hsv
         count = len(self.statobj.all_callees[self.func])
-        for func, stats in self.statobj.all_callees[self.func].items():
-            i += 1
-            h1 = h + (i / count) / (self.depth + 1)
+        for i, (func, stats) in enumerate(self.statobj.all_callees[self.func].items()):
+            h1 = h + ((i + 1) / count) / (self.depth + 1)
             s1 = 0 if stats[3] == 0 else s * (stats[3] / self.stats[3])
             yield FunctionCall(
                 self.statobj,

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/debug_toolbar/panels/sql/tracking.py

@@ -109,21 +109,6 @@ class NormalCursorMixin(DjDTCursorWrapperMixin):
     Wraps a cursor and logs queries.
     """
 
-    def _quote_expr(self, element):
-        if isinstance(element, str):
-            return "'%s'" % element.replace("'", "''")
-        else:
-            return repr(element)
-
-    def _quote_params(self, params):
-        if not params:
-            return params
-        if isinstance(params, dict):
-            return {key: self._quote_expr(value) for key, value in params.items()}
-        if isinstance(params, tuple):
-            return tuple(self._quote_expr(p) for p in params)
-        return [self._quote_expr(p) for p in params]
-
     def _decode(self, param):
         if PostgresJson and isinstance(param, PostgresJson):
             # psycopg3
@@ -157,9 +142,7 @@ class NormalCursorMixin(DjDTCursorWrapperMixin):
         # process during the .last_executed_query() call.
         self.db._djdt_logger = None
         try:
-            return self.db.ops.last_executed_query(
-                self.cursor, sql, self._quote_params(params)
-            )
+            return self.db.ops.last_executed_query(self.cursor, sql, params)
         finally:
             self.db._djdt_logger = self.logger
 

{django_debug_toolbar-4.2.0 → django_debug_toolbar-4.4.1}/debug_toolbar/panels/staticfiles.py

@@ -4,7 +4,6 @@ from os.path import join, normpath
 
 from django.conf import settings
 from django.contrib.staticfiles import finders, storage
-from django.core.checks import Warning
 from django.utils.functional import LazyObject
 from django.utils.translation import gettext_lazy as _, ngettext
 
@@ -178,27 +177,3 @@ class StaticFilesPanel(panels.Panel):
                     if app not in apps:
                         apps.append(app)
         return apps
-
-    @classmethod
-    def run_checks(cls):
-        """
-        Check that the integration is configured correctly for the panel.
-
-        Specifically look for static files that haven't been collected yet.
-
-        Return a list of :class: `django.core.checks.CheckMessage` instances.
-        """
-        errors = []
-        for finder in finders.get_finders():
-            try:
-                for path, finder_storage in finder.list([]):
-                    finder_storage.path(path)
-            except OSError:
-                errors.append(
-                    Warning(
-                        "debug_toolbar requires the STATICFILES_DIRS directories to exist.",
-                        hint="Running manage.py collectstatic may help uncover the issue.",
-                        id="debug_toolbar.staticfiles.W001",
-                    )
-                )
-        return errors