Merge pull request #4490 from NyanKiyoshi/deps/dev/warn

Ensure the debug toolbar is installed

saleor/settings.py

@@ -1,5 +1,6 @@
 import ast
 import os.path
+import warnings
 
 import dj_database_url
 import dj_email_url
@@ -269,8 +270,19 @@ def get_bool_from_env(name, default_value):
 
 ENABLE_DEBUG_TOOLBAR = get_bool_from_env("ENABLE_DEBUG_TOOLBAR", False)
 if ENABLE_DEBUG_TOOLBAR:
-    MIDDLEWARE.append("debug_toolbar.middleware.DebugToolbarMiddleware")
-    INSTALLED_APPS.append("debug_toolbar")
+    # Ensure the debug toolbar is actually installed before adding it
+    try:
+        __import__("debug_toolbar")
+    except ImportError as exc:
+        msg = (
+            f"{exc} -- Install the missing dependencies by "
+            f"running `pip install -r requirements_dev.txt`"
+        )
+        warnings.warn(msg)
+    else:
+        MIDDLEWARE.append("debug_toolbar.middleware.DebugToolbarMiddleware")
+        INSTALLED_APPS.append("debug_toolbar")
+
     DEBUG_TOOLBAR_PANELS = [
         # adds a request history to the debug toolbar
         "ddt_request_history.panels.request_history.RequestHistoryPanel",

saleor/urls.py

@@ -50,12 +50,17 @@
 urlpatterns = non_translatable_urlpatterns + i18n_patterns(*translatable_urlpatterns)
 
 if settings.DEBUG:
-    import debug_toolbar
+    try:
+        import debug_toolbar
+    except ImportError:
+        """The debug toolbar was not installed. Ignore the error.
+        settings.py should already have warned the user about it."""
+    else:
+        urlpatterns += [url(r"^__debug__/", include(debug_toolbar.urls))]
 
     urlpatterns += [
-        url(r"^__debug__/", include(debug_toolbar.urls)),
         # static files (images, css, javascript, etc.)
-        url(r"^static/(?P<path>.*)$", serve),
+        url(r"^static/(?P<path>.*)$", serve)
     ] + static("/media/", document_root=settings.MEDIA_ROOT)
 
 if settings.ENABLE_SILK: