Skip to content

Update django-debug-toolbar to 6.3.0#2469

Open
pyup-bot wants to merge 1 commit intomasterfrom
pyup-update-django-debug-toolbar-4.2.0-to-6.3.0
Open

Update django-debug-toolbar to 6.3.0#2469
pyup-bot wants to merge 1 commit intomasterfrom
pyup-update-django-debug-toolbar-4.2.0-to-6.3.0

Conversation

@pyup-bot
Copy link
Copy Markdown
Collaborator

@pyup-bot pyup-bot commented Apr 2, 2026

This PR updates django-debug-toolbar from 4.2.0 to 6.3.0.

Changelog

6.3.0

------------------

* Replaced ``requirements_dev.txt`` file for ``pyproject.toml`` support with
dependency groups.
* Updated ReadTheDocs Python version to 3.13.
* Modernize some panel styles and colors.
* Standardize use of time/duration units and labels across panels.
* Added translations for Lithuanian, Turkish and Uzbek.
* Update the translations.
* Expose a ``py.typed`` marker file.
* Updated ``RedirectsPanel`` to emit the deprecation warning when it's used
rather than on instantiation.
* Highlighted the documentation about disabling the browser's caching to
ensure the latest static assets are used.
* Fixed bug with ``CachePanel`` so the cache patching is only applied
once.
* Added ``debug_toolbar.store.CacheStore`` for storing toolbar data using
Django's cache framework. This provides persistence without requiring
database migrations, and works with any cache backend (Memcached, Redis,
database, file-based, etc.).
* Added ``CACHE_BACKEND`` and ``CACHE_KEY_PREFIX`` settings to configure the
``CacheStore``.

6.2.0

------------------

* Deprecated ``RedirectsPanel`` in favor of ``HistoryPanel`` for viewing
toolbar data from redirected requests.
* Fixed support for generating code coverage comments in PRs.
* Added Django 6.0 to the testing matrix. Removed Django 5.0 to save CI
resources.
* Show the cache backend alias and cache backend class name instead of
the cache instance in the cache panel.
* Dropped support for the Python 3.9, it has reached its end of life date.
* Toggle tracking the toolbar's queries when using
``debug_toolbar.store.DatabaseStore`` with ``SKIP_TOOLBAR_QUERIES``.
* Fixed font family for code blocks and stack traces in the toolbar.
* Added test to confirm Django's ``TestCase.assertNumQueries`` works.
* Fixed string representation of values in settings panel.
* Declared support for Django 6.0.

6.1.0

------------------

* 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.
* Moved the the import statement of ``debug_toolbar.urls`` to within the if
statement's scope on the installation documentation.
* Changed ``StoredDebugToolbar.from_store`` to always create a panel key and
class instance, regardless if any data was generated.
* Fixed selenium tests for CI by using psycopg for Python 3.13 runs.
* Added ``CommunityPanel`` containing links to documentation and resources.
* Upgraded CI ``postgis`` version to 17-3.5.
* Added how to generate the documentation locally to the contributing
documentation.
* 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

------------------

* Added support for checking if pytest as the test runner when determining
if tests are running.
* Added ``show_toolbar_with_docker`` function to check Docker host IP address
when running inside Docker containers.
* Defines the ``BaseStore`` interface for request storage mechanisms.
* Added the setting ``TOOLBAR_STORE_CLASS`` to configure the request
storage mechanism. Defaults to ``debug_toolbar.store.MemoryStore``.
* Rename ``store_id`` properties to ``request_id`` and ``Toolbar.store`` to
``Toolbar.init_store``.
* Support ``Panel`` instances with stored stats via
``Panel.load_stats_from_store``.
* Swapped ``Toolbar._store`` for the ``get_store()`` class.
* Created a ``StoredDebugToolbar`` that support creating an instance of the
toolbar representing an old request. It should only be used for fetching
panels' contents.
* Drop ``raw_params`` from query data.
* Queries now have a unique ``djdt_query_id``. The SQL forms now reference
this id and avoid passing SQL to be executed.
* Move the formatting logic of SQL queries to just before rendering in
``SQLPanel.content``.
* Make ``Panel.panel_id`` a class member.
* Update all panels to utilize data from ``Panel.get_stats()`` to load content
to render. Specifically for ``Panel.title`` and ``Panel.nav_title``.
* Extend example app to contain an async version.
* Added ``debug_toolbar.store.DatabaseStore`` for persistent debug data
storage.
* Deduplicated static files in the staticfiles panel.

5.2.0

------------------

* 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 theme
selector. Removed the ``DEFAULT_THEME`` setting, we should always default to
system-level defaults where possible.
* Added support for using django-template-partials with the template panel's
source view functionality. The same change possibly adds support for other
template loaders.
* Introduced `djade <https://github.com/adamchainz/djade>`__ to format Django
templates.
* Swapped display order of panel header and close button to prevent style
conflicts
* Added CSS for resetting the height of elements too to avoid problems with
global CSS of a website where the toolbar is used.

5.1.0

------------------

* Added Django 5.2 to the tox matrix.
* Updated package metadata to include well-known labels.
* Added resources section to the documentation.
* Wrap ``SHOW_TOOLBAR_CALLBACK`` function with ``sync_to_async``
or ``async_to_sync`` to allow sync/async compatibility.
* Make ``require_toolbar`` decorator compatible to async views.
* Added link to contributing documentation in ``CONTRIBUTING.md``.
* Replaced ESLint and prettier with biome in our pre-commit configuration.
* Added a Makefile target (``make help``) to get a quick overview
of each target.
* Avoided reinitializing the staticfiles storage during instrumentation.
* Avoided a "forked" Promise chain in the rebound ``window.fetch`` function
with missing exception handling.
* Fixed the pygments code highlighting when using dark mode.
* Fix for exception-unhandled "forked" Promise chain in rebound window.fetch
* Create a CSP nonce property on the toolbar ``Toolbar().csp_nonce``.

5.0.1

------------------
* Fixing the build and release process. No functional changes.

5.0.0

------------------

* Added Python 3.13 to the CI matrix.
* Removed support for Python 3.8 as it has reached end of life.
* Converted to Django Commons PyPI release process.
* Fixed a crash which occurred when using non-``str`` static file values.
* Documented experimental async support.
* Improved troubleshooting doc for incorrect mime types for .js static files

Please see everything under 5.0.0-alpha as well.

5.0.0alpha

------------------------

* Support async applications and ASGI from
`Google Summer of Code Project 2024
<https://summerofcode.withgoogle.com/programs/2024/projects/iXVvyGYp>`__.
* Added Django 5.1 to the CI matrix.
* Added support for the ``LoginRequiredMiddleware`` introduced in Django 5.1.
* Support select and explain buttons for ``UNION`` queries on PostgreSQL.
* Fixed internal toolbar requests being instrumented if the Django setting
``FORCE_SCRIPT_NAME`` was set.
* Increase opacity of show Debug Toolbar handle to improve accessibility.
* Changed the ``RedirectsPanel`` to be async compatible.
* Increased the contrast of text with dark mode enabled.
* Add translations for Bulgarian and Korean.
* Update translations for several languages.
* Include new translatable strings for translation.
* Fixed a crash which happened in the fallback case when session keys cannot be
sorted.

4.4.6

------------------

* Changed ordering (and grammatical number) of panels and their titles in
documentation to match actual panel ordering and titles.
* Skipped processing the alerts panel when response isn't a HTML response.

4.4.5

------------------

* Avoided crashing when the alerts panel was skipped.
* Removed the inadvertently added hard dependency on Jinja2.

4.4.4

------------------

* 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

------------------

* 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``.
* Limit ``E001`` check to likely error cases when the
``SHOW_TOOLBAR_CALLBACK`` has changed, but the toolbar's URL
paths aren't installed.
* Introduce helper function ``debug_toolbar_urls`` to
simplify installation.
* Moved "1rem" height/width for SVGs to CSS properties.

4.4.2

------------------

* Removed some CSS which wasn't carefully limited to the toolbar's elements.
* Stopped assuming that ``INTERNAL_IPS`` is a list.
* Added a section to the installation docs about running tests in projects
where the toolbar is being used.

4.4.1

------------------

* Pin metadata version to 2.2 to be compatible with Jazzband release
process.

4.4.0

------------------

* Raised the minimum Django version to 4.2.
* Automatically support Docker rather than having the developer write a
workaround for ``INTERNAL_IPS``.
* Display a better error message when the toolbar's requests
return invalid json.
* Render forms with ``as_div`` to silence Django 5.0 deprecation warnings.
* Stayed on top of pre-commit hook updates.
* Added :doc:`architecture documentation <architecture>` to help
on-board new contributors.
* Removed the static file path validation check in
:class:`StaticFilesPanel <debug_toolbar.panels.staticfiles.StaticFilesPanel>`
since that check is made redundant by a similar check in Django 4.0 and
later.
* Deprecated the ``OBSERVE_REQUEST_CALLBACK`` setting and added check
``debug_toolbar.W008`` to warn when it is present in
``DEBUG_TOOLBAR_SETTINGS``.
* Add a note on the profiling panel about using Python 3.12 and later
about needing ``--nothreading``
* Added ``IS_RUNNING_TESTS`` setting to allow overriding the
``debug_toolbar.E001`` check to avoid including the toolbar when running
tests.
* Fixed the bug causing ``'djdt' is not a registered namespace`` and updated
docs to help in initial configuration while running tests.
* Added a link in the installation docs to a more complete installation
example in the example app.
* Added check to prevent the toolbar from being installed when tests
are running.
* Added test to example app and command to run the example app's tests.
* Implemented dark mode theme and button to toggle the theme,
introduced the ``DEFAULT_THEME`` setting which sets the default theme
to use.

4.3.0

------------------

* Dropped support for Django 4.0.
* Added Python 3.12 to test matrix.
* Removed outdated third-party panels from the list.
* Avoided the unnecessary work of recursively quoting SQL parameters.
* Postponed context process in templates panel to include lazy evaluated
content.
* Fixed template panel to avoid evaluating ``LazyObject`` when not already
evaluated.
* Added support for Django 5.0.
* Refactor the ``utils.get_name_from_obj`` to simulate the behavior of
``django.contrib.admindocs.utils.get_view_name``.
* Switched from black to the `ruff formatter
<https://astral.sh/blog/the-ruff-formatter>`__.
* Changed the default position of the toolbar from top to the upper top
position.
* Added the setting, ``UPDATE_ON_FETCH`` to control whether the
toolbar automatically updates to the latest AJAX request or not.
It defaults to ``False``.
Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant