Content - 02652ef73c312c9263a3394350c428a1bcbc09fb - 69d202c/Lib/html/__init__.py

Staging
v0.5.1

visit type:

https://github.com/python/cpython

09 December 2020, 11:06:31 UTC

Tip revision: 78abc9dcc2a854cd56c410377449dc50d7f46e3d authored by Georg Brandl on 27 October 2013, 08:41:57 UTC
Skip overzealous test for existence of the online license.html for pre-release versions.

Tip revision: 78abc9d

__init__.py

"""
General functions for HTML manipulation.
"""


_escape_map = {ord('&'): '&amp;', ord('<'): '&lt;', ord('>'): '&gt;'}
_escape_map_full = {ord('&'): '&amp;', ord('<'): '&lt;', ord('>'): '&gt;',
                    ord('"'): '&quot;', ord('\''): '&#x27;'}

# NB: this is a candidate for a bytes/string polymorphic interface

def escape(s, quote=True):
    """
    Replace special characters "&", "<" and ">" to HTML-safe sequences.
    If the optional flag quote is true (the default), the quotation mark
    characters, both double quote (") and single quote (') characters are also
    translated.
    """
    if quote:
        return s.translate(_escape_map_full)
    return s.translate(_escape_map)