Clean up handling of plugin distribution metadata #1073
Merged
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
This fixes at least one subtle bug: Some distributions do not include a `top_level.txt` in their `.dist-info`, however `importlib.metadata.packages_distributions` more-or-less relies on it to work properly. See python-poetry/poetry#3093 and https://github.com/python/cpython/blob/6cc6b13308b3202270ea7ac0ee776762a66f6a2f/Lib/importlib/metadata/__init__.py#L1043
4 tasks
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.
This fixes and cleans up work done in #1061.
The issue is how to find the distribution which provides a particular Lektor plugin.
Importlib.metadataprovides thepackages_distributionfunction which sort of does the right thing, but,it turns out that it is not totally reliable1.
In any case, under the hood,
packages_distributionjust iterates over all the distributions. It’s cleaner just toiterate the distributions to find the plugins — then we know for sure which distribution a given plugin comes from.
Issue(s) Resolved
Fixes #
Related Issues / Links
Description of Changes
Footnotes
Packages_distributions(more-or-less) depends on the distribution(s) providing atop_level.txtin its.pkg-info.It appears that
top_level.txtis not specified in any PEP and is a remnant from the days of eggs. Most distributionsstill provide them, but some do not (e.g. poetry build wheel file. not found top_level.txt python-poetry/poetry#3093.) ↩