Provide a better repr() experience

[Keryn Knight]

For a long time, Django has shipped with the debug 500 handler, which defaults to a view where "local vars" for every stack frame can be expanded and inspected to see the internal state at the various points in the stack trace.

Between that renderer, the heavy usage of django-debug-toolbar, which ships with a template context inspector, and my preference throwing pdb everywhere, there is a notable lack of a good repr() experience in much of Django, both in debugging public API (that is, the bits a user will use and encounter), and internals that might be exposed, or could otherwise be served better by having a repr that says something more than it's address/id.

A couple of previous tickets have addressed this in minor, one off ways - #23167, #22906, #22531 - but as I've begun collecting places they could supply useful info as I spot them in my stuff, they've become a hodgepodge across a number of modules.

For example, a couple I've got implemented:

<TemplateResponse status_code=200, charset=utf-8, _is_rendered=False>

<LoaderOrigin name=/absolute/path/to/templates/admin/change_list.html, loadname=admin/change_list.html>

<FilterExpression var=u'admin/change_list.html', filters=[]>

All of which, IMHO, provide a more useful context in which to evaluate state.

The branch I have implemented my reprs in is in no way merge ready yet, partially because there's no tests, and it'd need rebasing & squashing, but also because there are some parts I'd like to see reprs on but haven't landed on a good way to do so.
An example being the concept of a Loader, which currently has no repr() and thus shows up as <path.to.cached.Loader … 0xETC> which at least tells us which loader is being referenced. Given the convention so far for reprs() is just the class name (rather than module + class), the fact all Loaders (and now Engines) all share the same class name means in exposing more useful internal state we lose knowledge of the loader in question's module namespace.

As I write this, I've got at least rudimentary (as in, it was possibly to replace the 0x... with at least one object-state variable) reprs for:

• StaticNode added in e6406853c326ea9210d07766138d2b193c6d1fba
• BlockTranslateNode added in 66ed03e7c9ae4cd754aa918c6f4c9227cf424141
• URLNode added in d3ecef26b9fda02b88f925a800ae38dd5873c878
• Token added in 179ee13eb37348cd87169a198aec18fedccc8668
• Lexer added in 179ee13eb37348cd87169a198aec18fedccc8668
• Parser added in 179ee13eb37348cd87169a198aec18fedccc8668
• FilterExpression added in 179ee13eb37348cd87169a198aec18fedccc8668
• MiddlewareMixin, RedirectFallbackMiddleware, MessageMiddleware, RemoteUserMiddleware, CsrfViewMiddleware added in dc86a25a677d05703e0bb021b178e44412cea7e9
• Col added in 7171bf755b0c4be85ddbcc164eaf87164c131021
• Lookup added in d3d95d645fc9f36355d27598475612de43587db1
• BaseDatabaseWrapper ​PR
• SQLCompiler ​PR
• JoinPromoter ​PR
• HttpResponse, HttpResponseRedirect, HttpResponseNotAllowed added in c96f11257baf43188ff9daeddab3221992925c85
• LazySettings, Settings, and UserSettingsHolder added in 9c40f01a66bd15457e10a0bbf28c803968b5dabb
• GeoIP2 added in d4b10a725614322769a419180039771634a06571
• PermWrapper added in 22da686ca93e99f8091334f66d7199bc29b85c83
• BaseStorage added in 7dd502b0e1e7d3e7fa2c5a2d54bbc926dbcf5f92
• ChangeList added in 7dd502b0e1e7d3e7fa2c5a2d54bbc926dbcf5f92
• AdminForm added in 66ed03e7c9ae4cd754aa918c6f4c9227cf424141
• SimpleTemplateResponse added in c96f11257baf43188ff9daeddab3221992925c85
• TemplateResponse added in c96f11257baf43188ff9daeddab3221992925c85
• AdminSite ​PR
• ModelAdmin ​PR
• Origin added in 4f4f770f77c5d720484c0a71f6a19b9affcc7e28
• Template added in 4f4f770f77c5d720484c0a71f6a19b9affcc7e28
• BlockContext added in 66ed03e7c9ae4cd754aa918c6f4c9227cf424141
• IncludeNode added in 66ed03e7c9ae4cd754aa918c6f4c9227cf424141
• Engine added in c609d5149c9295207cd7b2e8154e7b80a18d834a
• OrderedSet added in afb0eb8bb3e1c6f7ea842d2cede684eb4aec3f3d

*StreamingHttpResponse ​PR

If accepted, this ticket could just track whatever I can end up getting reviewed/merged, or it could be a meta-ticket for accepting as a principle, and I could spin off tickets for more targeted areas.

[Berker Peksag]

<TemplateResponse status_code=200, charset=utf-8, _is_rendered=False>

<LoaderOrigin name=/absolute/path/to/templates/admin/change_list.html, loadname=admin/change_list.html>

<FilterExpression var=u'admin/change_list.html', filters=[]>

charset, name and loadname should also be a string.

<TemplateResponse status_code=200, charset='utf-8', _is_rendered=False>

<LoaderOrigin name='/absolute/path/to/templates/admin/change_list.html', loadname='admin/change_list.html'>

Here's an example from Python:

>>> open('README')
<_io.TextIOWrapper name='README' mode='r' encoding='UTF-8'>

[Tim Graham <timograham@…>]

In c96f112:

Refs #24121 -- Added meaningful repr() to HttpResponse and subclasses.

[Tim Graham <timograham@…>]

In 9c40f01a:

Refs #24121 -- Added repr() to LazySettings, Settings, and UserSettingsHolder.

[Tim Graham <timograham@…>]

In d4b10a72:

Refs #24121 -- Added a repr() to gis.GeoIP and gis.GeoIP2.

[David Smith]

Marking as easy pickings as I think this can be achieved in stages -- I'm not expecting someone to propose a PR that addresses all of these in one go!

[Rohith P R]

In ​https://github.com/django/django/pull/14045: Refs #24121 -- Added repr to django.template.defaulttags.URLNode

[Mariusz Felisiak <felisiak.mariusz@…>]

In 179ee13:

Refs #24121 -- Added repr() to FilterExpression, Lexer, Parser, and Token.

[Mariusz Felisiak <felisiak.mariusz@…>]

In d3ecef26:

Refs #24121 -- Added repr() to URLNode.

[Nick Pope]

​PR

[GitHub <noreply@…>]

In afb0eb8:

Refs #24121 -- Added repr() to OrderedSet.

[Mariusz Felisiak <felisiak.mariusz@…>]

In dc86a25a:

Refs #24121 -- Added repr() to MiddlewareMixin and subclasses.

[Jonny Park]

Query Does not have __repr__ as well. Doesn't it need one?

Ah I just found it has __str__

[tiagohonorato]

Added repr() to Origin ​https://github.com/django/django/pull/14119

[Mariusz Felisiak <felisiak.mariusz@…>]

In 4f4f770:

Refs #24121 -- Added repr() to Origin and Template.

[Mariusz Felisiak <felisiak.mariusz@…>]

In e6406853:

Refs #24121 -- Addedrepr() to StaticNode.

[Mariusz Felisiak <felisiak.mariusz@…>]

In f0a9413b:

Refs #24121 -- Improved Value.repr().

[Mariusz Felisiak <felisiak.mariusz@…>]

In d3d95d6:

Refs #24121 -- Added repr() to Lookup.

[Mariusz Felisiak <felisiak.mariusz@…>]

In 22da686c:

Refs #24121 -- Added repr() to PermWrapper.

[Mariusz Felisiak <felisiak.mariusz@…>]

In c609d514:

Refs #24121 -- Added repr() to Engine

[Mariusz Felisiak <felisiak.mariusz@…>]

In 7dd502b:

Refs #24121 -- Added repr() to ChangeList and BaseStorage.

[Mariusz Felisiak <felisiak.mariusz@…>]

In 66ed03e:

Refs #24121 -- Added repr() to AdminForm, BlockContext, BlockTranslateNode, and IncludeNode.

[Nicolás Restrepo]

add StreamingHttpResponse repr() method => ​https://github.com/django/django/pull/14531