Add tags parameter to clean_text#122
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an optional tags parameter to nh3.clean_text() to support a “strip all tags except these” migration path (e.g., from bleach), while keeping existing “escape everything” behavior when tags is omitted.
Changes:
- Extend
clean_text()Python API to accepttagsand route to anammoniacleaner when provided. - Add pytest coverage for basic tag preservation/stripping behavior in
clean_text(tags=...). - Update Python type stubs (
nh3.pyi) to reflect the new optional parameter.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/lib.rs |
Implements clean_text(html, tags=None) and updates docstring/example. |
tests/test_nh3.py |
Adds new tests asserting preserved tags pass through and others are stripped. |
nh3.pyi |
Updates the stub signature for clean_text to include optional tags. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Override the Config default `link_rel` to None so ammonia does not inject a `rel` attribute on <a> when tags includes "a". Add a regression test that asserts `<a href=... rel=...>` is passed through as `<a>`.
gghez
force-pushed
the
add-tags-to-clean-text
branch
from
88fd9c5 to
bd459ff
Compare
messense
approved these changes
Apr 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
`clean_text` currently escapes everything with no way to let specific
tags through. When migrating from bleach, a common pattern is sanitizing
text while keeping a small set of custom elements like `` intact.
When `tags` is given, those tags are passed through with no attributes and
everything else is stripped. Omitting `tags` keeps the existing behavior.
Closes #54