From: Barney Gale <barney.gale@gmail.com>
Date: Tue, 16 Jan 2024 22:39:09 +0000 (+0000)
Subject: [3.12] GH-78988: Document `pathlib.Path.glob()` exception propagation. (GH-114036... 
X-Git-Tag: v3.12.2~165
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0ee681a665da36267d9e87ece472b9a9c5da9c13;p=thirdparty%2FPython%2Fcpython.git

[3.12] GH-78988: Document `pathlib.Path.glob()` exception propagation. (GH-114036) (#114154)

We propagate the `OSError` from the `is_dir()` call on the top-level
directory, and suppress all others.

(cherry picked from commit 7092b3f1319269accf4c02f08256d51f111b9ca3)
---

diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index d8fa4a27a28a..46a4d10b11d6 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -916,6 +916,10 @@ call fails (for example because the path doesn't exist).
        PosixPath('setup.py'),
        PosixPath('test_pathlib.py')]
 
+   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.