Skip to content

[3.14] gh-148765: Fix description of *include_hidden* parameter in glob.glob() docs (GH-148768) #153174

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

Merged
StanFromIreland merged 1 commit into from
Jul 6, 2026
+9 −7
Merged

[3.14] gh-148765: Fix description of *include_hidden* parameter in glob.glob() docs (GH-148768) #153174

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
7 changes: 4 additions & 3 deletions Doc/library/glob.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ not by actually invoking a subshell.
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
By default, 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
Expand Down Expand Up @@ -70,7 +70,8 @@ The :mod:`!glob` module defines the following functions:
pattern is followed by an :data:`os.sep` or :data:`os.altsep` then files will not
match.

If *include_hidden* is true, "``**``" pattern will match hidden directories.
If *include_hidden* is true, wildcards can match path segments that
begin with a dot (``.``).

.. audit-event:: glob.glob pathname,recursive glob.glob
.. audit-event:: glob.glob/2 pathname,recursive,root_dir,dir_fd glob.glob
Expand Down Expand Up @@ -131,7 +132,7 @@ The :mod:`!glob` module defines the following functions:
Escape all special characters (``'?'``, ``'*'`` and ``'['``).
This is useful if you want to match an arbitrary literal string that may
have special characters in it. Special characters in drive/UNC
sharepoints are not escaped, e.g. on Windows
sharepoints are not escaped, for example on Windows
``escape('//?/c:/Quo vadis?.txt')`` returns ``'//?/c:/Quo vadis[?].txt'``.

.. versionadded:: 3.4
Expand Down
8 changes: 4 additions & 4 deletions Lib/glob.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ def glob(pathname, *, root_dir=None, dir_fd=None, recursive=False,
If `dir_fd` is not None, it should be a file descriptor referring to a
directory, and paths will then be relative to that directory.

If `include_hidden` is true, the patterns '*', '?', '**' will match
hidden directories.
If `include_hidden` is true, wildcards can match path segments beginning
with a dot ('.').

If `recursive` is true, the pattern '**' will match any files and
zero or more directories and subdirectories.
Expand Down Expand Up @@ -64,8 +64,8 @@ def iglob(pathname, *, root_dir=None, dir_fd=None, recursive=False,
If `dir_fd` is not None, it should be a file descriptor referring to a
directory, and paths will then be relative to that directory.

If `include_hidden` is true, the patterns '*', '?', '**' will match
hidden directories.
If `include_hidden` is true, wildcards can match path segments beginning
with a dot ('.').

If `recursive` is true, the pattern '**' will match any files and
zero or more directories and subdirectories.
Expand Down
1 change: 1 addition & 0 deletions Misc/ACKS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1727,6 +1727,7 @@ Ha Shao
Richard Shapiro
Soumya Sharma
Varun Sharma
Eoin Shaughnessy
Daniel Shaulov
Vlad Shcherbina
Justin Sheehy
Expand Down
Loading