Skip to content

Commit 96e533b

Browse files
authored
Merge pull request #375 from saaketp/PackageMetadata-docs
Add note about PackageMetadata protocol and include link to importlib_metadata docs in usage.
2 parents 28ee235 + 5f375a9 commit 96e533b

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/using.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ By default, package metadata can live on the file system or in zip archives on
2323
anywhere.
2424

2525

26+
.. seealso::
27+
28+
https://importlib-metadata.readthedocs.io/
29+
The documentation for ``importlib_metadata``, which supplies a
30+
backport of ``importlib.metadata``.
31+
32+
2633
Overview
2734
========
2835

@@ -162,6 +169,13 @@ all the metadata in a JSON-compatible form per PEP 566::
162169
>>> wheel_metadata.json['requires_python']
163170
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
164171

172+
.. note::
173+
174+
The actual type of the object returned by ``metadata()`` is an
175+
implementation detail and should be accessed only through the interface
176+
described by the
177+
`PackageMetadata protocol <https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata>`.
178+
165179

166180
.. _version:
167181

0 commit comments

Comments
 (0)