Added docs for glob

This commit is contained in:
Guido van Rossum 1997-03-25 22:07:53 +00:00
parent 20af95b433
commit e6d579ddbc
7 changed files with 77 additions and 5 deletions

View File

@ -113,7 +113,7 @@ LIBFILES = lib.tex \
libxdrlib.tex libimghdr.tex \
librestricted.tex librexec.tex libbastion.tex \
libformatter.tex liboperator.tex libsoundex.tex libresource.tex \
libstat.tex libstrio.tex libundoc.tex libmailcap.tex
libstat.tex libstrio.tex libundoc.tex libmailcap.tex libglob.tex
# Library document
lib.dvi: $(LIBFILES)

View File

@ -23,4 +23,7 @@ systems as well. Here's an overview:
\item[errno]
--- Standard errno system symbols.
\item[glob]
--- Unix shell style pathname pattern expansion.
\end{description}

35
Doc/lib/libglob.tex Normal file
View File

@ -0,0 +1,35 @@
\section{Standard Module \sectcode{glob}}
\stmodindex{glob}
\renewcommand{\indexsubitem}{(in module glob)}
The \code{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 \verb\*\, \verb\?\, and character ranges
expressed with \verb\[]\ will be correctly matched. This is done by
using the \code{os.listdir()} and \code{fnmatch.fnmatch()} functions
in concert, and not by actually invoking a subshell. (For tilde and
shell variable expansion, use \code{os.path.expanduser(}) and
\code{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/Python1.4/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}. \code{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}

View File

@ -53,8 +53,6 @@ quopri.py -- Conversions to/from quoted-printable transport encoding
Some of these are very old and/or not very robust; marked with ``hmm''.
glob.py -- filename globbing (high level interface)
fnmatch.py -- filename globbing (low level interface)
calendar.py -- Calendar printing functions

View File

@ -23,4 +23,7 @@ systems as well. Here's an overview:
\item[errno]
--- Standard errno system symbols.
\item[glob]
--- Unix shell style pathname pattern expansion.
\end{description}

35
Doc/libglob.tex Normal file
View File

@ -0,0 +1,35 @@
\section{Standard Module \sectcode{glob}}
\stmodindex{glob}
\renewcommand{\indexsubitem}{(in module glob)}
The \code{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 \verb\*\, \verb\?\, and character ranges
expressed with \verb\[]\ will be correctly matched. This is done by
using the \code{os.listdir()} and \code{fnmatch.fnmatch()} functions
in concert, and not by actually invoking a subshell. (For tilde and
shell variable expansion, use \code{os.path.expanduser(}) and
\code{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/Python1.4/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}. \code{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}

View File

@ -53,8 +53,6 @@ quopri.py -- Conversions to/from quoted-printable transport encoding
Some of these are very old and/or not very robust; marked with ``hmm''.
glob.py -- filename globbing (high level interface)
fnmatch.py -- filename globbing (low level interface)
calendar.py -- Calendar printing functions