Bleach

----------------------------------

**Security fixes**

None

**Backwards incompatible changes**

None

**Features**

None

**Bug fixes**

* Support html5lib-python 1.0.1. (337)

* Add deprecation warning for supporting html5lib-python < 1.0.

* Switch to semver.

---------------------------------

**Security fixes**

None

**Backwards incompatible changes**

None

**Features**

None

**Bug fixes**

* Fix ``setup.py`` opening files when ``LANG=``. (324)

----------------------------------

**Security fixes**

* Convert control characters (backspace particularly) to "?" preventing
malicious copy-and-paste situations. (298)

See `<https://github.com/mozilla/bleach/issues/298>`_ for more details.

This affects all previous versions of Bleach. Check the comments on that
issue for ways to alleviate the issue if you can't upgrade to Bleach 2.1.


**Backwards incompatible changes**

* Redid versioning. ``bleach.VERSION`` is no longer available. Use the string
version at ``bleach.__version__`` and parse it with
``pkg_resources.parse_version``. (307)

* clean, linkify: linkify and clean should only accept text types; thank you,
Janusz! (292)

* clean, linkify: accept only unicode or utf-8-encoded str (176)


**Features**


**Bug fixes**

* ``bleach.clean()`` no longer unescapes entities including ones that are missing
a ``;`` at the end which can happen in urls and other places. (143)

* linkify: fix http links inside of mailto links; thank you, sedrubal! (300)

* clarify security policy in docs (303)

* fix dependency specification for html5lib 1.0b8, 1.0b9, and 1.0b10; thank you,
Zoltán! (268)

* add Bleach vs. html5lib comparison to README; thank you, Stu Cox! (278)

* fix KeyError exceptions on tags without href attr; thank you, Alex Defsen!
(273)

* add test website and scripts to test ``bleach.clean()`` output in browser;
thank you, Greg Guthe!

-----------------------------

**Security fixes**

* None


**Backwards incompatible changes**

* Removed support for Python 2.6. (206)

* Removed support for Python 3.2. (224)

* Bleach no longer supports html5lib < 0.99999999 (8 9s).

This version is a rewrite to use the new sanitizing API since the old
one was dropped in html5lib 0.99999999 (8 9s).

If you're using 0.9999999 (7 9s) upgrade to 0.99999999 (8 9s) or higher.

If you're using 1.0b8 (equivalent to 0.9999999 (7 9s)), upgrade to 1.0b9
(equivalent to 0.99999999 (8 9s)) or higher.

* ``bleach.clean`` and friends were rewritten

``clean`` was reimplemented as an html5lib filter and happens at a different
step in the HTML parsing -> traversing -> serializing process. Because of
that, there are some differences in clean's output as compared with previous
versions.

Amongst other things, this version will add end tags even if the tag in
question is to be escaped.

* ``bleach.clean`` and friends attribute callables now take three arguments:
tag, attribute name and attribute value. Previously they only took attribute
name and attribute value.

All attribute callables will need to be updated.

* ``bleach.linkify`` was rewritten

``linkify`` was reimplemented as an html5lib Filter. As such, it no longer
accepts a ``tokenizer`` argument.

The callback functions for adjusting link attributes now takes a namespaced
attribute.

Previously you'd do something like this::

def check_protocol(attrs, is_new):
if not attrs.get('href', '').startswith('http:', 'https:')):
return None
return attrs

Now it's more like this::

def check_protocol(attrs, is_new):
if not attrs.get((None, u'href'), u'').startswith(('http:', 'https:')):
^^^^^^^^^^^^^^^
return None
return attrs

Further, you need to make sure you're always using unicode values. If you
don't then html5lib will raise an assertion error that the value is not
unicode.

All linkify filters will need to be updated.

* ``bleach.linkify`` and friends had a ``skip_pre`` argument--that's been
replaced with a more general ``skip_tags`` argument.

Before, you might do::

bleach.linkify(some_text, skip_pre=True)

The equivalent with Bleach 2.0 is::

bleach.linkify(some_text, skip_tags=['pre'])

You can skip other tags, too, like ``style`` or ``script`` or other places
where you don't want linkification happening.

All uses of linkify that use ``skip_pre`` will need to be updated.


**Changes**

* Supports Python 3.6.

* Supports html5lib >= 0.99999999 (8 9s).

* There's a ``bleach.sanitizer.Cleaner`` class that you can instantiate with your
favorite clean settings for easy reuse.

* There's a ``bleach.linkifier.Linker`` class that you can instantiate with your
favorite linkify settings for easy reuse.

* There's a ``bleach.linkifier.LinkifyFilter`` which is an htm5lib filter that
you can pass as a filter to ``bleach.sanitizer.Cleaner`` allowing you to clean
and linkify in one pass.

* ``bleach.clean`` and friends can now take a callable as an attributes arg value.

* Tons of bug fixes.

* Cleaned up tests.

* Documentation fixes.

--------------------------------

**Security fixes**

* None

**Backwards incompatible changes**

* clean: The list of ``ALLOWED_PROTOCOLS`` now defaults to http, https and
mailto.

Previously it was a long list of protocols something like ed2k, ftp, http,
https, irc, mailto, news, gopher, nntp, telnet, webcal, xmpp, callto, feed,
urn, aim, rsync, tag, ssh, sftp, rtsp, afs, data. (149)

**Changes**

* clean: Added ``protocols`` to arguments list to let you override the list of
allowed protocols. Thank you, Andreas Malecki! (149)

* linkify: Fix a bug involving periods at the end of an email address. Thank you,
Lorenz Schori! (219)

* linkify: Fix linkification of non-ascii ports. Thank you Alexandre, Macabies!
(207)

* linkify: Fix linkify inappropriately removing node tails when dropping nodes.
(132)

* Fixed a test that failed periodically. (161)

* Switched from nose to py.test. (204)

* Add test matrix for all supported Python and html5lib versions. (230)

* Limit to html5lib ``>=0.999,!=0.9999,!=0.99999,<0.99999999`` because 0.9999
and 0.99999 are busted.

* Add support for ``python setup.py test``. (97)

------------------------------

**Security fixes**

* None

**Changes**

* Limit to html5lib ``>=0.999,<0.99999999`` because of impending change to
sanitizer api. 195