mirror of
https://github.com/python/cpython.git
synced 2025-12-23 09:19:18 +00:00
81c975bcfc
Some checks are pending
Tests / Docs (push) Blocked by required conditions
Tests / Windows MSI (push) Blocked by required conditions
Tests / Change detection (push) Waiting to run
Tests / Check if Autoconf files are up to date (push) Blocked by required conditions
Tests / Check if generated files are up to date (push) Blocked by required conditions
Tests / (push) Blocked by required conditions
Tests / Ubuntu SSL tests with OpenSSL (push) Blocked by required conditions
Tests / Ubuntu SSL tests with AWS-LC (push) Blocked by required conditions
Tests / Android (aarch64) (push) Blocked by required conditions
Tests / Android (x86_64) (push) Blocked by required conditions
Tests / WASI (push) Blocked by required conditions
Tests / Hypothesis tests on Ubuntu (push) Blocked by required conditions
Tests / Address sanitizer (push) Blocked by required conditions
Tests / Sanitizers (push) Blocked by required conditions
Tests / Cross build Linux (push) Blocked by required conditions
Tests / CIFuzz (push) Blocked by required conditions
Tests / All required checks pass (push) Blocked by required conditions
Lint / lint (push) Waiting to run
mypy / Run mypy on Lib/_pyrepl (push) Waiting to run
mypy / Run mypy on Lib/test/libregrtest (push) Waiting to run
mypy / Run mypy on Lib/tomllib (push) Waiting to run
mypy / Run mypy on Tools/build (push) Waiting to run
mypy / Run mypy on Tools/cases_generator (push) Waiting to run
mypy / Run mypy on Tools/clinic (push) Waiting to run
mypy / Run mypy on Tools/jit (push) Waiting to run
mypy / Run mypy on Tools/peg_generator (push) Waiting to run
Doc: Clarify html.escape function description (GH-139006)
42 lines
1.4 KiB
ReStructuredText
42 lines
1.4 KiB
ReStructuredText
:mod:`!html` --- HyperText Markup Language support
|
|
==================================================
|
|
|
|
.. module:: html
|
|
:synopsis: Helpers for manipulating HTML.
|
|
|
|
**Source code:** :source:`Lib/html/__init__.py`
|
|
|
|
--------------
|
|
|
|
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 default), the
|
|
characters (``"``) and (``'``) are also translated; this helps for inclusion
|
|
in an HTML attribute value delimited by quotes, as in ``<a href="...">``.
|
|
If *quote* is set to false, the characters (``"``) and (``'``) are not
|
|
translated.
|
|
|
|
|
|
.. versionadded:: 3.2
|
|
|
|
|
|
.. function:: unescape(s)
|
|
|
|
Convert all named and numeric character references (e.g. ``>``,
|
|
``>``, ``>``) in the string *s* to the corresponding Unicode
|
|
characters. This function uses the rules defined by the HTML 5 standard
|
|
for both valid and invalid character references, and the :data:`list of
|
|
HTML 5 named character references <html.entities.html5>`.
|
|
|
|
.. versionadded:: 3.4
|
|
|
|
--------------
|
|
|
|
Submodules in the ``html`` package are:
|
|
|
|
* :mod:`html.parser` -- HTML/XHTML parser with lenient parsing mode
|
|
* :mod:`html.entities` -- HTML entity definitions
|