summaryrefslogtreecommitdiff
path: root/Doc/library/pkgutil.rst
diff options
context:
space:
mode:
authorBrett Cannon <brett@python.org>2012-06-15 19:21:07 -0400
committerBrett Cannon <brett@python.org>2012-06-15 19:21:07 -0400
commit724233a47d7578f674e880eaf152d3321041cf45 (patch)
treefc1d224f4028f150c81ac6eadc4950bbe01d19bd /Doc/library/pkgutil.rst
parent6a9b9af682bc53750e3f4b3f193bf6b5b7ba68f3 (diff)
downloadcpython-724233a47d7578f674e880eaf152d3321041cf45.tar.gz
Closes issue #14982: Document that pkgutil's walk_packages() and
iter_modules() requires iter_modules() be defined on an importer. The importers in importlib do not define this non-standard method.
Diffstat (limited to 'Doc/library/pkgutil.rst')
-rw-r--r--Doc/library/pkgutil.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/pkgutil.rst b/Doc/library/pkgutil.rst
index 3118ff2047..0aee4e7637 100644
--- a/Doc/library/pkgutil.rst
+++ b/Doc/library/pkgutil.rst
@@ -138,6 +138,10 @@ support.
*prefix* is a string to output on the front of every module name on output.
+ .. note::
+ Only works for importers which define a ``iter_modules()`` method, which
+ is non-standard but implemented by classes defined in this module.
+
.. function:: walk_packages(path=None, prefix='', onerror=None)
@@ -166,6 +170,10 @@ support.
# list all submodules of ctypes
walk_packages(ctypes.__path__, ctypes.__name__ + '.')
+ .. note::
+ Only works for importers which define a ``iter_modules()`` method, which
+ is non-standard but implemented by classes defined in this module.
+
.. function:: get_data(package, resource)