Skip to content

gh-146646: Document that glob functions suppress OSError #147996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WYSIATI wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

gh-146646: Document that glob functions suppress OSError #147996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Doc/library/glob.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 "``**``".

Expand All @@ -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 "``**``".

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2026-04-02-07-20-00.gh-issue-146646.GlobDoc1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document that :func:`glob.glob` and :func:`glob.iglob` silently suppress
:exc:`OSError` exceptions raised from scanning the filesystem.
Loading