core: replace pkg_resources with importlib.metadata
#2261
Merged
Conversation
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
Needs a backport package until we no longer support Python 3.7; stdlib gained `importlib.metadata` in Python 3.8. I should note that installing with `-r dev-requirements.txt` will always (currently) install the `importlib_metadata` backport because of Sphinx.
Unfortunately this one is *not* yet part of the stdlib in any Python release, but there's no point in removing only *most* uses of the older `pkg_resources` library. Gotta do them *all*.
Adapted the `get_meta_description()` for `EntryPointPlugin` to return the expected format. Could alternatively change the expectation of `test_get_label_entrypoint()`.
dgw
added
Housekeeping
Exirel
reviewed
Feb 27, 2022
Contributor
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
Impressive work, having to deal with setuptools, metadata, and backport packages for Python version up to 3.9 is no small feat. Well done!
I don't approve yet because of one comment, however, it's only for documentation.
As the Python packaging docs say, entry points are now a PyPA-defined interoperability specification not confined to packages built using `setuptools`, and we should update our docs to reflect that. See https://packaging.python.org/en/latest/specifications/entry-points/
Member
Author
|
@Exirel I went a bit ham on updating the docs instead of just tweaking the one |
It's not a "setuptools entry point"; it's an "entry point group".
Exirel
approved these changes
Feb 28, 2022
Contributor
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
I'm clearly not going to nitpick at grammar, this looks pretty good to me.
Member
Author
|
Followed up with #2268, since the |
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
Tin. Performance of
pkg_resourcescan be quite slow (just search all of GitHub issues for "pkg_resources slow"); its use is discouraged by thesetuptoolsproject itself, in favor of the newer modules such asimportlib.metadata.Needs a backport package until we no longer support Python 3.9. stdlib gained
importlib.metadatain Python 3.8, but the ability to "select" inentry_points()won't be added until Python 3.10. I don't mind this, because it takes an implied dependency (setuptoolswas required to install Sopel but not listed inrequirements.txt) and makes it explicit until we can use the stdlib version. My requirement specifier gives the minimum version of theimportlib_metadatabackport that supports selectors.I didn't see a direct equivalent to
pkg_resources.parse_version()inimportlib.metadata; looking at a couple other projects that have already made the move away frompkg_resourcestold me thatpackaging.version.parse()is the way to go.Checklist
make qa(runsmake qualityandmake test)sopel-dnson my local (-e .) SopelTest instance with no issues.Notes
We devs/hackers have been installing
importlib_metadatafor a while without thinking about it, because Sphinx explicitly requires it for install on py<3.10.