Source code: Lib/glob.py
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
ranges expressed with
 will be correctly matched. This is done by using
fnmatch.fnmatch() functions in concert, and
not by actually invoking a subshell. Note that unlike
glob treats filenames beginning with a dot (
.) as special cases.
(For tilde and shell variable expansion, use
For a literal match, wrap the meta-characters in brackets.
'[?]' matches the character
pathlib module offers high-level path objects.
glob(pathname, *, root_dir=None, dir_fd=None, recursive=False)¶
Return a possibly-empty list of path names that match pathname, which must be a string containing a path specification. pathname can be either absolute (like
/usr/src/Python-1.5/Makefile) or relative (like
../../Tools/*/*.gif), and can contain shell-style wildcards. Broken symlinks are included in the results (as in the shell). Whether or not the results are sorted depends on the file system. If a file that satisfies conditions is removed or added during the call of this function, whether a path name for that file be included is unspecified.
If root_dir is not
None, it should be a path-like object specifying the root directory for searching. It has the same effect on
glob()as changing the current directory before calling it. If pathname is relative, the result will contain paths relative to root_dir.
This function can support paths relative to directory descriptors with the dir_fd parameter.
If recursive is true, the pattern “
**” will match any files and zero or more directories, subdirectories and symbolic links to directories. If the pattern is followed by an
os.altsepthen files will not match.
Raises an auditing event
Using the “
**” pattern in large directory trees may consume an inordinate amount of time.
Changed in version 3.5: Support for recursive globs using “
Changed in version 3.10: Added the root_dir and dir_fd parameters.
iglob(pathname, *, root_dir=None, dir_fd=None, recursive=False)¶
Raises an auditing event
Escape all special characters (
'['). 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
New in version 3.4.
For example, consider a directory containing the following files:
card.gif and a subdirectory
which contains only the file
glob() will produce
the following results. Notice how any leading components of the path are
>>> import glob >>> glob.glob('./[0-9].*') ['./1.gif', './2.txt'] >>> glob.glob('*.gif') ['1.gif', 'card.gif'] >>> glob.glob('?.gif') ['1.gif'] >>> glob.glob('**/*.txt', recursive=True) ['2.txt', 'sub/3.txt'] >>> glob.glob('./**/', recursive=True) ['./', './sub/']
If the directory contains files starting with
. they won’t be matched by
default. For example, consider a directory containing
>>> import glob >>> glob.glob('*.gif') ['card.gif'] >>> glob.glob('.c*') ['.card.gif']
Shell-style filename (not path) expansion