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

[3.11] gh-68654: Clarify subdirectories used by pkgutil.extend_path (GH-103701)

Browse source 
gh-68654: Clarify subdirectories used by pkgutil.extend_path (GH-103701)

Clarify sub directories used by pkgutil.extend_path in the docs and the docstring
(cherry picked from commit 7bf94568a9)

Co-authored-by: Randy <69558016+san-juan1667@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2023-04-23 01:57:10 -07:00 • committed by GitHub
parent 050b6b34d0
commit a43dbe13e2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Doc/library/pkgutil.rst
View file

@ -25,9 +25,9 @@ support.
from pkgutil import extend_path from pkgutil import extend_path
__path__ = extend_path(__path__, __name__) __path__ = extend_path(__path__, __name__)
This will add to the package's ``__path__`` all subdirectories of directories For each directory on :data:`sys.path` that has a subdirectory that matches the
on :data:`sys.path` named after the package. This is useful if one wants to package name, add the subdirectory to the package's :attr:`__path__`. This is useful
distribute different parts of a single logical package as multiple if one wants to distribute different parts of a single logical package as multiple
directories. directories.
It also looks for :file:`\*.pkg` files beginning where ``*`` matches the It also looks for :file:`\*.pkg` files beginning where ``*`` matches the

8
Lib/pkgutil.py
View file

@ -511,10 +511,10 @@ def extend_path(path, name):
from pkgutil import extend_path from pkgutil import extend_path
__path__ = extend_path(__path__, __name__) __path__ = extend_path(__path__, __name__)
This will add to the package's __path__ all subdirectories of For each directory on sys.path that has a subdirectory that
directories on sys.path named after the package. This is useful matches the package name, add the subdirectory to the package's
if one wants to distribute different parts of a single logical __path__. This is useful if one wants to distribute different
package as multiple directories. parts of a single logical package as multiple directories.
It also looks for *.pkg files beginning where * matches the name It also looks for *.pkg files beginning where * matches the name
argument. This feature is similar to *.pth files (see site.py), argument. This feature is similar to *.pth files (see site.py),