Content - 335d2148288fc15f8f24ce1d53387da772e2c452 - 7e19168/Lib/html/__init__.py

Staging
v0.8.1

visit type:

https://github.com/python/cpython

09 December 2020, 11:06:31 UTC

Tip revision: 09a7df8301bef5a5ac957371ae9e19c68acdca0a authored by Georg Brandl on 19 December 2010, 12:33:52 UTC
#3243 follow-up: remove debugging print and fix docs; data is a bytes object.

Tip revision: 09a7df8

__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
    character (") is also translated.
    """
    if quote:
        return s.translate(_escape_map_full)
    return s.translate(_escape_map)