summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2020-03-08 12:31:47 (GMT)
committerGitHub <noreply@github.com>2020-03-08 12:31:47 (GMT)
commitdb283b32e7580741a8b6b7f27f616cc656634750 (patch)
treee0c36e673702bcc361e5d2eea1be62a5df17f82d
parenteb4e2ae2b8486e8ee4249218b95d94a9f0cc513e (diff)
downloadcpython-db283b32e7580741a8b6b7f27f616cc656634750.zip
cpython-db283b32e7580741a8b6b7f27f616cc656634750.tar.gz
cpython-db283b32e7580741a8b6b7f27f616cc656634750.tar.bz2
bpo-39567: Document audit for os.walk, os.fwalk, Path.glob and Path.rglob. (GH-18499)
-rw-r--r--Doc/library/os.rst4
-rw-r--r--Doc/library/pathlib.rst4
2 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index af02a37..c9d6fb2 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -3053,6 +3053,8 @@ features:
for name in dirs:
os.rmdir(os.path.join(root, name))
+ .. audit-event:: os.walk top,topdown,onerror,followlinks os.walk
+
.. versionchanged:: 3.5
This function now calls :func:`os.scandir` instead of :func:`os.listdir`,
making it faster by reducing the number of calls to :func:`os.stat`.
@@ -3112,6 +3114,8 @@ features:
for name in dirs:
os.rmdir(name, dir_fd=rootfd)
+ .. audit-event:: os.fwalk top,topdown,onerror,follow_symlinks,dir_fd os.fwalk
+
.. availability:: Unix.
.. versionadded:: 3.3
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index 7c0ffd5..004c156 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -763,6 +763,8 @@ call fails (for example because the path doesn't exist).
Using the "``**``" pattern in large directory trees may consume
an inordinate amount of time.
+ .. audit-event:: pathlib.Path.glob self,pattern pathlib.Path.glob
+
.. method:: Path.group()
@@ -1025,6 +1027,8 @@ call fails (for example because the path doesn't exist).
PosixPath('setup.py'),
PosixPath('test_pathlib.py')]
+ .. audit-event:: pathlib.Path.rglob self,pattern pathlib.Path.rglob
+
.. method:: Path.rmdir()