tools, tools.web: rework web.decode() to use modern stdlib
#2205
Conversation
This file contains 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
Python 3.4 added the `html.unescape()` function to its standard library, and current versions of Python have MUCH better HTML-entity-replacement implementations than ours. Let's just use the included batteries. This patch deprecates `tools.web.entity()` and the associated constant `r_entity`. `tools.web.decode()` no longer uses them, and in fact should probably be considered for deprecation itself. (Not done yet; deciding that will come separately, along with its siblings' TODO comments.) Note that the import of `web` in `tools/__init__.py` had to be moved below the definition of `tools.deprecated()` to avoid causing a circular dependency error. Might as well do it now, since we'll probably mark more stuff in `tools.web` as deprecated during Sopel 8's dev cycle.
Found some warnings that it "will be" removed, but it already has been.
Exirel
requested changes
Nov 1, 2021
Co-authored-by: Florian Strzelecki <[email protected]>
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.
Description
This fixes #2203 for 8.0. (The patch for 7.1.6 is a separate PR against the maintenance branch, #2204.)
Python 3.4 added the
html.unescape()function to its standard library, and current versions of Python have MUCH better HTML-entity-replacement implementations than ours. Let's just use the included batteries.This patch deprecates
tools.web.entity()and the associated constantr_entity.tools.web.decode()no longer uses them, and in fact should probably be considered for deprecation itself. (Not done yet; deciding that will come separately, along with its siblings' TODO comments.)Note that the import of
webintools/__init__.pyhad to be moved below the definition oftools.deprecated()to avoid causing a circular dependency error. Might as well do it now, since we'll probably mark more stuff intools.webas deprecated during Sopel 8's dev cycle.Checklist
make qa(runsmake qualityandmake test)