Expose ammonia's id_prefix option via id_prefix kwarg#134
Merged
Conversation
Adds an `id_prefix` keyword argument to `clean()` and `Cleaner()` that maps to ammonia's `Builder::id_prefix`, prepending the given string to every allowed `id` attribute value. This namespaces user-generated `id`s so they cannot collide with the `id`s already present on the host page. Semantics mirror ammonia: - Defaults to None (no prefixing). - The tag and the `id` attribute must still be whitelisted via `attributes`. - Values already starting with the prefix are left unchanged. Closes messense#133
messense
approved these changes
Jun 26, 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.
Adds an
id_prefixkeyword argument toclean()andCleaner()that maps toammonia's
Builder::id_prefix,prepending the given string to every allowed
idattribute value. This namespacesuser-generated
ids so they cannot collide with theids already present on thehost page.
Semantics mirror ammonia:
None(no prefixing — current behaviour).idattribute must still be whitelisted viaattributes.Includes tests for
clean()and a reusableCleaner, a doctest example, updatedtype stubs, and docstrings (which feed the autodoc-generated docs).
Closes #133