[Django] #28935: Template error raised in an {% extends %} child template shows incorrect source location on debug page
Django
source location on debug page
-----------------------------------------+------------------------
Reporter: Matt Westcott | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 2.0
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
If an error occurs in the processing of a template tag on a template that
extends another via `{% extends %}`, the "Error during template rendering"
section of the debug page incorrectly shows an excerpt from the parent
template rather than the child.
To reproduce:
base.html:
{{{
{% block body %}{% endblock %}
}}}
home.html:
{{{
{% extends "base.html" %}
{% block body %}
{% include "does_not_exist" %}
{% endblock %}
}}}
views.py:
{{{
from django.shortcuts import render
def home(request):
return render(request, 'home.html')
}}}
The resulting error page displays:
{{{
Error during template rendering
In template
/Users/matthew/Development/tbx/wagtail/debug/brokendebug/core/templates/base.html,
error at line 0
does_not_exist
1 {% block body %}{% endblock %}
2
}}}
instead of the expected error output:
{{{
Error during template rendering
In template
/Users/matthew/Development/tbx/wagtail/debug/brokendebug/core/templates/home.html,
error at line 4
does_not_exist
1 {% extends "base.html" %}
2
3 {% block body %}
4 {% include "does_not_exist" %}
5 {% endblock %}
6
}}}
Bisecting shows that this bug was introduced in #27956
(e643ba8bcf0b1da517cbab689ac157ee031202a3), which was a fix for the
''opposite'' case: an error occurring on the parent template. (In the
above test case, moving the line `{% include "does_not_exist" %}` to
base.html turns it into a test case for #27956, and fails on pre-
e643ba8bcf0b1da517cbab689ac157ee031202a3 revisions as expected.)
--
Ticket URL: <https://code.djangoproject.com/ticket/28935>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
source location on debug page
Reporter: Matt Westcott | Owner: nobody
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* cc: Preston Timmons (added)
* component: Uncategorized => Template system
* type: Uncategorized => Bug
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:1>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Alexander
| Vyushkov
Type: Bug | Status: assigned
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Alexander Vyushkov):
* status: new => assigned
* owner: nobody => Alexander Vyushkov
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:2>
Django
source location on debug page
Reporter: Matt Westcott | Owner: (none)
Type: Bug | Status: new
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Alexander Vyushkov):
* owner: Alexander Vyushkov => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:3>
Django
source location on debug page
Reporter: Matt Westcott | Owner: (none)
Type: Bug | Status: new
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Collin Anderson):
* cc: Collin Anderson (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:4>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Ankur Jain
Type: Bug | Status: assigned
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Ankur Jain):
* owner: (none) => Ankur Jain
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:5>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Ankur Jain
Type: Bug | Status: assigned
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Ankur Jain):
When the parser runs then it appends all the child template nodes to the
parent template nodes and hence when template not found error comes then
it's reported from the parent html instead of the child html.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:6>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Ankur Jain
Type: Bug | Status: assigned
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Simon Charette):
#29740 was a duplicate.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:7>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Ankur Jain
Type: Bug | Status: assigned
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Michael F. Lamb):
Replying to [comment:6 Ankur Jain]:
Hi, I'm interested in working on this bug. Are you still working on it,
Ankur?
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:8>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Ankur Jain
Type: Bug | Status: assigned
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by pascal chambon):
* cc: pascal chambon (added)
Comment:
Error confirmed on Django2.2.1, it makes the debug page much less helpful
in case of TemplateError, since most websites inherit their templates from
some kind of "base.html" skeleton.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:9>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Ankur Jain
Type: Bug | Status: assigned
Component: Template system | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Simone Lazzaris):
Bug still present in 2.2.3; if you (like me) use a tree-structured number
of small template files it is very VERY annoying as you have to guess
where the bug you're chasing is between the various parts.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:10>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Ankur Jain
Type: Bug | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Simone Lazzaris):
* cc: Simone Lazzaris (added)
* version: 2.0 => 2.2
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:11>
Django
source location on debug page
Reporter: Matt Westcott | Owner: (none)
Type: Bug | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by felixxm):
* owner: Ankur Jain => (none)
* status: assigned => new
* version: 2.2 => master
Comment:
Simone, patch is welcome.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:12>
Django
source location on debug page
Reporter: Matt Westcott | Owner: (none)
Type: Bug | Status: new
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Min ho Kim):
* cc: Min ho Kim (added)
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:13>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Min ho Kim
Type: Bug | Status: assigned
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Min ho Kim):
* owner: (none) => Min ho Kim
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:14>
Django
source location on debug page
Reporter: Matt Westcott | Owner: (none)
Type: Bug | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Min ho Kim):
* owner: Min ho Kim => (none)
* status: assigned => new
Comment:
I'm deassigning myself for now so someone else can have a go until I can
come back in the future.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:15>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Ashutosh
| Sharma
Type: Bug | Status: assigned
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Ashutosh Sharma):
* owner: (none) => Ashutosh Sharma
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:16>
Django
source location on debug page
Reporter: Matt Westcott | Owner: (none)
Type: Bug | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Ashutosh Sharma):
* owner: Ashutosh Sharma => (none)
* status: assigned => new
Comment:
I couldn't find a way to fix this bug. Deassigning so someone else can
have a try.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:17>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Zahid92
Type: Bug | Status: assigned
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Zahid92):
* owner: (none) => Zahid92
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:18>
Django
source location on debug page
Reporter: Matt Westcott | Owner: Zahid
| Hussain Ansari
Type: Bug | Status: assigned
Component: Template system | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by felixxm):
#31478 was a duplicate.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:19>
Django
source location on debug page
Reporter: Matt Westcott | Owner: (none)
Type: Bug | Status: new
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* owner: Zahid Hussain Ansari => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:20>
Django
source location on debug page
Reporter: Matt Westcott | Owner: cammil
Type: Bug | Status: assigned
Component: Template system | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by cammil):
* owner: (none) => cammil
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:21>
Django
source location on debug page
Reporter: Matt Westcott | Owner: cammil
Type: Bug | Status: assigned
Component: Template system | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by cammil):
Think I have an idea how to fix this. Going to do some more testing to
make sure.
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:22>
Django
source location on debug page
Reporter: Matt Westcott | Owner: cammil
Type: Bug | Status: assigned
Component: Template system | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by cammil):
I've created a PR:
https://github.com/django/django/compare/main...cammil:ticket_27694
Does anyone have any comments or feedback?
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:23>
Django
source location on debug page
Reporter: Matt Westcott | Owner: cammil
Type: Bug | Status: assigned
Component: Template system | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by cammil):
* cc: cammil (added)
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:24>
Django
source location on debug page
Reporter: Matt Westcott | Owner: cammil
Type: Bug | Status: assigned
Component: Template system | Version: dev
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:25>
Django
source location on debug page
-------------------------------------+-------------------------------------
Reporter: Matt Westcott | Owner: cammil
Component: Template system | Version: dev
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"313c3d1aa14d80922003f841c257ec4e153f8653" 313c3d1]:
{{{
#!CommitTicketReference repository=""
revision="313c3d1aa14d80922003f841c257ec4e153f8653"
Fixed #28935 -- Fixed display of errors in extended blocks.
Get the template that caused the exception and get the
exception info from that template, using the node that
caused the exception.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28935#comment:26>