bleach

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.

The version on github is the most up-to-date and contains the latest bug fixes.

Basic Use

The simplest way to use Bleach is:

>>> import bleach

>>> bleach.clean('an <script>evil()</script> example')
'an &lt;script&gt;evil()&lt;/script&gt; example'

>>> bleach.linkify('an http://example.com url')
'a <a href="http://example.com" rel="nofollow">http://example.com</a> url

If you’re going to be cleaning a number of strings, it may be more efficient to instantiate your own Bleach instance:

>>> from bleach import Bleach

>>> b = Bleach()

>>> b.clean('an <script>evil()</script> example')
'an &lt;script&gt;evil()&lt;/script&gt; example'

Customizing Bleach

Both clean() and linkify() can take several optional keyword arguments to customize their behavior.

clean()

tags	A whitelist of HTML tags. Must be a list. Defaults to bleach.ALLOWED_TAGS.
attributes	A whitelist of HTML attributes. Either a list, in which case all attributes are allowed on all elements, or a dict, with tag names as keys and lists of allowed attributes as values. Defaults to bleach.ALLOWED_ATTRIBUTES.
styles	A whitelist of allowed CSS properties within a style attribute. (Note that style attributes are not allowed by default.) Must be a list. Defaults to [].
strip	Strip disallowed HTML instead of escaping it. A boolean. Defaults to False.
strip_comments	Strip HTML comments. A boolean. Defaults to True.

linkify()

nofollow	Add rel="nofollow" to non-relative links (both created by linkify() and those already present in the text). Defaults to True.
nofollow_relative	Add rel="nofollow" to relative links (starting with /) in the text. Defaults to False.
filter_url	A callable through which the href attribute of links (both created by linkify() and already present in the text) will be passed. Must accept a single argument and return a string.
filter_text	A callable through which the text of links (only those created by linkify) will be passed. Must accept a single argument and return a string.

Metadata

Release files for bleach 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bleach 0.5.0
File	Size	Uploaded
bleach-0.5.0.tar.gz	8.2 kB	Jan 16, 2011	Details

Release files / bleach-0.5.0.tar.gz

Download URL	bleach-0.5.0.tar.gz
Size	8.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`bafa043fc0bb24f76200a902b107346f74932fb6a2d9b66961d9e2eb0dcfd609`
BLAKE2b-256 checksum How to use checksums	`6bfecef8f1dd370e56f63b6ad61137fc237dc0a87b8251b61c3fe9f318bb841d`
Upload date	Jan 16, 2011
Uploaded using Trusted Publishing? What is trusted publishing?	No