| |
| |
| .. function:: escape(data[, entities]) |
| |
| Escape ``'&'``, ``'<'``, and ``'>'`` in a string of data. |
| |
| You can escape other strings of data by passing a dictionary as the optional |
| *entities* parameter. The keys and values must all be strings; each key will be |
n | replaced with its corresponding value. |
n | replaced with its corresponding value. The characters ``'&'``, ``'<'`` and |
| ``'>'`` are always escaped, even if *entities* is provided. |
| |
| |
| .. function:: unescape(data[, entities]) |
| |
| Unescape ``'&'``, ``'<'``, and ``'>'`` in a string of data. |
| |
| You can unescape other strings of data by passing a dictionary as the optional |
| *entities* parameter. The keys and values must all be strings; each key will be |
n | replaced with its corresponding value. |
n | replaced with its corresponding value. ``'&'``, ``'<'``, and ``'>'`` |
| are always unescaped, even if *entities* is provided. |
| |
| .. versionadded:: 2.3 |
| |
| |
| .. function:: quoteattr(data[, entities]) |
| |
t | Similar to :func:`escape`, but also prepares *data* to be used as an attribute |
t | Similar to :func:`escape`, but also prepares *data* to be used as an |
| value. The return value is a quoted version of *data* with any additional |
| attribute value. The return value is a quoted version of *data* with any |
| required replacements. :func:`quoteattr` will select a quote character based on |
| additional required replacements. :func:`quoteattr` will select a quote |
| the content of *data*, attempting to avoid encoding any quote characters in the |
| character based on the content of *data*, attempting to avoid encoding any |
| string. If both single- and double-quote characters are already in *data*, the |
| quote characters in the string. If both single- and double-quote characters |
| double-quote characters will be encoded and *data* will be wrapped in double- |
| are already in *data*, the double-quote characters will be encoded and *data* |
| quotes. The resulting string can be used directly as an attribute value:: |
| will be wrapped in double-quotes. The resulting string can be used directly |
| as an attribute value:: |
| |
| >>> print "<element attr=%s>" % quoteattr("ab ' cd \" ef") |
| <element attr="ab ' cd " ef"> |
| |
| This function is useful when generating attribute values for HTML or any SGML |
| using the reference concrete syntax. |
| |
| .. versionadded:: 2.2 |