Skip to content

Add add_*/rm_* keyword arguments for set-valued sanitizer options #128

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.

Sign up for GitHub

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

Open
gghez wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add add_*/rm_* keyword arguments for set-valued sanitizer options #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f581ab
Add design doc for issue #78 additive builder options
gghez May 26, 2026
2d5a295
Add add_*/rm_* keyword arguments for set-valued options
gghez May 26, 2026
71351e7
Delete docs/superpowers/specs/2026-05-26-issue-78-additive-builder-op…
messense May 27, 2026
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
24 changes: 24 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,30 @@ For example, to only allow ``<b>`` tags:
>>> nh3.clean("<b><a href='https://example.com'>Hello</a></b>", tags={"b"})
'<b>Hello</b>'

Adding to (or removing from) the defaults
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``tags``, ``clean_content_tags``, ``url_schemes`` and
``generic_attribute_prefixes`` options each *replace* the ammonia defaults.
To extend the defaults without copying them, the ``add_*`` and ``rm_*``
companion options can be used instead:

.. code-block:: pycon

>>> # Allow a custom tag in addition to the defaults.
>>> nh3.clean("<b><my-tag>x</my-tag></b>", add_tags={"my-tag"})
'<b><my-tag>x</my-tag></b>'

>>> # Forbid <b> but keep the rest of the defaults.
>>> nh3.clean("<b><i>x</i></b>", rm_tags={"b"})
'<i>x</i>'

The same pattern works for ``add_clean_content_tags`` / ``rm_clean_content_tags``,
``add_url_schemes`` / ``rm_url_schemes`` and
``add_generic_attribute_prefixes`` / ``rm_generic_attribute_prefixes``.
When combined with the replacement option, ``add_*`` and ``rm_*`` apply on
top of the supplied set.

API reference
-------------

Expand Down
16 changes: 16 additions & 0 deletions nh3.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,23 @@ class Cleaner:
def __init__(
self,
tags: Optional[AbstractSet[str]] = None,
add_tags: Optional[AbstractSet[str]] = None,
rm_tags: Optional[AbstractSet[str]] = None,
clean_content_tags: Optional[AbstractSet[str]] = None,
add_clean_content_tags: Optional[AbstractSet[str]] = None,
rm_clean_content_tags: Optional[AbstractSet[str]] = None,
attributes: Optional[Mapping[str, AbstractSet[str]]] = None,
attribute_filter: Optional[Callable[[str, str, str], Optional[str]]] = None,
strip_comments: bool = True,
link_rel: Optional[str] = "noopener noreferrer",
generic_attribute_prefixes: Optional[AbstractSet[str]] = None,
add_generic_attribute_prefixes: Optional[AbstractSet[str]] = None,
rm_generic_attribute_prefixes: Optional[AbstractSet[str]] = None,
tag_attribute_values: Optional[Mapping[str, Mapping[str, AbstractSet[str]]]] = None,
set_tag_attribute_values: Optional[Mapping[str, Mapping[str, str]]] = None,
url_schemes: Optional[AbstractSet[str]] = None,
add_url_schemes: Optional[AbstractSet[str]] = None,
rm_url_schemes: Optional[AbstractSet[str]] = None,
allowed_classes: Optional[Mapping[str, AbstractSet[str]]] = None,
filter_style_properties: Optional[AbstractSet[str]] = None,
) -> None: ...
Expand All @@ -26,15 +34,23 @@ class Cleaner:
def clean(
html: str,
tags: Optional[AbstractSet[str]] = None,
add_tags: Optional[AbstractSet[str]] = None,
rm_tags: Optional[AbstractSet[str]] = None,
clean_content_tags: Optional[AbstractSet[str]] = None,
add_clean_content_tags: Optional[AbstractSet[str]] = None,
rm_clean_content_tags: Optional[AbstractSet[str]] = None,
attributes: Optional[Mapping[str, AbstractSet[str]]] = None,
attribute_filter: Optional[Callable[[str, str, str], Optional[str]]] = None,
strip_comments: bool = True,
link_rel: Optional[str] = "noopener noreferrer",
generic_attribute_prefixes: Optional[AbstractSet[str]] = None,
add_generic_attribute_prefixes: Optional[AbstractSet[str]] = None,
rm_generic_attribute_prefixes: Optional[AbstractSet[str]] = None,
tag_attribute_values: Optional[Mapping[str, Mapping[str, AbstractSet[str]]]] = None,
set_tag_attribute_values: Optional[Mapping[str, Mapping[str, str]]] = None,
url_schemes: Optional[AbstractSet[str]] = None,
add_url_schemes: Optional[AbstractSet[str]] = None,
rm_url_schemes: Optional[AbstractSet[str]] = None,
allowed_classes: Optional[Mapping[str, AbstractSet[str]]] = None,
filter_style_properties: Optional[AbstractSet[str]] = None,
) -> str: ...
Expand Down
Loading
Loading