Bleach is a whitelist-based HTML sanitizing library that escapes or strips markup and attributes.
Bleach can also linkify text safely, applying filters that Django’s
filter cannot, and optionally setting
rel attributes, even on links already
in the text.
Bleach is intended for sanitizing text from untrusted sources. If you find yourself jumping through hoops to allow your site administrators to do lots of things, you’re probably outside the use cases. Either trust those users, or don’t.
Because it relies on html5lib_, Bleach is as good as modern browsers at dealing with weird, quirky HTML fragments. And any of Bleach’s methods will fix unbalanced or mis-nested tags.
- fixes. You can find full documentation on
- :Code: https://github.com/mozilla/bleach
:Issue tracker: https://github.com/mozilla/bleach/issues
#bleachon irc.mozilla.org :License: Apache License v2; see LICENSE file
on irc.mozilla.org :License: Apache License v2; see LICENSE file
For regular bugs, please report them
in our issue tracker
If you believe that you’ve found a security vulnerability, please
file a secure
bug report in our bug tracker
or send an email to security AT mozilla DOT org.
For more information on security-related bug disclosure and the PGP key to use
for sending encrypted mail or to verify responses received from that address,
please read our wiki page at
Bleach is available on PyPI_, so you can install it with
$ pip install bleach
$ easy_install bleach
Or by cloning the repo from GitHub_::
$ git clone git://github.com/mozilla/bleach.git
Then install it by running::
$ python setup.py install
Before doing any upgrades, read through
<https://bleach.readthedocs.org/en/latest/changes.html>_ for backwards
incompatible changes, newer versions, etc.
The simplest way to use Bleach is:
.. code-block:: python
>>> import bleach >>> bleach.clean('an <script>evil()</script> example') u'an <script>evil()</script> example' >>> bleach.linkify('an http://example.com url') u'an <a href="http://example.com" rel="nofollow">http://example.com</a> url