Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 5, 2017
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66fa963
Refs #910: Skip template-based widget templates by default
matthiask May 4, 2017
a0ebcc3
Incorporate feedback
matthiask May 4, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion debug_toolbar/panels/templates/panel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ def _store_template_info(self, sender, **kwargs):

# Skip templates that we are generating through the debug toolbar.
if (isinstance(template.name, six.string_types) and
template.name.startswith('debug_toolbar/')):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By making this configurable, it becomes possible to unsilence (accidentally by deleting the wrong line in your own SKIP_TEMPLATE_PREFIXES, or intentionally) the djdt templates themselves.
Presumably, it's never been requested to be able to do so (or has been rejected for introducing too much configuration when it wasn't previously potentially necessary) so is it worth keeping the hard-coded extant functionality and making the SKIP_TEMPLATE_PREFIXES an additional set of skips?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I agree with @kezabelle . It's probably going to cause fewer headaches for people if we keep the 'debug_toolbar/' skip hard-coded instead of requiring users who customize the list to include it.

On the other hand, if it makes developing and debugging the toolbar itself easier, I don't think it's a big deal, as long as the default value is clearly documented.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. We can do that later should the need arise. I changed this.

template.name.startswith(
tuple(self.toolbar.config['SKIP_TEMPLATE_PREFIXES']))):
return

context_list = []
Expand Down
5 changes: 5 additions & 0 deletions debug_toolbar/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@
),
'PROFILER_MAX_DEPTH': 10,
'SHOW_TEMPLATE_CONTEXT': True,
'SKIP_TEMPLATE_PREFIXES': (
'debug_toolbar/',
'django/forms/widgets/',
'admin/widgets',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing trailing slash. If it's intentionally omitted, the docs change is wrong instead :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I meant to include the trailing slash.

),
'SQL_WARNING_THRESHOLD': 500, # milliseconds
}

Expand Down
11 changes: 11 additions & 0 deletions docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: ``('debug_toolbar/', '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``
Expand Down
3 changes: 3 additions & 0 deletions docs/tips.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.