Merge branch 'django-commons:main' into copy-context

Author: thesayfulla

.github/workflows/release.yml

@@ -48,7 +48,7 @@ jobs:
         name: python-package-distributions
         path: dist/
     - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1.10
+      uses: pypa/gh-action-pypi-publish@release/v1.12
 
   github-release:
     name: >-
@@ -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
@@ -95,7 +95,7 @@ jobs:
 
   publish-to-testpypi:
     name: Publish Python 🐍 distribution 📦 to TestPyPI
-    if: startsWith(github.ref, 'refs/tags/')  # only publish to TestPyPI on tag pushes
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to Test PyPI on tag pushes
     needs:
     - build
     runs-on: ubuntu-latest
@@ -114,7 +114,7 @@ jobs:
         name: python-package-distributions
         path: dist/
     - name: Publish distribution 📦 to TestPyPI
-      uses: pypa/gh-action-pypi-publish@release/v1.10
+      uses: pypa/gh-action-pypi-publish@release/v1.12
       with:
         repository-url: https://test.pypi.org/legacy/
         skip-existing: true

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
     hooks:
     -   id: doc8
 -   repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.22.2
+    rev: 1.23.1
     hooks:
     -   id: django-upgrade
         args: [--target-version, "4.2"]
@@ -23,34 +23,19 @@ repos:
     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.4'
+    rev: 'v0.9.10'
     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

CONTRIBUTING.md

@@ -1,5 +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).
 
-Please see the
-[README](https://github.com/django-commons/membership/blob/main/README.md)
-for more help.
+## 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.

Makefile

@@ -1,39 +1,44 @@
-.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}
 	coverage report
 	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}'

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

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"
+        }
+    }
+}

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 = "5.0.0-alpha"
+VERSION = "5.0.1"
 
 # Code that discovers files or modules in INSTALLED_APPS imports this module.
 urls = "debug_toolbar.urls", APP_NAME

debug_toolbar/decorators.py

@@ -1,21 +1,37 @@
 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):
-    @functools.wraps(view)
-    def inner(request, *args, **kwargs):
-        from debug_toolbar.middleware import get_show_toolbar
+    """
+    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):
 
-        show_toolbar = get_show_toolbar()
-        if not show_toolbar(request):
-            raise Http404
+        @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 view(request, *args, **kwargs)
+            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