[Python-checkins] Document importlib.metadata.PackagePath.locate method (GH-25669)

[jaraco]

https://github.com/python/cpython/commit/b38b2fa0218911ccc20d576ff504f39c9c9d47ec
commit: b38b2fa0218911ccc20d576ff504f39c9c9d47ec
branch: master
author: Paul Moore <p.f.moore at gmail.com>
committer: jaraco <jaraco at jaraco.com>
date: 2021-04-28T19:27:37-04:00
summary:

Document importlib.metadata.PackagePath.locate method (GH-25669)

files:
M Doc/library/importlib.metadata.rst

diff --git a/Doc/library/importlib.metadata.rst b/Doc/library/importlib.metadata.rst
index 0f0a8dd91eea1..40e48d1beec0c 100644
--- a/Doc/library/importlib.metadata.rst
+++ b/Doc/library/importlib.metadata.rst
@@ -191,7 +191,7 @@ Distribution files
 You can also get the full set of files contained within a distribution.  The
 ``files()`` function takes a distribution package name and returns all of the
 files installed by this distribution.  Each file object returned is a
-``PackagePath``, a :class:`pathlib.Path` derived object with additional ``dist``,
+``PackagePath``, a :class:`pathlib.PurePath` derived object with additional ``dist``,
 ``size``, and ``hash`` properties as indicated by the metadata.  For example::
 
     >>> util = [p for p in files('wheel') if 'util.py' in str(p)][0]  # doctest: +SKIP
@@ -215,6 +215,12 @@ Once you have the file, you can also read its contents::
             return s.encode('utf-8')
         return s
 
+You can also use the ``locate`` method to get a the absolute path to the
+file::
+
+    >>> util.locate()  # doctest: +SKIP
+    PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')
+
 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