Giter VIP home page Giter VIP logo

bleach's Introduction

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')
'an <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. Or it is possible to pass a callable instead of a list that accepts name and value of attribute and returns True of False. 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.
parse_email Linkify email addresses with mailto:. Defaults False.

bleach's People

Contributors

erikrose avatar jbalogh avatar markpasc avatar rlr avatar smileychris avatar valueof avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.