diff options
| author | Georg Brandl <georg@python.org> | 2010-10-15 15:57:45 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-10-15 15:57:45 (GMT) |
| commit | 1f7fffb308390d10a2c6a4ec624f18cfeef97aeb (patch) | |
| tree | 65e2437904ba089004c69c77b49e5059623b83fb /Doc/library/html.rst | |
| parent | 70543acfa1bce2e5f448d8d0085df595bfa9a2f9 (diff) | |
| download | cpython-1f7fffb308390d10a2c6a4ec624f18cfeef97aeb.zip cpython-1f7fffb308390d10a2c6a4ec624f18cfeef97aeb.tar.gz cpython-1f7fffb308390d10a2c6a4ec624f18cfeef97aeb.tar.bz2 | |
#2830: add html.escape() helper and move cgi.escape() uses in the standard library to it. It defaults to quote=True and also escapes single quotes, which makes casual use safer. The cgi.escape() interface is not touched, but emits a (silent) PendingDeprecationWarning.
Diffstat (limited to 'Doc/library/html.rst')
| -rw-r--r-- | Doc/library/html.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/Doc/library/html.rst b/Doc/library/html.rst new file mode 100644 index 0000000..2c42cf8 --- /dev/null +++ b/Doc/library/html.rst @@ -0,0 +1,18 @@ +:mod:`html` --- HyperText Markup Language support +================================================= + +.. module:: html + :synopsis: Helpers for manipulating HTML. + +.. versionadded:: 3.2 + + +This module defines utilities to manipulate HTML. + +.. function:: escape(s, quote=True) + + Convert the characters ``&``, ``<`` and ``>`` in string *s* to HTML-safe + sequences. Use this if you need to display text that might contain such + characters in HTML. If the optional flag *quote* is true, the characters + (``"``) and (``'``) are also translated; this helps for inclusion in an HTML + attribute value delimited by quotes, as in ``<a href="...">``. |