Opened 9 years ago
Last modified 11 days ago
#28526 new Cleanup/optimization
Remedy verbose, often unhelpful undefined template variable logging
| Reported by: | Tim Graham | Owned by: | |
|---|---|---|---|
| Component: | Template system | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Adam Johnson | Triage Stage: | Accepted |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
As discussed on django-developers, ticket #18773 added logging of undefined template variables in Django 1.9 [dc5b01ad05e50ccde688c73c2ed3334a956076b0], however, I've seen several reports of users finding this logging more confusing than helpful. For example, admin templates log errors about missing is_popup variables which is how the template are designed (is_popup is only in the contexts of pop ups) and the TECHNICAL_404_TEMPLATE (now django/views/templates/technical_404.html) also logs errors (#26886) without any obvious solution about how to prevent that. Also #28516 shows the many warnings logged for an admin changelist page.
Change History (15)
comment:1 by , 3 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:2 by , 3 years ago
| Owner: | removed |
|---|---|
| Status: | assigned → new |
comment:3 by , 19 months ago
| Cc: | added |
|---|
comment:4 by , 19 months ago
comment:5 by , 6 months ago
| Has patch: | set |
|---|---|
| Owner: | set to |
| Status: | new → assigned |
comment:6 by , 6 months ago
| Patch needs improvement: | set |
|---|
comment:7 by , 6 months ago
| Patch needs improvement: | unset |
|---|
comment:8 by , 6 months ago
| Summary: | Remedy verbose, often unhelpful undefined tempate variable logging → Remedy verbose, often unhelpful undefined template variable logging |
|---|
comment:9 by , 6 months ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
comment:11 by , 6 months ago
| Has patch: | unset |
|---|---|
| Owner: | removed |
| Status: | assigned → new |
| Triage Stage: | Ready for checkin → Accepted |
comment:12 by , 12 days ago
Hi, I’d like to work on this ticket if it’s still available. Please let me know if I can take it.
comment:14 by , 11 days ago
Thanks for the question.
My understanding is that the current logging for undefined template variables can be very verbose and sometimes confusing, especially in cases where missing variables are expected (e.g., optional template context variables).
My proposal is to improve this by making the logging less noisy. For example, we could avoid logging repeated messages for the same undefined variable within a single template render, or adjust the message so it is clearer and more actionable for developers.
I will first investigate where the logging is triggered in the template engine and propose a minimal change that reduces unnecessary verbosity while keeping useful debugging information.
Please let me know if this approach sounds reasonable.
Ticket #35716 is related, possibly a duplicate.