From: Guido van Rossum <guido@python.org>
Date: Tue, 25 Mar 1997 22:07:53 +0000 (+0000)
Subject: Added docs for glob
X-Git-Tag: v1.5a1~258
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e6d579ddbc3c2859476da5d49dc781cbd2105c83;p=python

Added docs for glob
---

diff --git a/Doc/Makefile b/Doc/Makefile
index db631576b8..a0eebc635e 100644
--- a/Doc/Makefile
+++ b/Doc/Makefile
@@ -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)
diff --git a/Doc/lib/liballos.tex b/Doc/lib/liballos.tex
index c167109cb6..5cf7f9492c 100644
--- a/Doc/lib/liballos.tex
+++ b/Doc/lib/liballos.tex
@@ -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}
diff --git a/Doc/lib/libglob.tex b/Doc/lib/libglob.tex
new file mode 100644
index 0000000000..142afd8021
--- /dev/null
+++ b/Doc/lib/libglob.tex
@@ -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}
diff --git a/Doc/lib/libundoc.tex b/Doc/lib/libundoc.tex
index bcd52a9fae..c2ad10227f 100644
--- a/Doc/lib/libundoc.tex
+++ b/Doc/lib/libundoc.tex
@@ -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
diff --git a/Doc/liballos.tex b/Doc/liballos.tex
index c167109cb6..5cf7f9492c 100644
--- a/Doc/liballos.tex
+++ b/Doc/liballos.tex
@@ -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}
diff --git a/Doc/libglob.tex b/Doc/libglob.tex
new file mode 100644
index 0000000000..142afd8021
--- /dev/null
+++ b/Doc/libglob.tex
@@ -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}
diff --git a/Doc/libundoc.tex b/Doc/libundoc.tex
index bcd52a9fae..c2ad10227f 100644
--- a/Doc/libundoc.tex
+++ b/Doc/libundoc.tex
@@ -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