summaryrefslogtreecommitdiffstats
path: root/Doc/library/importlib.metadata.rst
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2019-09-02 15:08:03 (GMT)
committerGitHub <noreply@github.com>2019-09-02 15:08:03 (GMT)
commit102e9b40ff6ee45086a5f0d34d9c60c581a1e5e5 (patch)
tree6000eb766999fabf5ccac8814c07d93ee146d248 /Doc/library/importlib.metadata.rst
parent1f21eaa15e8a0d2b0f78d0e3f2b9e5b458eb0a70 (diff)
downloadcpython-102e9b40ff6ee45086a5f0d34d9c60c581a1e5e5.zip
cpython-102e9b40ff6ee45086a5f0d34d9c60c581a1e5e5.tar.gz
cpython-102e9b40ff6ee45086a5f0d34d9c60c581a1e5e5.tar.bz2
bpo-38010 Sync importlib.metadata with importlib_metadata 0.20. (GH-15646)
Sync importlib.metadata with importlib_metadata 0.20.
Diffstat (limited to 'Doc/library/importlib.metadata.rst')
-rw-r--r--Doc/library/importlib.metadata.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/importlib.metadata.rst b/Doc/library/importlib.metadata.rst
index 2126498..23c8cde 100644
--- a/Doc/library/importlib.metadata.rst
+++ b/Doc/library/importlib.metadata.rst
@@ -158,6 +158,13 @@ Once you have the file, you can also read its contents::
return s.encode('utf-8')
return s
+In the case where the metadata file listing files
+(RECORD or SOURCES.txt) is missing, ``files()`` will
+return ``None``. The caller may wish to wrap calls to
+``files()`` in `always_iterable
+<https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable>`_
+or otherwise guard against this condition if the target
+distribution is not known to have the metadata present.
.. _requirements: