← 输入框|github.com|刷新
Skip to content

gh-160386: Apply changes from importlib_metadata 10.0 and document the shared protocols - #160344

Draft
jaraco wants to merge 6 commits into
python:mainfrom
jaraco:docs/gh-123976-backport-caveats
Draft

jaraco wants to merge 6 commits into
python:mainfrom
jaraco:docs/gh-123976-backport-caveats

Conversation

@jaraco

@jaraco jaraco commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

Applies the importlib_metadata 10.0 sync and documents the protocols it
introduces. 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)

The backport's compat and _compat packages are excluded from the port as
usual, so localize and the UserWarning it raises where a provider's class
omits 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.0 tag rather than from
main, 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_metadata backport, built around the protocols both libraries
satisfy.

The two libraries define separate, unrelated class hierarchies but discover
distributions through the same sys.meta_path, so one provider serves
consumers of both and cannot satisfy both by subclassing. The protocols, not
any concrete class, are the interface to write against.

  • New "Caveats for backports" section, split into guidance for consumers and
    for custom providers.
  • Documents IDistribution and IPackagePath.
  • Corrects the PackageMetadata entry. It currently calls itself "a concrete
    implementation of the PackageMetadata protocol" and links to the backport's
    docs for the protocol, but importlib.metadata._meta.PackageMetadata is
    itself a Protocol, and is exported in __all__.
  • Points from the DatabaseDistribution example to the provider guidance.

Testing

./python.exe -m test test_importlib -m 'test.test_importlib.metadata.*'
passes: 102 tests, including the three new test_protocols tests. A full
test_importlib run on this build also shows 8 test_threaded_import
failures, which reproduce with these changes stashed and are unrelated to
importlib.metadata.

🤖 Generated with Claude Code

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>
@read-the-docs-community

read-the-docs-community Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35549586 | 📁 Comparing 294c0df against main (e7e0b35)

  🔍 Preview build  

86 files changed · ± 86 modified

± Modified

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>
Comment thread Doc/library/importlib.metadata.rst Resolved
Comment thread Doc/library/importlib.metadata.rst Resolved
jaraco and others added 2 commits October 22, 2026 14:51
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>
@jaraco jaraco changed the title gh-123976: Document backport caveats for custom providers gh-123976: Document the protocols shared with the importlib_metadata backport Oct 22, 2026
jaraco and others added 2 commits October 31, 2026 15:49
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>
@jaraco jaraco changed the title gh-123976: Document the protocols shared with the importlib_metadata backport gh-160386: Apply changes from importlib_metadata 10.0 and document the shared protocols Oct 31, 2026
@bedevere-app bedevere-app Bot added the type-feature A feature request or enhancement label Oct 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir type-feature A feature request or enhancement

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant