Skip to content

Commit 8000a9d

Browse files
authored
gh-146646: Document that glob functions suppress OSError (#147996)
1 parent ade914b commit 8000a9d

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

Doc/library/glob.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,11 @@ The :mod:`!glob` module defines the following functions:
8383
This function may return duplicate path names if *pathname*
8484
contains multiple "``**``" patterns and *recursive* is true.
8585

86+
.. note::
87+
Any :exc:`OSError` exceptions raised from scanning the filesystem are
88+
suppressed. This includes :exc:`PermissionError` when accessing
89+
directories without read permission.
90+
8691
.. versionchanged:: 3.5
8792
Support for recursive globs using "``**``".
8893

@@ -106,6 +111,11 @@ The :mod:`!glob` module defines the following functions:
106111
This function may return duplicate path names if *pathname*
107112
contains multiple "``**``" patterns and *recursive* is true.
108113

114+
.. note::
115+
Any :exc:`OSError` exceptions raised from scanning the filesystem are
116+
suppressed. This includes :exc:`PermissionError` when accessing
117+
directories without read permission.
118+
109119
.. versionchanged:: 3.5
110120
Support for recursive globs using "``**``".
111121

Doc/library/pathlib.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1351,6 +1351,11 @@ Reading directories
13511351
``False``, this method follows symlinks except when expanding "``**``"
13521352
wildcards. Set *recurse_symlinks* to ``True`` to always follow symlinks.
13531353

1354+
.. note::
1355+
Any :exc:`OSError` exceptions raised from scanning the filesystem are
1356+
suppressed. This includes :exc:`PermissionError` when accessing
1357+
directories without read permission.
1358+
13541359
.. audit-event:: pathlib.Path.glob self,pattern pathlib.Path.glob
13551360

13561361
.. versionchanged:: 3.12
@@ -1377,6 +1382,11 @@ Reading directories
13771382
The paths are returned in no particular order.
13781383
If you need a specific order, sort the results.
13791384

1385+
.. note::
1386+
Any :exc:`OSError` exceptions raised from scanning the filesystem are
1387+
suppressed. This includes :exc:`PermissionError` when accessing
1388+
directories without read permission.
1389+
13801390
.. seealso::
13811391
:ref:`pathlib-pattern-language` and :meth:`Path.glob` documentation.
13821392

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Document that :func:`glob.glob`, :func:`glob.iglob`,
2+
:meth:`pathlib.Path.glob`, and :meth:`pathlib.Path.rglob` silently suppress
3+
:exc:`OSError` exceptions raised from scanning the filesystem.

0 commit comments

Comments
 (0)