Commit8df6cc9

authored

Deprecate the sanitizer and recommend Bleach (#501)

1 parent7e52b16 commit8df6cc9Copy full SHA for 8df6cc9

File tree

+48

-19

lines changed

+48

-19

lines changed

Lines changed: 10 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -11,11 +11,18 @@ Breaking changes:`
`11`	`11`	`* Drop support for Python 3.3. (#358)`
`12`	`12`	`* Drop support for Python 3.4. (#421)`
`13`	`13`
	`14`	`+Deprecations:`
	`15`	`+`
	`16`	+* Deprecate the ``html5lib`` sanitizer (``html5lib.serialize(sanitize=True)`` and
	`17`	+ ``html5lib.filters.sanitizer``). We recommend users migrate to `Bleach
	`18`	+<https://github.com/mozilla/bleach>`. Please let us know if Bleach doesn't suffice for your
	`19`	`+ use. (#443)`
	`20`	`+`
`14`	`21`	`Other changes:`
`15`	`22`
`16`		-* Try to import from `collections.abc` to remove DeprecationWarning and ensure
`17`		- `html5lib` keeps working in future Python versions. (#403)
`18`		-* Drop optional `datrie` dependency. (#442)
	`23`	+* Try to import from ``collections.abc`` to remove DeprecationWarning and ensure
	`24`	+ ``html5lib`` keeps working in future Python versions. (#403)
	`25`	+* Drop optional ``datrie`` dependency. (#442)
`19`	`26`
`20`	`27`
`21`	`28`	`1.0.1`

Lines changed: 20 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,15 @@`
	`1`	`+"""Deprecated from html5lib 1.1.`
	`2`	`+`
	`3`	+See `here <https://github.com/html5lib/html5lib-python/issues/443>`_ for
	`4`	+information about its deprecation; `Bleach <https://github.com/mozilla/bleach>`_
	`5`	`+is recommended as a replacement. Please let us know in the aforementioned issue`
	`6`	`+if Bleach is unsuitable for your needs.`
	`7`	`+`
	`8`	`+"""`
`1`	`9`	`from __future__importabsolute_import,division,unicode_literals`
`2`	`10`
`3`	`11`	`importre`
	`12`	`+importwarnings`
`4`	`13`	`fromxml.sax.saxutilsimportescape,unescape`
`5`	`14`
`6`	`15`	`fromsix.movesimporturllib_parseasurlparse`
`@@ -11,6 +20,14 @@`
`11`	`20`	`__all__= ["Filter"]`
`12`	`21`
`13`	`22`
	`23`	`+_deprecation_msg= (`
	`24`	`+"html5lib's sanitizer is deprecated; see "+`
	`25`	`+"https://github.com/html5lib/html5lib-python/issues/443 and please let "+`
	`26`	`+"us know if Bleach is unsuitable for your needs"`
	`27`	`+)`
	`28`	`+`
	`29`	`+warnings.warn(_deprecation_msg,DeprecationWarning)`
	`30`	`+`
`14`	`31`	`allowed_elements=frozenset((`
`15`	`32`	`(namespaces['html'],'a'),`
`16`	`33`	`(namespaces['html'],'abbr'),`
`@@ -750,6 +767,9 @@ def __init__(self,`
`750`	`767`
`751`	`768`	`"""`
`752`	`769`	`super(Filter,self).__init__(source)`
	`770`	`+`
	`771`	`+warnings.warn(_deprecation_msg,DeprecationWarning)`
	`772`	`+`
`753`	`773`	`self.allowed_elements=allowed_elements`
`754`	`774`	`self.allowed_attributes=allowed_attributes`
`755`	`775`	`self.allowed_css_properties=allowed_css_properties`

Lines changed: 9 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -27,14 +27,15 @@ def runtest(self):`
`27`	`27`	`expected=self.test["output"]`
`28`	`28`
`29`	`29`	`parsed=parseFragment(input)`
`30`		`-serialized=serialize(parsed,`
`31`		`-sanitize=True,`
`32`		`-omit_optional_tags=False,`
`33`		`-use_trailing_solidus=True,`
`34`		`-space_before_trailing_solidus=False,`
`35`		`-quote_attr_values="always",`
`36`		`-quote_char="'",`
`37`		`-alphabetical_attributes=True)`
	`30`	`+withpytest.deprecated_call():`
	`31`	`+serialized=serialize(parsed,`
	`32`	`+sanitize=True,`
	`33`	`+omit_optional_tags=False,`
	`34`	`+use_trailing_solidus=True,`
	`35`	`+space_before_trailing_solidus=False,`
	`36`	`+quote_attr_values="always",`
	`37`	`+quote_char="'",`
	`38`	`+alphabetical_attributes=True)`
`38`	`39`	`errorMsg="\n".join(["\n\nInput:",input,`
`39`	`40`	`"\nExpected:",expected,`
`40`	`41`	`"\nReceived:",serialized])`

Lines changed: 9 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,15 @@`
`8`	`8`
`9`	`9`	`defsanitize_html(stream):`
`10`	`10`	`parsed=parseFragment(stream)`
`11`		`-serialized=serialize(parsed,`
`12`		`-sanitize=True,`
`13`		`-omit_optional_tags=False,`
`14`		`-use_trailing_solidus=True,`
`15`		`-space_before_trailing_solidus=False,`
`16`		`-quote_attr_values="always",`
`17`		`-quote_char='"',`
`18`		`-alphabetical_attributes=True)`
	`11`	`+withpytest.deprecated_call():`
	`12`	`+serialized=serialize(parsed,`
	`13`	`+sanitize=True,`
	`14`	`+omit_optional_tags=False,`
	`15`	`+use_trailing_solidus=True,`
	`16`	`+space_before_trailing_solidus=False,`
	`17`	`+quote_attr_values="always",`
	`18`	`+quote_char='"',`
	`19`	`+alphabetical_attributes=True)`
`19`	`20`	`returnserialized`
`20`	`21`
`21`	`22`

Comments

(0)