Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-06-24 10:00:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.15] gh-143387: Update docs to reflect the behavior and note the changed version. (GH-150095) (#150106)

Browse source 
gh-143387: Update docs to reflect the behavior and note the changed version. (GH-150095)
(cherry picked from commit 192796cfd4)

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
This commit is contained in:
Miss Islington (bot) 2026-05-20 03:03:47 +02:00 • committed by GitHub
parent eb7be9ab52
commit 653f12b2bf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
Doc/library/importlib.metadata.rst
View file

@ -105,6 +105,13 @@ You can also get a :ref:`distribution's version number <version>`, list its
current Python environment.
.. exception:: MetadataNotFound
Subclass of :class:`FileNotFoundError` raised when attempting to load metadata
from a distribution folder that is empty or otherwise does not contain a
metadata file.
Functional API
==============
@ -224,6 +231,9 @@ Distribution metadata
Raises :exc:`PackageNotFoundError` if the named distribution
package is not installed in the current Python environment.
Raises :exc:`MetadataNotFound` if a distribution package is
present but no METADATA file is present.
.. class:: PackageMetadata
A concrete implementation of the
@ -252,6 +262,12 @@ all the metadata in a JSON-compatible form per :PEP:`566`::
The full set of available metadata is not described here.
See the PyPA `Core metadata specification <https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata>`_ for additional details.
.. versionchanged:: 3.15
Previously and incidentally, if a METADATA file was missing from a distribution, an
empty ``PackageMetadata`` would be returned, indistinguishable from
an empty METADATA file. Now, a missing METADATA file triggers a
``MetadataNotFound`` exception.
.. versionchanged:: 3.10
The ``Description`` is now included in the metadata when presented
through the payload. Line continuation characters have been removed.
@ -465,6 +481,9 @@ The same applies for :func:`entry_points` and :func:`files`.
.. attribute:: metadata
:type: PackageMetadata
Raises :exc:`MetadataNotFound` if the METADATA file is not present in
the distribution.
There are all kinds of additional metadata available on :class:`!Distribution`
instances as a :class:`PackageMetadata` instance::