summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorEric Snow <ericsnowcurrently@gmail.com>2016-09-08 01:37:17 (GMT)
committerEric Snow <ericsnowcurrently@gmail.com>2016-09-08 01:37:17 (GMT)
commitd5f92239818eef182fadc7c6f81f70912090573d (patch)
tree6ac89131eb8c69f3f2a752cbde3a6376f86f9454 /Doc
parent8e7cdb2586193726e0263eeec82c05f2a0d9c2c9 (diff)
downloadcpython-d5f92239818eef182fadc7c6f81f70912090573d.zip
cpython-d5f92239818eef182fadc7c6f81f70912090573d.tar.gz
cpython-d5f92239818eef182fadc7c6f81f70912090573d.tar.bz2
Issue #17211: Yield a namedtuple in pkgutil.
Patch by Ramchandra Apte.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/pkgutil.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/library/pkgutil.rst b/Doc/library/pkgutil.rst
index c5ba8d8..1d038f9 100644
--- a/Doc/library/pkgutil.rst
+++ b/Doc/library/pkgutil.rst
@@ -11,6 +11,10 @@
This module provides utilities for the import system, in particular package
support.
+.. class:: ModuleInfo(module_finder, name, ispkg)
+
+ A namedtuple that holds a brief summary of a module's info.
+
.. function:: extend_path(path, name)
@@ -139,7 +143,7 @@ support.
.. function:: iter_modules(path=None, prefix='')
- Yields ``(module_finder, name, ispkg)`` for all submodules on *path*, or, if
+ Yields :class:`ModuleInfo` for all submodules on *path*, or, if
*path* is ``None``, all top-level modules on ``sys.path``.
*path* should be either ``None`` or a list of paths to look for modules in.
@@ -160,7 +164,7 @@ support.
.. function:: walk_packages(path=None, prefix='', onerror=None)
- Yields ``(module_finder, name, ispkg)`` for all modules recursively on
+ Yields :class:`ModuleInfo` for all modules recursively on
*path*, or, if *path* is ``None``, all accessible modules.
*path* should be either ``None`` or a list of paths to look for modules in.