Merge pull request #942 from matthiask/mk/skip-template-prefixes

Refs #910: Skip template-based widget templates by default

Author: matthiask

debug_toolbar/panels/templates/panel.py

@@ -84,8 +84,10 @@ def _store_template_info(self, sender, **kwargs):
         template, context = kwargs['template'], kwargs['context']
 
         # Skip templates that we are generating through the debug toolbar.
-        if (isinstance(template.name, six.string_types) and
-                template.name.startswith('debug_toolbar/')):
+        if (isinstance(template.name, six.string_types) and (
+            template.name.startswith('debug_toolbar/') or
+            template.name.startswith(
+                tuple(self.toolbar.config['SKIP_TEMPLATE_PREFIXES'])))):
             return
 
         context_list = []

debug_toolbar/settings.py

@@ -35,6 +35,10 @@
     ),
     'PROFILER_MAX_DEPTH': 10,
     'SHOW_TEMPLATE_CONTEXT': True,
+    'SKIP_TEMPLATE_PREFIXES': (
+        'django/forms/widgets/',
+        'admin/widgets/',
+    ),
     'SQL_WARNING_THRESHOLD': 500,   # milliseconds
 }
 

docs/configuration.rst

@@ -170,6 +170,17 @@ Panel options
   template contexts, or you have template contexts with lazy datastructures
   that you don't want to be evaluated.
 
+* ``SKIP_TEMPLATE_PREFIXES``
+
+  Default: ``('django/forms/widgets/', 'admin/widgets/')``
+
+  Panel: templates.
+
+  Templates starting with those strings are skipped when collecting
+  rendered templates and contexts. Template-based form widgets are
+  skipped by default because the panel HTML can easily grow to hundreds
+  of megabytes with many form fields and many options.
+
 * ``SQL_WARNING_THRESHOLD``
 
   Default: ``500``

docs/tips.rst

@@ -94,3 +94,6 @@ by disabling some configuration options that are enabled by default:
 
 - ``ENABLE_STACKTRACES`` for the SQL and cache panels,
 - ``SHOW_TEMPLATE_CONTEXT`` for the template panel.
+
+Also, check ``SKIP_TEMPLATE_PREFIXES`` when you're using template-based
+form widgets.