Merge pull request #626 from jazzband/269-installed-check

SebCorbin · web-flow · commit 1fd2c4fa3bc5 · 2022-11-10T09:37:38.000+01:00
#269 Better check whether app is installed
diff --git a/silk/profiling/profiler.py b/silk/profiling/profiler.py
@@ -4,6 +4,7 @@
 import traceback
 from functools import wraps
 
+from django.apps import apps
 from django.conf import settings
 from django.utils import timezone
 
@@ -122,12 +123,11 @@ def __exit__(self, exc_type, exc_val, exc_tb):
                 self._finalise_queries()
 
     def _silk_installed(self):
-        app_installed = 'silk' in settings.INSTALLED_APPS
         middlewares = getattr(settings, 'MIDDLEWARE', [])
         if not middlewares:
             middlewares = []
         middleware_installed = SilkyConfig().SILKY_MIDDLEWARE_CLASS in middlewares
-        return app_installed and middleware_installed
+        return apps.is_installed('silk') and middleware_installed
 
     def _should_profile(self):
         return DataCollector().request is not None
diff --git a/silk/templates/silk/profiling.html b/silk/templates/silk/profiling.html
@@ -247,8 +247,14 @@ <h2>Silk Profiler</h2>
         <div class="container">
             <h2>Silk Profiler</h2>
 
-            <div class="description">No Silk profiling was performed for this request. Use the silk_profile
-                decorator/context manager to do so.
+            <div class="description">
+                No Silk profiling was performed for this request. Please check that:
+                <ul>
+                    <li>you use the <code>@silk_profile</code> decorator or <code>with silk_profile():</code> context manager on the correct view</li>
+                    <li>you have <code>"silk"</code> in <code>INSTALLED_APPS</code></li>
+                    <li>you have <code>"silk.middleware.SilkyMiddleware"</code> in <code>MIDDLEWARE</code></li>
+                    <li>you have <code>SILKY_PYTHON_PROFILER</code> set to <code>True</code></li>
+                </ul>
             </div>
         </div>
     {% endif %}
