hmz007
36ed224bac
Signed-off-by: hmz007 <hmz007@gmail.com> Change-Id: Ib87fdbe7a0be7dc961af3500fe9ea4589a127f9f
48 lines
1.1 KiB
ReStructuredText
48 lines
1.1 KiB
ReStructuredText
.. currentmodule:: markupsafe
|
|
|
|
MarkupSafe
|
|
==========
|
|
|
|
MarkupSafe escapes characters so text is safe to use in HTML and XML.
|
|
Characters that have special meanings are replaced so that they display
|
|
as the actual characters. This mitigates injection attacks, meaning
|
|
untrusted user input can safely be displayed on a page.
|
|
|
|
The :func:`escape` function escapes text and returns a :class:`Markup`
|
|
object. The object won't be escaped anymore, but any text that is used
|
|
with it will be, ensuring that the result remains safe to use in HTML.
|
|
|
|
>>> from markupsafe import escape
|
|
>>> hello = escape("<em>Hello</em>")
|
|
>>> hello
|
|
Markup('<em>Hello</em>')
|
|
>>> escape(hello)
|
|
Markup('<em>Hello</em>')
|
|
>>> hello + " <strong>World</strong>"
|
|
Markup('<em>Hello</em> <strong>World</strong>')
|
|
|
|
|
|
Installing
|
|
----------
|
|
|
|
Install and update using `pip`_:
|
|
|
|
.. code-block:: text
|
|
|
|
pip install -U MarkupSafe
|
|
|
|
.. _pip: https://pip.pypa.io/en/stable/quickstart/
|
|
|
|
|
|
Table of Contents
|
|
-----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
escaping
|
|
html
|
|
formatting
|
|
license
|
|
changes
|