https://github.com/python/cpython/commit/ed672f7a8a3c843d8e6e6b673d5a7c1f752f208c
commit: ed672f7a8a3c843d8e6e6b673d5a7c1f752f208c
branch: main
author: Ned Batchelder <[email protected]>
committer: nedbat <[email protected]>
date: 2025-10-19T16:16:35-04:00
summary:
docs: be clearer that glob results are unordered (#140184)
* docs: be clearer that glob results are unordered
* trim down the opening paragraph
files:
M Doc/library/glob.rst
M Lib/glob.py
diff --git a/Doc/library/glob.rst b/Doc/library/glob.rst
index 59ad1b07f27338..52c44928153337 100644
--- a/Doc/library/glob.rst
+++ b/Doc/library/glob.rst
@@ -18,23 +18,27 @@
single: - (minus); in glob-style wildcards
single: . (dot); in glob-style wildcards
-The :mod:`glob` module finds all the pathnames matching a specified pattern
-according to the rules used by the Unix shell, although results are returned in
-arbitrary order. No tilde expansion is done, but ``*``, ``?``, and character
+The :mod:`!glob` module finds pathnames
+using pattern matching rules similar to the Unix shell.
+No tilde expansion is done, but ``*``, ``?``, and character
ranges expressed with ``[]`` will be correctly matched. This is done by using
the :func:`os.scandir` and :func:`fnmatch.fnmatch` functions in concert, and
not by actually invoking a subshell.
-Note that files beginning with a dot (``.``) can only be matched by
+.. note::
+ The pathnames are returned in no particular order. If you need a specific
+ order, sort the results.
+
+Files beginning with a dot (``.``) can only be matched by
patterns that also start with a dot,
unlike :func:`fnmatch.fnmatch` or :func:`pathlib.Path.glob`.
-(For tilde and shell variable expansion, use :func:`os.path.expanduser` and
-:func:`os.path.expandvars`.)
+For tilde and shell variable expansion, use :func:`os.path.expanduser` and
+:func:`os.path.expandvars`.
For a literal match, wrap the meta-characters in brackets.
For example, ``'[?]'`` matches the character ``'?'``.
-The :mod:`glob` module defines the following functions:
+The :mod:`!glob` module defines the following functions:
.. function:: glob(pathname, *, root_dir=None, dir_fd=None, recursive=False, \
@@ -51,7 +55,7 @@ The :mod:`glob` module defines the following functions:
If *root_dir* is not ``None``, it should be a :term:`path-like object`
specifying the root directory for searching. It has the same effect on
- :func:`glob` as changing the current directory before calling it. If
+ :func:`!glob` as changing the current directory before calling it. If
*pathname* is relative, the result will contain paths relative to
*root_dir*.
diff --git a/Lib/glob.py b/Lib/glob.py
index 5d42077003a240..c2f8ce279aba64 100644
--- a/Lib/glob.py
+++ b/Lib/glob.py
@@ -22,6 +22,9 @@ def glob(pathname, *, root_dir=None, dir_fd=None,
recursive=False,
dot are special cases that are not matched by '*' and '?'
patterns by default.
+ The order of the returned list is undefined. Sort it if you need a
+ particular order.
+
If `include_hidden` is true, the patterns '*', '?', '**' will match hidden
directories.
@@ -40,6 +43,9 @@ def iglob(pathname, *, root_dir=None, dir_fd=None,
recursive=False,
dot are special cases that are not matched by '*' and '?'
patterns.
+ The order of the returned paths is undefined. Sort them if you need a
+ particular order.
+
If recursive is true, the pattern '**' will match any files and
zero or more directories and subdirectories.
"""
_______________________________________________
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]
