pythonGH-78988: Document pathlib.Path.glob() exception propagation.

We propagate the `OSError` from the `is_dir()` call on the top-level directory, and suppress all others.
barneygale · Jan 13, 2024 · 5f6d3a0 · 5f6d3a0
1 parent 77b45fa
commit 5f6d3a0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
@@ -993,6 +993,10 @@ call fails (for example because the path doesn't exist).
       Set *follow_symlinks* to ``True`` or ``False`` to improve performance
       of recursive globbing.
 
+   This method calls :meth:`Path.is_dir` on the top-level directory and
+   propagates any :exc:`OSError` exception that is raised. Subsequent
+   :exc:`OSError` exceptions from scanning directories are suppressed.
+
    By default, or when the *case_sensitive* keyword-only argument is set to
    ``None``, this method matches paths using platform-specific casing rules:
    typically, case-sensitive on POSIX, and case-insensitive on Windows.

diff --git a/Misc/NEWS.d/next/Documentation/2024-01-13-19-36-51.gh-issue-78988.QC-EQP.rst b/Misc/NEWS.d/next/Documentation/2024-01-13-19-36-51.gh-issue-78988.QC-EQP.rst
@@ -0,0 +1 @@
+Document :meth:`pathlib.Path.glob` exception propagation.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Document :meth:`pathlib.Path.glob` exception propagation.