Skip to content

gh-142972: Document arbitrary ordering in Path.glob #143025

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
johnslavik wants to merge 7 commits into
base: main
Choose a base branch
from
Open

gh-142972: Document arbitrary ordering in Path.glob #143025

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0367991
Document arbitrary ordering in `Path.glob`
johnslavik Dec 20, 2025
32e3e01
Merge branch 'main' into document-glob-unordered-paths
johnslavik Dec 20, 2025
ec269e1
Move note elsewhere to fix unexpected indentation
johnslavik Dec 20, 2025
1974bfa
Address review requests
johnslavik Dec 20, 2025
94c62de
Say 'sort the results' to avoid amphibology
johnslavik Dec 20, 2025
fa24bfb
Use same wording as in glob docs
johnslavik Dec 20, 2025
38a3bf3
Move note in `Path.rglob` to the right place
johnslavik Dec 20, 2025
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
8 changes: 8 additions & 0 deletions Doc/library/pathlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1331,6 +1331,10 @@ Reading directories
PosixPath('setup.py'),
PosixPath('test_pathlib.py')]

.. note::
The paths are returned in no particular order.
If you need a specific order, sort the results.

.. seealso::
:ref:`pathlib-pattern-language` documentation.

Expand Down Expand Up @@ -1362,6 +1366,10 @@ Reading directories

.. method:: Path.rglob(pattern, *, case_sensitive=None, recurse_symlinks=False)

.. note::
The paths are returned in no particular order.
If you need a specific order, sort the results.

Glob the given relative *pattern* recursively. This is like calling
:func:`Path.glob` with "``**/``" added in front of the *pattern*.

Expand Down
Loading