Merge branch 'main' into deprecate-redirects-panel

Author: JohananOppongAmoateng

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: python-package-distributions
         path: dist/
@@ -43,7 +43,7 @@ jobs:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v5
+      uses: actions/download-artifact@v6
       with:
         name: python-package-distributions
         path: dist/
@@ -64,12 +64,12 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v5
+      uses: actions/download-artifact@v6
       with:
         name: python-package-distributions
         path: dist/
     - name: Sign the dists with Sigstore
-      uses: sigstore/gh-action-sigstore-python@v3.0.1
+      uses: sigstore/gh-action-sigstore-python@v3.1.0
       with:
         inputs: >-
           ./dist/*.tar.gz
@@ -109,7 +109,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v5
+      uses: actions/download-artifact@v6
       with:
         name: python-package-distributions
         path: dist/

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
     hooks:
     -   id: doc8
 -   repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.29.0
+    rev: 1.29.1
     hooks:
     -   id: django-upgrade
         args: [--target-version, "4.2"]
@@ -29,18 +29,18 @@ repos:
     -   id: rst-backticks
     -   id: rst-directive-colons
 -   repo: https://github.com/biomejs/pre-commit
-    rev: v2.2.5
+    rev: v2.3.1
     hooks:
       - id: biome-check
         verbose: true
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.14.0'
+    rev: 'v0.14.2'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
 -   repo: https://github.com/tox-dev/pyproject-fmt
-    rev: v2.10.0
+    rev: v2.11.0
     hooks:
       - id: pyproject-fmt
 -   repo: https://github.com/abravalheri/validate-pyproject

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

debug_toolbar/__init__.py

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

debug_toolbar/apps.py

@@ -24,6 +24,35 @@ def ready(self):
         # allows panels like CachePanel to enable their instrumentation immediately.
         for cls in DebugToolbar.get_panel_classes():
             cls.ready()
+        _manage_migrations_visibility(self.name)
+
+    def import_models(self):
+        """
+        Override import models to avoid allowing users to dynamically fetch a model
+        that doesn't have a table behind it unless they are using the DatabaseStore.
+        This also prevents the command `migrate --run-syncdb` from creating tables
+        for the models.
+        """
+        dt_config = dt_settings.get_config()
+        if dt_config["TOOLBAR_STORE_CLASS"] == "debug_toolbar.store.DatabaseStore":
+            return super().import_models()
+        # Not using the database store, don't import the models
+        self.models = {}
+
+
+def _manage_migrations_visibility(app_name):
+    """
+    Adjust the toolbar's migration visibility by manipulating the
+    project's settings.
+
+    This is a hack since it's manipulating settings.
+    """
+    if (
+        dt_settings.get_config()["TOOLBAR_STORE_CLASS"]
+        != "debug_toolbar.store.DatabaseStore"
+    ):
+        # This effectively hides the migrations by telling Django they don't exist.
+        settings.MIGRATION_MODULES.setdefault(app_name, None)
 
 
 def check_template_config(config):

docs/architecture.rst

@@ -85,3 +85,5 @@ Problematic Parts
   fully compatible and currently being worked on. For now, these panels
   are disabled by default when running in async environment.
   follow the progress of this issue in `Async compatible toolbar project <https://github.com/orgs/jazzband/projects/9>`_.
+- Django Channels incompatibility: The toolbar does not currently support
+  Django Channels' consumers due to the difference in middleware design.

docs/changes.rst

@@ -4,6 +4,9 @@ Change log
 Pending
 -------
 
+6.1.0 (2025-10-30)
+------------------
+
 * Added support for async to timer panel.
 * Added a note about the default password in ``make example``.
 * Removed logging about the toolbar failing to serialize a value into JSON.
@@ -21,6 +24,12 @@ Pending
 * Updated logic that forces values to strings (``force_str``) to render
   "Django Debug Toolbar was unable to parse value." when there's a decoding
   error.
+* Updated docs to show incompatibility with Django Channels.
+* Hide the toolbar's migrations unless ``debug_toolbar.store.DatabaseStore``
+  is being used. This may change in the future.
+* Hide ``debug_toolbar.HistoryEntry`` as a model unless
+  ``debug_toolbar.store.DatabaseStore`` is being used. This may change in the
+  future.
 
 6.0.0 (2025-07-22)
 ------------------

docs/conf.py

@@ -25,7 +25,7 @@
 copyright = copyright.format(datetime.date.today().year)
 
 # The full version, including alpha/beta/rc tags
-release = "6.0.0"
+release = "6.1.0"
 
 
 # -- General configuration ---------------------------------------------------

docs/configuration.rst

@@ -196,15 +196,15 @@ Toolbar options
   The DatabaseStore provides persistence and automatically cleans up old
   entries based on the ``RESULTS_CACHE_SIZE`` setting.
 
-  Note: For full functionality, DatabaseStore requires migrations for
-  the debug_toolbar app:
+  Note: When using ``DatabaseStore`` migrations are required for
+  the ``debug_toolbar`` app:
 
   .. code-block:: bash
 
       python manage.py migrate debug_toolbar
 
-  For the DatabaseStore to work properly, you need to run migrations for the
-  debug_toolbar app. The migrations create the necessary database table to store
+  For the ``DatabaseStore`` to work properly, you need to run migrations for the
+  ``debug_toolbar`` app. The migrations create the necessary database table to store
   toolbar data.
 
 .. _TOOLBAR_LANGUAGE:

docs/installation.rst

@@ -273,12 +273,13 @@ And for Apache:
 Django Channels & Async
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-The Debug Toolbar currently has experimental support for Django Channels and
-async projects. The Debug Toolbar is compatible with the following exceptions:
+The Debug Toolbar currently has experimental support for async projects.
+The Debug Toolbar is compatible with the following exceptions:
 
 - Concurrent requests aren't supported
 - ``TimerPanel``, ``RequestPanel`` and ``ProfilingPanel`` can't be used
   in async contexts.
+- Django Channels is not supported yet.
 
 HTMX
 ^^^^