Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support bleach 5, add packaging and tinycss2 dependencies #1755

Merged
merged 5 commits into from
Apr 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 45 additions & 4 deletions nbconvert/preprocessors/sanitize.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,46 @@
NBConvert Preprocessor for sanitizing HTML rendering of notebooks.
"""

from bleach import ALLOWED_ATTRIBUTES, ALLOWED_STYLES, ALLOWED_TAGS, clean
import warnings

from bleach import ALLOWED_ATTRIBUTES, ALLOWED_TAGS, clean
from traitlets import Any, Bool, List, Set, Unicode

_USE_BLEACH_CSS_SANITIZER = False
_USE_BLEACH_STYLES = False


try:
# bleach[css] >=5.0
from bleach.css_sanitizer import ALLOWED_CSS_PROPERTIES as ALLOWED_STYLES
from bleach.css_sanitizer import CSSSanitizer

_USE_BLEACH_CSS_SANITIZER = True
_USE_BLEACH_STYLES = False
except ImportError:
try:
# bleach <5
from bleach import ALLOWED_STYLES

_USE_BLEACH_CSS_SANITIZER = False
_USE_BLEACH_STYLES = True
warnings.warn(
"Support for bleach <5 will be removed in a future version of nbconvert",
DeprecationWarning,
)

except ImportError:
warnings.warn(
"The installed bleach/tinycss2 do not provide CSS sanitization, "
"please upgrade to bleach >=5",
UserWarning,
)


from .base import Preprocessor

__all__ = ["SanitizeHTML"]


class SanitizeHTML(Preprocessor):

Expand Down Expand Up @@ -118,11 +153,17 @@ def sanitize_html_tags(self, html_str):
"""
Sanitize a string containing raw HTML tags.
"""
return clean(
html_str,
kwargs = dict(
tags=self.tags,
attributes=self.attributes,
styles=self.styles,
strip=self.strip,
strip_comments=self.strip_comments,
)

if _USE_BLEACH_CSS_SANITIZER:
css_sanitizer = CSSSanitizer(allowed_css_properties=self.styles)
kwargs.update(css_sanitizer=css_sanitizer)
elif _USE_BLEACH_STYLES:
kwargs.update(styles=self.styles)

return clean(html_str, **kwargs)
22 changes: 12 additions & 10 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,20 +237,22 @@ def get_data_files():
)

setup_args["install_requires"] = [
"mistune>=0.8.1,<2",
"beautifulsoup4",
"bleach",
"defusedxml",
"entrypoints>=0.2.2",
"jinja2>=2.4",
"pygments>=2.4.1",
"jupyterlab_pygments",
"traitlets>=5.0",
"jupyter_core",
"jupyterlab_pygments",
"MarkupSafe>=2.0",
"mistune>=0.8.1,<2",
"nbclient>=0.5.0,<0.6.0",
"nbformat>=4.4",
"entrypoints>=0.2.2",
"bleach",
"packaging",
"pandocfilters>=1.4.1",
"defusedxml",
"beautifulsoup4",
"nbclient>=0.5.0,<0.6.0",
"MarkupSafe>=2.0",
"pygments>=2.4.1",
"tinycss2", # for bleach >=5
"traitlets>=5.0",
]

pyppeteer_req = "pyppeteer>=1,<1.1"
Expand Down