104 lines
3.5 KiB
Plaintext
104 lines
3.5 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: MarkupSafe
|
|
Version: 1.1.1
|
|
Summary: Safely add untrusted strings to HTML/XML markup.
|
|
Home-page: https://palletsprojects.com/p/markupsafe/
|
|
Author: Armin Ronacher
|
|
Author-email: armin.ronacher@active-4.com
|
|
Maintainer: The Pallets Team
|
|
Maintainer-email: contact@palletsprojects.com
|
|
License: BSD-3-Clause
|
|
Project-URL: Documentation, https://markupsafe.palletsprojects.com/
|
|
Project-URL: Code, https://github.com/pallets/markupsafe
|
|
Project-URL: Issue tracker, https://github.com/pallets/markupsafe/issues
|
|
Platform: UNKNOWN
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Environment :: Web Environment
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: BSD License
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 2
|
|
Classifier: Programming Language :: Python :: 2.7
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.4
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Classifier: Topic :: Text Processing :: Markup :: HTML
|
|
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
|
|
|
|
MarkupSafe
|
|
==========
|
|
|
|
MarkupSafe implements a text object that escapes characters so it 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.
|
|
|
|
|
|
Installing
|
|
----------
|
|
|
|
Install and update using `pip`_:
|
|
|
|
.. code-block:: text
|
|
|
|
pip install -U MarkupSafe
|
|
|
|
.. _pip: https://pip.pypa.io/en/stable/quickstart/
|
|
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. code-block:: pycon
|
|
|
|
>>> from markupsafe import Markup, escape
|
|
>>> # escape replaces special characters and wraps in Markup
|
|
>>> escape('<script>alert(document.cookie);</script>')
|
|
Markup(u'<script>alert(document.cookie);</script>')
|
|
>>> # wrap in Markup to mark text "safe" and prevent escaping
|
|
>>> Markup('<strong>Hello</strong>')
|
|
Markup('<strong>hello</strong>')
|
|
>>> escape(Markup('<strong>Hello</strong>'))
|
|
Markup('<strong>hello</strong>')
|
|
>>> # Markup is a text subclass (str on Python 3, unicode on Python 2)
|
|
>>> # methods and operators escape their arguments
|
|
>>> template = Markup("Hello <em>%s</em>")
|
|
>>> template % '"World"'
|
|
Markup('Hello <em>"World"</em>')
|
|
|
|
|
|
Donate
|
|
------
|
|
|
|
The Pallets organization develops and supports MarkupSafe and other
|
|
libraries that use it. In order to grow the community of contributors
|
|
and users, and allow the maintainers to devote more time to the
|
|
projects, `please donate today`_.
|
|
|
|
.. _please donate today: https://palletsprojects.com/donate
|
|
|
|
|
|
Links
|
|
-----
|
|
|
|
* Website: https://palletsprojects.com/p/markupsafe/
|
|
* Documentation: https://markupsafe.palletsprojects.com/
|
|
* License: `BSD-3-Clause <https://github.com/pallets/markupsafe/blob/master/LICENSE.rst>`_
|
|
* Releases: https://pypi.org/project/MarkupSafe/
|
|
* Code: https://github.com/pallets/markupsafe
|
|
* Issue tracker: https://github.com/pallets/markupsafe/issues
|
|
* Test status:
|
|
|
|
* Linux, Mac: https://travis-ci.org/pallets/markupsafe
|
|
* Windows: https://ci.appveyor.com/project/pallets/markupsafe
|
|
|
|
* Test coverage: https://codecov.io/gh/pallets/markupsafe
|
|
|
|
|