#31427: Better support for __html__ in django admin
-----------------------------------------+------------------------
Reporter: Olivier | Owner: nobody
Type: Uncategorized | Status: new
Component: contrib.admin | Version: 3.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: 1 |
-----------------------------------------+------------------------
Django supports custom html representation for objects using the __html__
method (see https://code.djangoproject.com/ticket/7261)
This is supposedly used when trying to display to object as html : if the
object provides an __html__ representation, this is used instead of an
html-escaped version of __str__. This is implemented in
`django.utils.html.conditional_escape`, used in turn by `format_html` (and
similar).
This feature is really nice. It allows for instance to add colors or icons
to the instances representation very consistently., which in some cases
can really help in terms of UX (e.g. color for instance's state).
Unfortunately, this is is only very partially supported in Django admin,
where most of the time, the __str__ representation is used instead.
Currently, the only place where I could see the __html__ used is in the
confirmation message after changing an object ("The object “XYZ” was
changed successfully.).
The __html__ method is not used in :
- the default representation of the changelist (when list_display is not
set)
- the breadcrumbs
- the filters of the changelist
- the select with autocomplete (despite select2 supporting html)
- etc...
I suggest changing this wherever possible in Django admin. It shouldn't be
too big of a change. It's probably mostly replacing str(obj) by
conditional_escape(obj) wherever HTML is admissible.
Long live Django & Django admin :-)
--
Ticket URL: <https://code.djangoproject.com/ticket/31427>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/056.f2559c68637e1f65a0b7811e4acb1747%40djangoproject.com.
