annotate Doc/libglob.tex @ 5817:48b94de85bf3 legacy-trunk

Extensive changes by AMK.
author Guido van Rossum <guido@python.org>
date Thu, 17 Jul 1997 16:29:42 +0000
parents f5bfb9c4c364
children 3468ea8645ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5218
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 \section{Standard Module \sectcode{glob}}
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 \stmodindex{glob}
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
3 \renewcommand{\indexsubitem}{(in module glob)}
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
4
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 The \code{glob} module finds all the pathnames matching a specified
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 pattern according to the rules used by the \UNIX{} shell. No tilde
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 expansion is done, but \verb\*\, \verb\?\, and character ranges
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 expressed with \verb\[]\ will be correctly matched. This is done by
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 using the \code{os.listdir()} and \code{fnmatch.fnmatch()} functions
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 in concert, and not by actually invoking a subshell. (For tilde and
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 shell variable expansion, use \code{os.path.expanduser(}) and
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 \code{os.path.expandvars()}.)
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
13
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 \begin{funcdesc}{glob}{pathname}
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 Returns a possibly-empty list of path names that match \var{pathname},
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 which must be a string containing a path specification.
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 \var{pathname} can be either absolute (like
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 \file{/usr/src/Python1.4/Makefile}) or relative (like
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 \file{../../Tools/*.gif}), and can contain shell-style wildcards.
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 \end{funcdesc}
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
21
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 For example, consider a directory containing only the following files:
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 \file{1.gif}, \file{2.txt}, and \file{card.gif}. \code{glob.glob()}
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 will produce the following results. Notice how any leading components
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 of the path are preserved.
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
26
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 \begin{verbatim}
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 >>> import glob
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 >>> glob.glob('./[0-9].*')
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 ['./1.gif', './2.txt']
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 >>> glob.glob('*.gif')
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
32 ['1.gif', 'card.gif']
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 >>> glob.glob('?.gif')
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 ['1.gif']
f5bfb9c4c364 Added docs for glob
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 \end{verbatim}