refactor: replace bleach with nh3 (ammonia)

pypa / readme_renderer

Safely render long_description/README files in Warehouse

Apache License 2.0

158 stars 89 forks source link

refactor: replace bleach with nh3 (ammonia) #295

Closed miketheman closed 1 year ago

miketheman commented 1 year ago

Refs: https://nh3.readthedocs.io/

Bleach has been deprecated.

This refactor includes"

a non-breaking refactor of lists to sets to support both bleach and nh3
addition of the pytest-icdiff test helper to find the one-character changes
removal of the bleach code and filters
updates to the test suite

Notable changes in the tests:

all <a> tags now get rel="nofollow" added
less usage of escaped characters like " for "

miketheman commented 1 year ago

Expecting failure for checked boolean attributes - see this issue for more.

miketheman commented 1 year ago

We could update the tests here as well to allow checked to become checked="" in the meantime, if we were worried about continued use of bleach.

di commented 1 year ago

We could update the tests here as well to allow checked to become checked="" in the meantime, if we were worried about continued use of bleach.

I think that's probably fine. Since they're equivalent, I don't think it really matters which one ends up being used.