Opened 6 months ago

Closed 6 months ago

Last modified 6 months ago

#32681 closed Bug (fixed)

Variable lookup errors are logged rendering the admin index page if subtitle is not defined.

Reported by: Zain Patel Owned by: Zain Patel
Component: contrib.admin Version: 3.2
Severity: Release blocker Keywords: admin, template
Cc: Jon Dufresne Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Zain Patel)

This looks like a bug introduced in Django 3.2 with the introduction of a new variable introduced in the base templates (django/contrib/admin/templates/base_site.html) named subtitle. This variable is passed in most places within the admin site, e.g in django/contrib/admin/options.py

Loading the admin index page with log-level debug shows the following exception/stack trace (that admittedly does not affect anything functional - simply clutters the logs):

Exception while resolving variable 'subtitle' in template 'admin/index.html'.
Traceback (most recent call last):
  File "...lib/python3.7/site-packages/django/template/base.py", line 829, in _resolve_lookup
    current = current[bit]
  File "...lib/python3.7/site-packages/django/template/context.py", line 83, in __getitem__
    raise KeyError(key)
KeyError: 'subtitle'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "...lib/python3.7/site-packages/django/template/base.py", line 835, in _resolve_lookup
    if isinstance(current, BaseContext) and getattr(type(current), bit):
AttributeError: type object 'RequestContext' has no attribute 'subtitle'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "...lib/python3.7/site-packages/django/template/base.py", line 843, in _resolve_lookup
    current = current[int(bit)]
ValueError: invalid literal for int() with base 10: 'subtitle'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "...lib/python3.7/site-packages/django/template/base.py", line 850, in _resolve_lookup
    (bit, current))  # missing attribute
django.template.base.VariableDoesNotExist: Failed lookup for key [subtitle] in

I believe this can be fixed by providing subtitle: None in the AdminSite.each_context` method to default it to that. I am happy to create a PR for this.

On second though - instead of hardcoding subtitle to None - potentially it should be a customisable option in the AdminSite itself, so:

class MySite(AdminSite):
  site_header = "blah"
  subtitle = "my subtitle"

?

Change History (10)

comment:1 Changed 6 months ago by Zain Patel

Description: modified (diff)

comment:2 Changed 6 months ago by Zain Patel

Description: modified (diff)

comment:3 Changed 6 months ago by Zain Patel

Potential fix as described in my ticket here: https://github.com/django/django/pull/14308

comment:4 Changed 6 months ago by Zain Patel

Has patch: set

comment:5 Changed 6 months ago by Mariusz Felisiak

Cc: Jon Dufresne added
Needs documentation: set
Needs tests: set
Owner: changed from nobody to Zain Patel
Severity: NormalRelease blocker
Status: newassigned
Summary: 'subtitle' missing from admin context on index pageVariable lookup errors are logged rendering the admin index page if subtitle is not defined.

Thanks for the report.

Regression in 84609b3205905097d7d3038d32e6101f012c0619.

comment:6 Changed 6 months ago by Mariusz Felisiak

Triage Stage: UnreviewedAccepted

comment:7 Changed 6 months ago by Zain Patel

Needs documentation: unset
Needs tests: unset

comment:8 Changed 6 months ago by Mariusz Felisiak

Triage Stage: AcceptedReady for checkin

comment:9 Changed 6 months ago by Mariusz Felisiak <felisiak.mariusz@…>

Resolution: fixed
Status: assignedclosed

In 4e5bbb6e:

Fixed #32681 -- Fixed VariableDoesNotExist when rendering some admin template.

Regression in 84609b3205905097d7d3038d32e6101f012c0619.

comment:10 Changed 6 months ago by Mariusz Felisiak <felisiak.mariusz@…>

In 0dfe88e:

[3.2.x] Fixed #32681 -- Fixed VariableDoesNotExist when rendering some admin template.

Regression in 84609b3205905097d7d3038d32e6101f012c0619.

Backport of 4e5bbb6ef2287126badd32842b239f4a8a7394ca from main.

Note: See TracTickets for help on using tickets.
Back to Top