Skip to main content

An easy whitelist-based HTML-sanitizing tool.

Project description

https://travis-ci.org/jsocol/bleach.png?branch=master https://badge.fury.io/py/Bleach.svg

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.

The version on GitHub is the most up-to-date and contains the latest bug fixes. You can find full documentation on ReadTheDocs.

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 me+bleach@jamessocol.com <mailto:me+bleach@jamessocol.com>.

Basic Use

The simplest way to use Bleach is:

>>> import bleach

>>> bleach.clean('an <script>evil()</script> example')
u'an &lt;script&gt;evil()&lt;/script&gt; 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.

Installation

Bleach is available on PyPI, so you can install it with pip:

$ pip install bleach

Or with easy_install:

$ easy_install bleach

Or by cloning the repo from GitHub:

$ git clone git://github.com/jsocol/bleach.git

Then install it by running:

$ python setup.py install

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bleach-1.4.3.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

bleach-1.4.3-py2-none-any.whl (22.2 kB view details)

Uploaded Python 2

File details

Details for the file bleach-1.4.3.tar.gz.

File metadata

  • Download URL: bleach-1.4.3.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for bleach-1.4.3.tar.gz
Algorithm Hash digest
SHA256 1293061adb5a9eebb7b260516e691785ac08cc1646c8976aeda7db9dbb1c6f4b
MD5 57d08deb9a090ab4b5ee69bd4968fce3
BLAKE2b-256 e0e08c5cc2822d2035d64cf7b4278077a7ec1e0afde7e9051128f722ec8cd97a

See more details on using hashes here.

File details

Details for the file bleach-1.4.3-py2-none-any.whl.

File metadata

File hashes

Hashes for bleach-1.4.3-py2-none-any.whl
Algorithm Hash digest
SHA256 75bb62077ad33f8d57fb783267b062a8a0662d2ded8398b8c0098a06b6f466cc
MD5 857e7c162828d38070fbb881a4359816
BLAKE2b-256 3908341c427627d0f3a56b38804ab26960287d843ebf8be5156be22cec702847

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page