Issue 17062: An os.walk inspired replacement for pkgutil.walk_packages (original) (raw)
Messages (5)
Author: Alyssa Coghlan (ncoghlan) * 
Date: 2013-01-28 11:17
I recently had occasion to use pkgutil.walk_packages, and my immediate thought was that it would have been a lot easier for me to use if it worked more like os.walk with topdown=True, producing tuples of (pkg, subpackages, modules)
"pkg" would be the package object at the current level (None for the top level)
"packages" would be a dictionary mapping fully qualified module names to loader objects for the subpackages (i.e. subdirectories)
"modules" would be a dictionary mapping fully qualified module names to loader objects for every submodule that wasn't a subpackage
As with editing the "subdirs" list with os.walk, editing the "packages" dictionary with this new API would keep the iterator from loading that subpackage and avoid recursing into it (this is the part I wanted in my current use case).
(This may even be PEP material, guiding some additions to the importer/finder API)
Author: Alyssa Coghlan (ncoghlan) *
Date: 2013-01-28 11:30
Oops, forgot the proposed call signature:
def walk_path(path=None, *, pkg=None):
"""Walk a package hierarchy, starting with the given path
Iterator producing (package, subpackages, submodules) triples.
The first entry is the package currently being walked, or None
for the top level path. The subpackages and submodules entries
are dictionaries mapping from fully qualified module names to
the appropriate module loaders.
Entries may be removed from the subpackages dictionary to avoid
loading those packages and recursing into them.
If both pkg and path are None, walks sys.path
If path is not None, walks the specified path.
If pkg is not None, walks pkg.__path__
Providing both path and pkg results in ValueError
"""Author: Alyssa Coghlan (ncoghlan) *
Date: 2013-01-28 11:34
Regarding the PEP comment - the piece that would be missing is the "iter_modules" functionality. Currently pkgutil provides the support for standard filesystem imports and zipimports directly - the generic function based extension mechanism is undocumented.
Author: Martin Morrison (isoschiz) *
Date: 2013-04-18 23:47
I threw together a function that implements this. The only variation from the proposed signature was adding the onerror argument supported by the other similar functions in the module.
Author: Mark Lawrence (BreamoreBoy) *
Date: 2014-06-19 21:59
Could somebody review the attached patch please.
History
Date
User
Action
Args
2022-04-11 14:57:41
admin
set
github: 61264
2017-03-10 17:00:13
BreamoreBoy
set
nosy: - BreamoreBoy
2017-03-10 07🔞24
wolma
set
nosy: + wolma
2014-06-19 21:59:06
BreamoreBoy
set
nosy: + BreamoreBoy
messages: +
2013-04-18 23:47:51
isoschiz
set
files: + issue17062.diff
nosy: + isoschiz
messages: +
keywords: + patch
2013-01-28 11:42:17
serhiy.storchaka
set
type: enhancement
2013-01-28 11:34:18
ncoghlan
set
messages: +
2013-01-28 11:30:00
ncoghlan
set
messages: +
2013-01-28 11:17:08
ncoghlan
create