Skip to main content

An easy whitelist-based HTML-sanitizing tool.

Project description

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

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.

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.

skip_pre

Do not create new links inside <pre> sections. Still follows nofollow.

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.0.0.tar.gz (7.9 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for bleach-1.0.0.tar.gz
Algorithm Hash digest
SHA256 392410bbb91b825c8b234340210781217323a889c4e111fa66f1c7d3d6266118
MD5 896ac278b216e93742c21bd1e0dc07af
BLAKE2b-256 6fb52a89874be2a8cb0778a81bcb639682a786420bb5990318e203bf513ecad7

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