Commit cf5e6a4a authored by Tim Peters's avatar Tim Peters

SF bug [#469732] os.path.walk docstring inconsistent.

We have 5 implementations of walk(), and 5 different docstrings.  Combined
'em.  Let's see how long it takes before they're all different again!
parent ec4b5450
...@@ -183,13 +183,19 @@ def ismount(path): ...@@ -183,13 +183,19 @@ def ismount(path):
def walk(top, func, arg): def walk(top, func, arg):
"""Directory tree walk. """Directory tree walk with callback function.
For each directory under top (including top itself, but excluding
'.' and '..'), func(arg, dirname, filenames) is called, where For each directory in the directory tree rooted at top (including top
dirname is the name of the directory and filenames is the list itself, but excluding '.' and '..'), call func(arg, dirname, fnames).
files files (and subdirectories etc.) in the directory. dirname is the name of the directory, and fnames a list of the names of
The func may modify the filenames list, to implement a filter, the files and subdirectories in dirname (excluding '.' and '..'). func
or to impose a different order of visiting.""" 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: try:
names = os.listdir(top) names = os.listdir(top)
......
...@@ -201,13 +201,19 @@ def normpath(s): ...@@ -201,13 +201,19 @@ def normpath(s):
def walk(top, func, arg): def walk(top, func, arg):
"""Directory tree walk. """Directory tree walk with callback function.
For each directory under top (including top itself),
func(arg, dirname, filenames) is called, where For each directory in the directory tree rooted at top (including top
dirname is the name of the directory and filenames is the list itself, but excluding '.' and '..'), call func(arg, dirname, fnames).
of files (and subdirectories etc.) in the directory. dirname is the name of the directory, and fnames a list of the names of
The func may modify the filenames list, to implement a filter, the files and subdirectories in dirname (excluding '.' and '..'). func
or to impose a different order of visiting.""" 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: try:
names = os.listdir(top) names = os.listdir(top)
......
...@@ -291,11 +291,20 @@ def ismount(path): ...@@ -291,11 +291,20 @@ def ismount(path):
# or to impose a different order of visiting. # or to impose a different order of visiting.
def walk(top, func, arg): def walk(top, func, arg):
"""Directory tree walk whth callback function. """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."""
walk(top, func, arg) calls func(arg, d, files) for each directory d
in the tree rooted at top (including top itself); files is a list
of all the files and subdirs in directory d."""
try: try:
names = os.listdir(top) names = os.listdir(top)
except os.error: except os.error:
......
...@@ -350,11 +350,20 @@ def normpath(p): ...@@ -350,11 +350,20 @@ def normpath(p):
# Independent of host system. Why am I in os.path? # Independent of host system. Why am I in os.path?
def walk(top, func, arg): def walk(top, func, arg):
""" """Directory tree walk with callback function.
walk(top,func,args) calls func(arg, d, files) for each directory "d" in the tree
rooted at "top" (including "top" itself). "files" is a list of all the files and For each directory in the directory tree rooted at top (including top
subdirs in directory "d". 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: try:
names= os.listdir(top) names= os.listdir(top)
except os.error: except os.error:
......
...@@ -258,10 +258,20 @@ def ismount(path): ...@@ -258,10 +258,20 @@ def ismount(path):
# or to impose a different order of visiting. # or to impose a different order of visiting.
def walk(top, func, arg): def walk(top, func, arg):
"""walk(top,func,arg) calls func(arg, d, files) for each directory "d" """Directory tree walk with callback function.
in the tree rooted at "top" (including "top" itself). "files" is a list
of all the files and subdirs in directory "d". 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: try:
names = os.listdir(top) names = os.listdir(top)
except os.error: except os.error:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment