'djdt' is not a registered namespace #1405

debug_toolbar/apps.py

@@ -1,9 +1,10 @@
 import inspect
 import mimetypes
+import sys
 
 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 _
@@ -206,3 +207,23 @@ def js_mimetype_check(app_configs, **kwargs):
             )
         ]
     return []
+
+
+@register()
+def debug_toolbar_namespace_check(app_configs, **kwargs):
+    """
+    Check that the Django Debug Toolbar is registered as a namespace.
+    """
+    if (
+        settings.DEBUG is False
+        and dt_settings.get_config()["DEBUG_TOOLBAR_CONFIG"] == "test" in sys.argv
+    ):
+        return [
+            Error(
+                "django debug toolbar  is not a registered namespace ",
+                hint="The Django Debug Toolbar is misconfigured, check the documentation for proper configuration and run the tests.",
+                id="debug_toolbar.W008",
+            )
+        ]
+    else:
+        return []

debug_toolbar/settings.py

@@ -1,3 +1,4 @@
+import sys
 import warnings
 from functools import lru_cache
 
@@ -42,6 +43,7 @@
     "SQL_WARNING_THRESHOLD": 500,  # milliseconds
     "OBSERVE_REQUEST_CALLBACK": "debug_toolbar.toolbar.observe_request",
     "TOOLBAR_LANGUAGE": None,
+    "DEBUG_TOOLBAR_CONFIG": "test" in sys.argv,
     "UPDATE_ON_FETCH": False,
 }
 

docs/Makefile

@@ -8,6 +8,7 @@ SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 
+
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/changes.rst

@@ -29,10 +29,13 @@ Pending
   <https://astral.sh/blog/the-ruff-formatter>`__.
 * Changed the default position of the toolbar from top to the upper top
   position.
+* Fixed the bug causing ``'djdt' is not a registered namespace`` and updated
+  docs to help in initial configuration.
 * Added the setting, ``UPDATE_ON_FETCH`` to control whether the
   toolbar automatically updates to the latest AJAX request or not.
   It defaults to ``False``.
 
+
 4.2.0 (2023-08-10)
 ------------------
 

docs/installation.rst

@@ -99,7 +99,34 @@ Add django-debug-toolbar's URLs to your project's URLconf:
 This example uses the ``__debug__`` prefix, but you can use any prefix that
 doesn't clash with your application's URLs.
 
-5. Add the Middleware
+5. Configure django-debug-toolbar
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Add the following configuration for django-debug-toolbar in your setting:
+
+.. code-block:: python
+
+    import sys
+
+    DEBUG = bool({"runserver"}.intersection(sys.argv))
+
+    DEBUG_TOOLBAR_CONFIG = "test" in sys.argv
+
+    DEBUG_TOOLBAR = DEBUG and not DEBUG_TOOLBAR_CONFIG
+
+
+To explicitly check the ``settings.DEBUG_TOOLBAR_CONFIG``variable before
+including the URLs, add the following code in your ``urls`` file.
+
+.. code-block:: python
+
+    if settings.DEBUG_TOOLBAR_CONFIG:
+
+        import debug_toolbar
+
+        urlpatterns += [path('__debug__/', include(debug_toolbar.urls))]
+
+6. Add the Middleware
 ^^^^^^^^^^^^^^^^^^^^^
 
 The Debug Toolbar is mostly implemented in a middleware. Add it to your
@@ -122,7 +149,7 @@ The Debug Toolbar is mostly implemented in a middleware. Add it to your
 
 .. _internal-ips:
 
-6. Configure Internal IPs
+7. Configure Internal IPs
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The Debug Toolbar is shown only if your IP address is listed in Django’s

example/settings.py

@@ -1,15 +1,25 @@
 """Django settings for example project."""
 
 import os
+import sys
+
+import environ
 
 BASE_DIR = os.path.dirname(os.path.dirname(__file__))
 
 
 # Quick-start development settings - unsuitable for production
 
+env = environ.Env()
+environ.Env.read_env()
+
 SECRET_KEY = "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"
 
-DEBUG = True
+# DEBUG = True
+
+DEBUG = env("DEBUG", default=bool({"runserver"}.intersection(sys.argv)))
+DEBUG_TOOLBAR_CONFIG = env("DEBUG_TOOLBAR_CONFIG", default="test" in sys.argv)
+DEBUG_TOOLBAR = DEBUG and not DEBUG_TOOLBAR_CONFIG
 
 INTERNAL_IPS = ["127.0.0.1", "::1"]
 

tests/test_checks.py

@@ -1,12 +1,16 @@
 import os
+import sys
 import unittest
 from unittest.mock import patch
 
 import django
 from django.conf import settings
-from django.core.checks import Warning, run_checks
+from django.core.checks import Error, Warning, run_checks
 from django.test import SimpleTestCase, override_settings
 
+from debug_toolbar import settings as dt_settings
+from debug_toolbar.apps import debug_toolbar_namespace_check
+
 PATH_DOES_NOT_EXIST = os.path.join(settings.BASE_DIR, "tests", "invalid_static")
 
 
@@ -258,3 +262,79 @@ def test_check_w007_invalid(self, mocked_guess_type):
                 )
             ],
         )
+
+    # @patch("debug_toolbar.apps.debug_toolbar_namespace_check", [])
+    # def test_check_w008_valid(self):
+    #     self.assertEqual(
+    #         run_checks(),
+    #         [
+    #             Error(
+    #                 "debug toolbar  is not a registered namespace",
+    #                 hint="The Django Debug Toolbar is misconfigured, check the documentation for proper configuration",
+    #                 id="debug_toolbar.W008",
+    #             )
+    #         ],
+    #     )
+
+
+def test_check_w008_valid(self):
+    settings.DEBUG = True
+    dt_settings.get_config()["DEBUG_TOOLBAR_CONFIG"] = "test"
+    errors = debug_toolbar_namespace_check(None)
+    self.assertEqual(
+        errors,
+        [
+            Error(
+                "debug toolbar is not a registered namespace",
+                hint="The Django Debug Toolbar is misconfigured, check the documentation for proper configuration",
+                id="debug_toolbar.W008",
+            )
+        ],
+    )
+
+    @patch("debug_toolbar.apps.debug_toolbar_namespace_check", [])
+    def test_debug_toolbar_namespace_check_with_debug_false_and_config_not_test(
+        self, mocked_get_config
+    ):
+        mocked_get_config.return_value = {"DEBUG_TOOLBAR_CONFIG": "not_test"}
+        settings.DEBUG = False
+        errors = debug_toolbar_namespace_check(None)
+        self.assertEqual(len(errors), 0)
+
+    @patch("debug_toolbar.apps.debug_toolbar_namespace_check", [])
+    def test_debug_toolbar_namespace_check_with_debug_true_and_config_test(
+        self, mocked_get_config
+    ):
+        mocked_get_config.return_value = {"DEBUG_TOOLBAR_CONFIG": "test"}
+        settings.DEBUG = True
+        sys.argv = ["manage.py", "test"]
+        errors = debug_toolbar_namespace_check(None)
+        self.assertEqual(len(errors), 0)
+
+    @patch("debug_toolbar.apps.debug_toolbar_namespace_check", [])
+    def test_debug_toolbar_namespace_check_with_debug_true_and_config_not_test(
+        self, mock_get_config
+    ):
+        mock_get_config.return_value = {"DEBUG_TOOLBAR_CONFIG": "not_test"}
+        settings.DEBUG = True
+        sys.argv = ["manage.py", "test"]
+        errors = debug_toolbar_namespace_check(None)
+        self.assertEqual(len(errors), 0)
+
+    @patch("debug_toolbar.apps.debug_toolbar_namespace_check", [])
+    def test_debug_toolbar_namespace_check_with_debug_false_and_config_test(
+        self, mock_get_config
+    ):
+        mock_get_config.return_value = {"DEBUG_TOOLBAR_CONFIG": "test"}
+        settings.DEBUG = False
+        errors = debug_toolbar_namespace_check(None)
+        self.assertEqual(
+            errors,
+            [
+                Error(
+                    "django debug toolbar  is not a registered namespace ",
+                    hint="The Django Debug Toolbar is misconfigured, check the documentation for proper configuration and run the tests.",
+                    id="debug_toolbar.W008",
+                )
+            ],
+        )