https://github.com/python/cpython/commit/8000a9de3c0b22f8202898a424c1008e13bd16ce
commit: 8000a9de3c0b22f8202898a424c1008e13bd16ce
branch: main
author: WYSIATI <[email protected]>
committer: vstinner <[email protected]>
date: 2026-04-09T12:44:24+02:00
summary:
gh-146646: Document that glob functions suppress OSError (#147996)
files:
A
Misc/NEWS.d/next/Documentation/2026-04-02-07-20-00.gh-issue-146646.GlobDoc1.rst
M Doc/library/glob.rst
M Doc/library/pathlib.rst
diff --git a/Doc/library/glob.rst b/Doc/library/glob.rst
index 52c44928153337..b24e4da7bc8c07 100644
--- a/Doc/library/glob.rst
+++ b/Doc/library/glob.rst
@@ -83,6 +83,11 @@ The :mod:`!glob` module defines the following functions:
This function may return duplicate path names if *pathname*
contains multiple "``**``" patterns and *recursive* is true.
+ .. note::
+ Any :exc:`OSError` exceptions raised from scanning the filesystem are
+ suppressed. This includes :exc:`PermissionError` when accessing
+ directories without read permission.
+
.. versionchanged:: 3.5
Support for recursive globs using "``**``".
@@ -106,6 +111,11 @@ The :mod:`!glob` module defines the following functions:
This function may return duplicate path names if *pathname*
contains multiple "``**``" patterns and *recursive* is true.
+ .. note::
+ Any :exc:`OSError` exceptions raised from scanning the filesystem are
+ suppressed. This includes :exc:`PermissionError` when accessing
+ directories without read permission.
+
.. versionchanged:: 3.5
Support for recursive globs using "``**``".
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index 2b4aa1ee209997..2867015042ee16 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -1351,6 +1351,11 @@ Reading directories
``False``, this method follows symlinks except when expanding "``**``"
wildcards. Set *recurse_symlinks* to ``True`` to always follow symlinks.
+ .. note::
+ Any :exc:`OSError` exceptions raised from scanning the filesystem are
+ suppressed. This includes :exc:`PermissionError` when accessing
+ directories without read permission.
+
.. audit-event:: pathlib.Path.glob self,pattern pathlib.Path.glob
.. versionchanged:: 3.12
@@ -1377,6 +1382,11 @@ Reading directories
The paths are returned in no particular order.
If you need a specific order, sort the results.
+ .. note::
+ Any :exc:`OSError` exceptions raised from scanning the filesystem are
+ suppressed. This includes :exc:`PermissionError` when accessing
+ directories without read permission.
+
.. seealso::
:ref:`pathlib-pattern-language` and :meth:`Path.glob` documentation.
diff --git
a/Misc/NEWS.d/next/Documentation/2026-04-02-07-20-00.gh-issue-146646.GlobDoc1.rst
b/Misc/NEWS.d/next/Documentation/2026-04-02-07-20-00.gh-issue-146646.GlobDoc1.rst
new file mode 100644
index 00000000000000..4e89270442a33b
--- /dev/null
+++
b/Misc/NEWS.d/next/Documentation/2026-04-02-07-20-00.gh-issue-146646.GlobDoc1.rst
@@ -0,0 +1,3 @@
+Document that :func:`glob.glob`, :func:`glob.iglob`,
+:meth:`pathlib.Path.glob`, and :meth:`pathlib.Path.rglob` silently suppress
+:exc:`OSError` exceptions raised from scanning the filesystem.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
