An easy whitelist-based HTML-sanitizing tool.
Bleach is an HTML sanitizing library that escapes or strips markup and attributes based on a white list. Bleach can also linkify text safely, applying filters that Django’s urlize 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.
Reporting Security Issues
If you believe you have found an exploit in a patched version of Bleach, master or the latest released version on PyPI, please do not post it in a GitHub issue. Please contact me privately, at email@example.com <mailto:firstname.lastname@example.org>.
The simplest way to use Bleach is:
>>> 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
NB: Bleach always returns a unicode object, whether you give it a bytestring or a unicode object, but Bleach does not attempt to detect incoming character encodings, and will assume UTF-8. If you are using a different character encoding, you should convert from a bytestring to unicode before passing the text to Bleach.
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size bleach-1.4.3-py2-none-any.whl (22.2 kB)||File type Wheel||Python version py2||Upload date||Hashes View hashes|
|Filename, size bleach-1.4.3.tar.gz (18.1 kB)||File type Source||Python version None||Upload date||Hashes View hashes|