Sourced fromdjango-debug-toolbar's releases.

6.0.0

Description

The v6.0.0 release of Django Debug Toolbar significantly revamps how panels for the toolbar work. Each panel will now persist its data in a store. A store can either be backed by various backends. The toolbar will support a memory and database backend to start.

The toolbar is now using Django'sSafeExceptionReporterFilter.cleanse_setting() function to filter out sensitive information. Some data will be replaced with"********************". This is because the toolbar could be configured to write the request information to a persistent store such as a cache or database.

Django applications with basic installations are backwards compatible with this change. If there are hooks into the internals of the toolbar, such asDebugToolbar.store_id then it will be backwards incompatible.

Third-party panels will need updating. Any data that is stored inrecord_stats will need to be fetched back out fromself.get_stats() before being able to be rendered. This is to support loading an instance of the toolbar from persisted data. A simple example of this transition can be found indebug_toolbar/panels/cache.py inPR 2138

How to upgrade

• Changes required if the toolbar isn't installed entirely programmatically
  • If you experienceRuntimeError: Model class debug_toolbar.models.HistoryEntry doesn't declare an explicit app_label and isn't in an application in INSTALLED_APPS, you need to remove the reference to the toolbar's urls in yoururls.py file andMIDDLEWARE setting when the toolbar isn't inINSTALLED_APPS
• If you have a custom panel, you'll need to adjustrecord_stats and useself.get_stats() to fetch data for rendering
• If you'd like to use the database store, seeTOOLBAR_STORE_CLASS for more info

Why did the internals change?

The Django Debug Toolbar is a popular package we did not want to block the community from pursuing the async path for Django applications. Writing the request data to a store better positions the toolbar for async projects. It also opens the door for it beingusable in production as well withAPI integrations.

What's Changed

• Log serialization warning when a panel errors. by@​tim-schilling indjango-commons/django-debug-toolbar#1810
• Improve clarity of record_stats for serialization. by@​tim-schilling indjango-commons/django-debug-toolbar#1965
• Update serializable branch with main by@​tim-schilling indjango-commons/django-debug-toolbar#2072
• Remove pin for django-csp. by@​tim-schilling indjango-commons/django-debug-toolbar#2132
• Fixes#2073 -- Added DatabaseStore for persistent debug data storage. by@​dr-rompecabezas indjango-commons/django-debug-toolbar#2121
• Disabled document.cookie linter by@​tim-schilling indjango-commons/django-debug-toolbar#2139
• Added check for pytest as test runner for IS_RUNNING_TESTS. by@​tim-schilling indjango-commons/django-debug-toolbar#2137
• Remove Type Hints from CspRenderingTestCase by@​andoriyaprashant indjango-commons/django-debug-toolbar#2144
• Add show_toolbar_with_docker function for Docker IP handling by@​matthiask indjango-commons/django-debug-toolbar#2153
• Support serializable toolbar by@​tim-schilling indjango-commons/django-debug-toolbar#2138
• Deduplicate staticfiles by@​matthiask indjango-commons/django-debug-toolbar#2155
• Fixes#2158 -- Made static file objects orderable by@​matthiask indjango-commons/django-debug-toolbar#2161
• Fixes#2160 -- Corrected links to static files by@​matthiask indjango-commons/django-debug-toolbar#2162
• Fixes#2151 -- Forwarded args and kwargs in URLMixin.url by@​matthiask indjango-commons/django-debug-toolbar#2163
• Fixes#2159 -- Do not HTML-escape traces in the cache and profiling panel by@​matthiask indjango-commons/django-debug-toolbar#2164

Full Changelog:django-commons/django-debug-toolbar@5.2.0...6.0.0

Acknowlegements

Thank you to all the contributors who made this release possible. Thank you to@​robhudson,@​matthiask,@​tim-schilling,@​salty-ivy and@​dr-rompecabezas for their support, development and reviews of the serializable toolbar changes. A special shout-out to@​matthiask for leading the Djangonaut Space Session 4 team of@​dr-rompecabezas,@​andoriyaprashant and@​blingblin-g.

5.2.0

What's Changed

• Enhance RedirectsPanel with customizable redirect response hook by@​blingblin-g indjango-commons/django-debug-toolbar#2104
• Sanitize sensitive variables in RequestPanel by@​dr-rompecabezas indjango-commons/django-debug-toolbar#2105
• [pre-commit.ci] pre-commit autoupdate by@​pre-commit-ci indjango-commons/django-debug-toolbar#2112

... (truncated)

Sourced fromdjango-debug-toolbar's changelog.

6.0.0 (2025-07-22)

• Added support for checking if pytest as the test runner when determiningif tests are running.
• Addedshow_toolbar_with_docker function to check Docker host IP addresswhen running inside Docker containers.
• Defines theBaseStore interface for request storage mechanisms.
• Added the settingTOOLBAR_STORE_CLASS to configure the requeststorage mechanism. Defaults todebug_toolbar.store.MemoryStore.
• Renamestore_id properties torequest_id andToolbar.store toToolbar.init_store.
• SupportPanel instances with stored stats viaPanel.load_stats_from_store.
• SwappedToolbar._store for theget_store() class.
• Created aStoredDebugToolbar that support creating an instance of thetoolbar representing an old request. It should only be used for fetchingpanels' contents.
• Dropraw_params from query data.
• Queries now have a uniquedjdt_query_id. The SQL forms now referencethis id and avoid passing SQL to be executed.
• Move the formatting logic of SQL queries to just before rendering inSQLPanel.content.
• MakePanel.panel_id a class member.
• Update all panels to utilize data fromPanel.get_stats() to load contentto render. Specifically forPanel.title andPanel.nav_title.
• Extend example app to contain an async version.
• Addeddebug_toolbar.store.DatabaseStore for persistent debug datastorage.
• Deduplicated static files in the staticfiles panel.

5.2.0 (2025-04-29)

• Added hook to RedirectsPanel for subclass customization.
• Added feature to sanitize sensitive data in the Request Panel.
• Fixed dark mode conflict in code block toolbar CSS.
• Properly allowed overriding the system theme preference by using the themeselector. Removed theDEFAULT_THEME setting, we should always default tosystem-level defaults where possible.
• Added support for using django-template-partials with the template panel'ssource view functionality. The same change possibly adds support for othertemplate loaders.
• Introduceddjade <https://github.com/adamchainz/djade>__ to format Djangotemplates.
• Swapped display order of panel header and close button to prevent styleconflicts
• Added CSS for resetting the height of elements too to avoid problems withglobal CSS of a website where the toolbar is used.

... (truncated)

• 4e47b94 Version 6.0.0
• 08a110e Fixes#2159 -- Do not HTML-escape traces in the cache and profiling panel
• b40dd8a Fixes 2151 -- Forwarded args and kwargs in URLMixin.url (#2163)
• cda2553 Fixes#2160 -- Corrected links to static files (#2162)
• 569528b Fixes#2158 -- Made static file objects orderable (#2161)
• 8ee45ed [pre-commit.ci] pre-commit autoupdate
• afd5e7e Deduplicate staticfiles (#2155)
• 9ee6c20 Merge remote-tracking branch 'origin/serializable'
• afcc4e1 [pre-commit.ci] pre-commit autoupdate (#2154)
• 2fafbb4 Merge branch 'main' into serializable
• Additional commits viewable incompare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)