summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libglob.tex
blob: dbc6b6acc0cad1c79555b8c517bf733eafda9f9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
\section{Standard Module \sectcode{glob}}
\label{module-glob}
\stmodindex{glob}
\setindexsubitem{(in module glob)}

The \module{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 \code{*}, \code{?}, and character ranges
expressed with \code{[]} will be correctly matched.  This is done by
using the \function{os.listdir()} and \function{fnmatch.fnmatch()}
functions in concert, and not by actually invoking a subshell.  (For
tilde and shell variable expansion, use \function{os.path.expanduser()}
and \function{os.path.expandvars()}.)

\begin{funcdesc}{glob}{pathname}
Returns a possibly-empty list of path names that match \var{pathname},
which must be a string containing a path specification.
\var{pathname} can be either absolute (like
\file{/usr/src/Python\version/Makefile}) or relative (like
\file{../../Tools/*.gif}), and can contain shell-style wildcards.
\end{funcdesc}

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

\begin{verbatim}
>>> import glob
>>> glob.glob('./[0-9].*')
['./1.gif', './2.txt']
>>> glob.glob('*.gif')
['1.gif', 'card.gif']
>>> glob.glob('?.gif')
['1.gif']
\end{verbatim}