Repository navigation
Conversation
Describe how the separate class hierarchies in importlib.metadata and the importlib_metadata backport affect custom providers: which objects the backport substitutes, which it passes through with a warning, and why a provider should implement the whole interface and rely on the shared protocols rather than on a particular base class. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2 tasks
Documentation build overview
86 files changed ·
|
importlib_metadata now decides the warning by conformance to IDistribution rather than by class identity, so a provider that presents the whole interface draws no warning and the warning names what a class omits. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
jaraco
commented
Oct 22, 2026
jaraco
commented
Oct 22, 2026
The guidance to rely on the interface rather than the type addresses every consumer, not only a provider that consumes metadata, so promote the caveats to their own section and split it by audience. Note that the protocols come from the backport, which this module does not yet present. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Assume the shared protocols from python/importlib_metadata#505 are presented by this module as well: document IDistribution and IPackagePath, correct PackageMetadata, which is already a protocol here rather than an implementation of the backport's, and write the caveats around the protocols as the interface both libraries satisfy. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Adds the IDistribution and IPackagePath protocols, so a consumer can target one interface across this module and the backport rather than either library's concrete classes, and annotates the functions returning distributions and files with them. The backport's compat and _compat packages are excluded from the port as usual, so localize and the conformance warning it raises do not appear here; only the protocols they are defined against do. This is what the caveats documented for pythongh-123976 in this branch describe. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Applies the
importlib_metadata10.0 sync and documents the protocols itintroduces. These began as separate changes; they are combined here because
the documentation describes the protocols the sync adds, so neither reviews
well on its own.
The sync (gh-160386)
IDistributionandIPackagePathprotocols toLib/importlib/metadata/_meta.py, and annotates the functions returningdistributions and files with them, so a consumer can target one interface
across this module and the backport rather than either library's concrete
classes (API incompatibility with
importlib.metadata(or at least the API is not type-safe?) importlib_metadata#486).PackageMetadata@runtime_checkable, as the protocols are meant tobe tested with
isinstance.The backport's
compatand_compatpackages are excluded from the port asusual, so
localizeand theUserWarningit raises where a provider's classomits a required member do not appear here; only the protocols they are
defined against do. That is why the caveats below describe that warning as the
backport's behavior rather than this module's.
Merged from python/importlib_metadata at the
v10.0.0tag rather than frommain, so this applies that release alone. 10.1.0 follows separately.The documentation (gh-123976)
Documents the interaction between a custom provider and the
importlib_metadatabackport, built around the protocols both librariessatisfy.
The two libraries define separate, unrelated class hierarchies but discover
distributions through the same
sys.meta_path, so one provider servesconsumers of both and cannot satisfy both by subclassing. The protocols, not
any concrete class, are the interface to write against.
for custom providers.
IDistributionandIPackagePath.PackageMetadataentry. It currently calls itself "a concreteimplementation of the PackageMetadata protocol" and links to the backport's
docs for the protocol, but
importlib.metadata._meta.PackageMetadataisitself a
Protocol, and is exported in__all__.DatabaseDistributionexample to the provider guidance.Testing
./python.exe -m test test_importlib -m 'test.test_importlib.metadata.*'passes: 102 tests, including the three new
test_protocolstests. A fulltest_importlibrun on this build also shows 8test_threaded_importfailures, which reproduce with these changes stashed and are unrelated to
importlib.metadata.🤖 Generated with Claude Code