Refs #27753 -- Deprecated django.utils.text.unescape_entities(). #11277
Conversation
There was a problem hiding this comment.
The code changes look good to me FWIW.
A GitHub code search shows that the function is inevitably used by some projects: https://github.com/search?q=django+unescape_entities&type=Code. So maybe it'd be nice to keep unescape_entities around for one deprecation cycle (just calling html.unescape)?
jdufresne
changed the title
|
Thanks for the review. As suggested, I've changed the PR to simply deprecate the function rather than removing it. I also added a note about lazy strings. |
|
@jdufresne Thanks for this PR 👍 Please add also a note to the |
|
Done. 🙂 |
docs/releases/3.0.txt
Outdated
| @@ -411,6 +411,9 @@ Miscellaneous | |||
| * ``alias=None`` is added to the signature of | |||
| :meth:`.Expression.get_group_by_cols`. | |||
|
|
|||
| * ``django.utils.text.unescape_entities()`` is deprecated in favor of | |||
| :func:`html.unescape`. For lazy strings, first coerce using ``str()``. | |||
There was a problem hiding this comment.
For lazy strings, first coerce using
str()
That's not exactly right. With unescape_entities, given a lazy string, it is not evaluated immediately, but returns a lazy string which will unescape when it is evaluated. With html.unescape, the argument is evaluated immediately and a string is returned.
If you want to keep a note, I'd say "Note that unlike django.utils.text.unescape_entities(), html.unescape will evaluate lazy strings immediately".
There was a problem hiding this comment.
Excellent point. I've used your wording in the latest revision.
The function was undocumented and only required for compatibility with Python 2. Code should use Python's html.unescape() that was added in Python 3.4.
The function was undocumented and only required for compatibility with Python 2.
Use Python's html.unescape() instead -- available since Python 3.4.
https://docs.python.org/3/library/html.html#html.unescape
https://code.djangoproject.com/ticket/27753