fixup! Deprecate the sanitizer and recommend Bleach

gsnedders · gsnedders · commit 254b9102d869 · 2020-06-21T19:54:23.000+01:00
diff --git a/html5lib/filters/sanitizer.py b/html5lib/filters/sanitizer.py
@@ -1,3 +1,10 @@
+"""Deprecated from html5lib 1.1.
+
+See `here <https://github.com/html5lib/html5lib-python/issues/443>`_ for information about its
+deprecation; `Bleach <https://github.com/mozilla/bleach>`_ is recommended as a replacement. Please
+let us know in the aforementioned issue if Bleach is unsuitable for your needs.
+
+"""
 from __future__ import absolute_import, division, unicode_literals
 
 import re
@@ -12,13 +19,14 @@
 __all__ = ["Filter"]
 
 
-warnings.warn(
+__deprecation_msg = (
     "html5lib's sanitizer is deprecated; see " +
     "https://github.com/html5lib/html5lib-python/issues/443 and please let " +
-    "us know if Bleach in unsuitable for your needs",
-    DeprecationWarning
+    "us know if Bleach is unsuitable for your needs"
 )
 
+warnings.warn(__deprecation_msg, DeprecationWarning)
+
 allowed_elements = frozenset((
     (namespaces['html'], 'a'),
     (namespaces['html'], 'abbr'),
@@ -759,12 +767,7 @@ def __init__(self,
         """
         super(Filter, self).__init__(source)
 
-        warnings.warn(
-            "html5lib's sanitizer is deprecated; see " +
-            "https://github.com/html5lib/html5lib-python/issues/443 and please let " +
-            "us know if Bleach in unsuitable for your needs",
-            DeprecationWarning
-        )
+        warnings.warn(__deprecation_msg, DeprecationWarning)
 
         self.allowed_elements = allowed_elements
         self.allowed_attributes = allowed_attributes
