gh-57179: Add note on symlinks for os.walk (GH-94799)

(cherry picked from commit 0f498f1a95306995ca1e287f552c5c3d856be02d)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index fbfeeb2d7e1f1851d6b8c2a3ab651f85204e5614..83377916691069227593722db5ecb5ff29481e28 100644 (file)
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -3208,7 +3208,8 @@ features:
    filenames)``.
 
    *dirpath* is a string, the path to the directory.  *dirnames* is a list of the
-   names of the subdirectories in *dirpath* (excluding ``'.'`` and ``'..'``).
+   names of the subdirectories in *dirpath* (including symlinks to directories,
+   and excluding ``'.'`` and ``'..'``).
    *filenames* is a list of the names of the non-directory files in *dirpath*.
    Note that the names in the lists contain no path components.  To get a full path
    (which begins with *top*) to a file or directory in *dirpath*, do

diff --git a/Lib/os.py b/Lib/os.py
index 648188e0f13490efade8c6a74f5db76b50186e38..fd1e774fdcbcfa579f0c4457ac489daec8c104aa 100644 (file)
--- a/Lib/os.py
+++ b/Lib/os.py
@@ -288,7 +288,8 @@ def walk(top, topdown=True, onerror=None, followlinks=False):
         dirpath, dirnames, filenames
 
     dirpath is a string, the path to the directory.  dirnames is a list of
-    the names of the subdirectories in dirpath (excluding '.' and '..').
+    the names of the subdirectories in dirpath (including symlinks to directories,
+    and excluding '.' and '..').
     filenames is a list of the names of the non-directory files in dirpath.
     Note that the names in the lists are just names, with no path components.
     To get a full path (which begins with top) to a file or directory in