Create urls module and remove import package from docs.

By creating a urls module, devs can include the urls with a string
path to the urls, include('debug_toolbar.urls').

Author: tim-schilling

debug_toolbar/toolbar.py

@@ -143,6 +143,8 @@ def is_toolbar_request(cls, request):
         """
         Determine if the request is for a DebugToolbar view.
         """
+        from debug_toolbar.urls import app_name
+
         # The primary caller of this function is in the middleware which may
         # not have resolver_match set.
         try:
@@ -152,7 +154,3 @@ def is_toolbar_request(cls, request):
         except Resolver404:
             return False
         return resolver_match.namespaces and resolver_match.namespaces[-1] == app_name
-
-
-app_name = "djdt"
-urlpatterns = DebugToolbar.get_urls()

debug_toolbar/urls.py

@@ -0,0 +1,4 @@
+from debug_toolbar.toolbar import DebugToolbar
+
+app_name = "djdt"
+urlpatterns = DebugToolbar.get_urls()

docs/changes.rst

@@ -11,6 +11,8 @@ Next version
   usages before ``enable_instrumentation`` is called.
 * Add check ``W006`` to warn that the toolbar is incompatible with
   ``TEMPLATES`` settings configurations with ``APP_DIRS`` set to ``False``.
+* Create ``urls`` module and update documentation to no longer require
+  importing the toolbar package.
 
 
 3.2.2 (2021-08-14)

docs/installation.rst

@@ -79,12 +79,11 @@ Add django-debug-toolbar's URLs to your project's URLconf:
 
 .. code-block:: python
 
-    import debug_toolbar
     from django.urls import include, path
 
     urlpatterns = [
         # ...
-        path('__debug__/', include(debug_toolbar.urls)),
+        path('__debug__/', include('debug_toolbar.urls')),
     ]
 
 This example uses the ``__debug__`` prefix, but you can use any prefix that

example/urls.py

@@ -2,13 +2,11 @@
 from django.urls import include, path
 from django.views.generic import TemplateView
 
-import debug_toolbar
-
 urlpatterns = [
     path("", TemplateView.as_view(template_name="index.html")),
     path("jquery/", TemplateView.as_view(template_name="jquery/index.html")),
     path("mootools/", TemplateView.as_view(template_name="mootools/index.html")),
     path("prototype/", TemplateView.as_view(template_name="prototype/index.html")),
     path("admin/", admin.site.urls),
-    path("__debug__/", include(debug_toolbar.urls)),
+    path("__debug__/", include("debug_toolbar.urls")),
 ]

tests/urls.py

@@ -2,8 +2,6 @@
 from django.contrib.auth.views import LoginView
 from django.urls import include, path, re_path
 
-import debug_toolbar
-
 from . import views
 from .models import NonAsciiRepr
 
@@ -25,5 +23,5 @@
     path("redirect/", views.redirect_view),
     path("login_without_redirect/", LoginView.as_view(redirect_field_name=None)),
     path("admin/", admin.site.urls),
-    path("__debug__/", include(debug_toolbar.urls)),
+    path("__debug__/", include("debug_toolbar.urls")),
 ]