annotate Doc/lib/libfnmatch.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 9ca27188da23
children 3468ea8645ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5344
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 \section{Standard Module \sectcode{fnmatch}}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 \stmodindex{fnmatch}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
3
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 This module provides support for Unix shell-style wildcards, which are
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 \emph{not} the same as Python's regular expressions (which are
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 documented in the \code{regex} module). The special characters used
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 in shell-style wildcards are:
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 \begin{itemize}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 \item[\code{*}] matches everything
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 \item[\code{?}] matches any single character
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 \item[\code{[}\var{seq}\code{]}] matches any character in \var{seq}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 \item[\code{[!}\var{seq}\code{]}] matches any character not in \var{seq}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 \end{itemize}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
14
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 Note that the filename separator (\code{'/'} on Unix) is \emph{not}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 special to this module. See module \code{glob} for pathname expansion
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 (\code{glob} uses \code{fnmatch} to match filename segments).
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
18
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 \begin{funcdesc}{fnmatch}{filename\, pattern}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 Test whether the \var{filename} string matches the \var{pattern}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 string, returning true or false. If the operating system is
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 case-insensitive, then both parameters will be normalized to all
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 lower- or upper-case before the comparision is performed. If you
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 require a case-sensitive comparision regardless of whether that's
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 standard for your operating system, use \code{fnmatchcase()} instead.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
27
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 \begin{funcdesc}{fnmatchcase}{}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 Test whether \var{filename} matches \var{pattern}, returning true or
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 false; the comparision is case-sensitive.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
32
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 \begin{funcdesc}{translate}{pattern}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 Translate a shell pattern into a corresponding regular expression,
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 returning a string describing the pattern. It does not compile the
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
36 expression.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
38