summaryrefslogtreecommitdiff
path: root/Lib/dospath.py
diff options
context:
space:
mode:
Diffstat (limited to 'Lib/dospath.py')
-rw-r--r--Lib/dospath.py20
1 files changed, 13 insertions, 7 deletions
diff --git a/Lib/dospath.py b/Lib/dospath.py
index 5f607057a3..652b35f51f 100644
--- a/Lib/dospath.py
+++ b/Lib/dospath.py
@@ -183,13 +183,19 @@ def ismount(path):
def walk(top, func, arg):
- """Directory tree walk.
- For each directory under top (including top itself, but excluding
- '.' and '..'), func(arg, dirname, filenames) is called, where
- dirname is the name of the directory and filenames is the list
- files files (and subdirectories etc.) in the directory.
- The func may modify the filenames list, to implement a filter,
- or to impose a different order of visiting."""
+ """Directory tree walk with callback function.
+
+ For each directory in the directory tree rooted at top (including top
+ itself, but excluding '.' and '..'), call func(arg, dirname, fnames).
+ dirname is the name of the directory, and fnames a list of the names of
+ the files and subdirectories in dirname (excluding '.' and '..'). func
+ may modify the fnames list in-place (e.g. via del or slice assignment),
+ and walk will only recurse into the subdirectories whose names remain in
+ fnames; this can be used to implement a filter, or to impose a specific
+ order of visiting. No semantics are defined for, or required of, arg,
+ beyond that arg is always passed to func. It can be used, e.g., to pass
+ a filename pattern, or a mutable object designed to accumulate
+ statistics. Passing None for arg is common."""
try:
names = os.listdir(top)