python-clinic / Doc / library / glob.rst

:mod:`glob` --- Unix style pathname pattern expansion

Source code: :source:`Lib/`

The :mod:`glob` module finds all the pathnames matching a specified pattern according to the rules used by 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.listdir` and :func:`fnmatch.fnmatch` functions in concert, and not by actually invoking a subshell. Note that unlike :func:`fnmatch.fnmatch`, :mod:`glob` treats filenames beginning with a dot (.) as special cases. (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 '?'.

For example, consider a directory containing only the following files: :file:`1.gif`, :file:`2.txt`, and :file:`card.gif`. :func:`glob` will produce the following results. Notice how any leading components of the path are preserved.

>>> import glob
>>> glob.glob('./[0-9].*')
['./1.gif', './2.txt']
>>> glob.glob('*.gif')
['1.gif', 'card.gif']
>>> glob.glob('?.gif')

If the directory contains files starting with . they won't be matched by default. For example, consider a directory containing :file:`card.gif` and :file:`.card.gif`:

>>> import glob
>>> glob.glob('*.gif')
>>> glob.glob('.c*')