Repository navigation
import.metadata overview missing import statement #142197
Description
Documentation
Going through https://docs.python.org/3/library/importlib.metadata.html#overview I was following
cpython/Doc/library/importlib.metadata.rst
Lines 93 to 97 in d3c888b
and got as a result
>>> list(metadata('wheel'))
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
NameError: name 'metadata' is not defined
>>> from importlib.metadata import metadata
>>> list(metadata('wheel'))
['Metadata-Version', 'Name', 'Version', 'Summary', 'Keywords', 'Author-email', 'Maintainer-email', 'Requires-Python', 'Description-Content-Type', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Requires-Dist', 'Requires-Dist', 'Project-URL', 'Project-URL', 'Project-URL', 'Project-URL', 'Provides-Extra', 'Description']It could make sense to add from importlib.metadata import metadata to the docs.
Cheers,
Tiago
Linked PRs
- gh-142197: Doc: Add missing import statement in importlib.metadata overview #142208
- [3.15] gh-142197: Doc: Add missing import statement in importlib.metadata overview (GH-142208) #157284
- [3.14] gh-142197: Doc: Add missing import statement in importlib.metadata overview (GH-142208) #157285
- [3.13] gh-142197: Doc: Add missing import statement in importlib.metadata overview (GH-142208) #157286
Activity
StanFromIreland commentedon Dec 2, 2025
From my reading the section is a step-by-step guide, and the import is in the previous step, and so, repeating it is not necessary. If we were to include the setup in each codeblock, it seems like we should include the venv creation and
python -m pip install wheeltoo?lubianat commentedon Dec 2, 2025
@StanFromIreland I was follwing it as a step-by-step guide indeed, but the previous codeblock imports only
version, but notmetadata. It is easy to figure out, so not a big blocker, but explicit is better than implict :)It could be changed to import both on the previous line too, to
from importlib.metadata import version, metadatabut that is maybe less intuitive given the context
StanFromIreland commentedon Dec 2, 2025
Ah, I had not read closely enough, thank you. Yes I agree we should update it.
Yashp002 commentedon Dec 3, 2025
I'd like to take this one. The fix should be straightforward - adding
from importlib.metadata import metadatabefore the example code in the overview section. I'll submit a PR shortly.gh-142197: Doc: Add missing import statement in importlib.metadata ov…
[3.13] gh-142197: Doc: Add missing import statement in importlib.meta…
[3.14] gh-142197: Doc: Add missing import statement in importlib.meta…
[3.15] gh-142197: Doc: Add missing import statement in importlib.meta…
pythongh-142197: Doc: Add missing import statement in importlib.metad…
pythongh-142197: Doc: Add missing import statement in importlib.metad…