[Python-checkins] bpo-39567: Document audit for os.walk, os.fwalk, Path.glob and Path.rglob. (GH-18499)

Sun Mar 8 08:31:51 EDT 2020

https://github.com/python/cpython/commit/db283b32e7580741a8b6b7f27f616cc656634750
commit: db283b32e7580741a8b6b7f27f616cc656634750
branch: master
author: Serhiy Storchaka <storchaka at gmail.com>
committer: GitHub <noreply at github.com>
date: 2020年03月08日T14:31:47+02:00
summary:
bpo-39567: Document audit for os.walk, os.fwalk, Path.glob and Path.rglob. (GH-18499)
files:
M Doc/library/os.rst
M Doc/library/pathlib.rst

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index af02a373f33dc..c9d6fb232c0a8 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 7c0ffd50e2c79..004c156e11885 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()
 
