Skip to content

Commit

Permalink
[1.5.x] Fixed #21316 -- Documented that modifying safe strings makes …
Browse files Browse the repository at this point in the history
…them unsafe.

Thanks dev@simon.net.nz for the suggestion and vijay_shanker for the patch.

Backport of 1edef50 from master
  • Loading branch information
timgraham committed Oct 30, 2013
1 parent 9074d2f commit f832f0d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/ref/utils.txt
Expand Up @@ -746,6 +746,17 @@ appropriate entities.


Can be called multiple times on a single string. Can be called multiple times on a single string.


String marked safe will become unsafe again if modified. For example::

>>> mystr = '<b>Hello World</b> '
>>> mystr = mark_safe(mystr)
>>> type(mystr)
<class 'django.utils.safestring.SafeBytes'>

>>> mystr = mystr.strip() # removing whitespace
>>> type(mystr)
<type 'str'>

.. function:: mark_for_escaping(s) .. function:: mark_for_escaping(s)


Explicitly mark a string as requiring HTML escaping upon output. Has no Explicitly mark a string as requiring HTML escaping upon output. Has no
Expand Down

0 comments on commit f832f0d

Please sign in to comment.