summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libshlex.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-12-22 18:24:13 (GMT)
committerFred Drake <fdrake@acm.org>1998-12-22 18:24:13 (GMT)
commit1189fa98eb09b50e1fcd6da373094ffa49e4acff (patch)
treec3a12fedd483fba98f4352f18e58bd13f7adae33 /Doc/lib/libshlex.tex
parent768ac6b804dc41f72e55b04a26f888e8f600fbae (diff)
downloadcpython-1189fa98eb09b50e1fcd6da373094ffa49e4acff.zip
cpython-1189fa98eb09b50e1fcd6da373094ffa49e4acff.tar.gz
cpython-1189fa98eb09b50e1fcd6da373094ffa49e4acff.tar.bz2
Adjust markup to match current conventions, and make it formattable.
Diffstat (limited to 'Doc/lib/libshlex.tex')
-rw-r--r--Doc/lib/libshlex.tex46
1 files changed, 26 insertions, 20 deletions
diff --git a/Doc/lib/libshlex.tex b/Doc/lib/libshlex.tex
index 8dded14..bf26e94 100644
--- a/Doc/lib/libshlex.tex
+++ b/Doc/lib/libshlex.tex
@@ -1,31 +1,36 @@
% Module and documentation by Eric S. Raymond, 21 Dec 1998
-\section{Standard Module \module{shlex}}
-\stmodindex{shlex}
-\label{module-shlex}
-The \code{shlex} class makes it easy to write lexical analyzers for
-simple syntaxes resembling that of the Unix shell. This will often
-be useful for writing minilanguages, e.g. in run control files for
+\section{\module{shlex} ---
+ Simple lexical analysis}
+
+\declaremodule{standard}{shlex}
+\moduleauthor{Eric S. Raymond}{esr@snark.thyrsus.com}
+\sectionauthor{Eric S. Raymond}{esr@snark.thyrsus.com}
+
+
+The \class{shlex} class makes it easy to write lexical analyzers for
+simple syntaxes resembling that of the \UNIX{} shell. This will often
+be useful for writing minilanguages, e.g.\ in run control files for
Python applications.
\begin{classdesc}{shlex}{\optional{stream}}
A \class{shlex} instance or subclass instance is a lexical analyzer
object. The initialization argument, if present, specifies where to
read characters from. It must be a file- or stream-like object with
-\method{read} and \method{readline} methods. If no argument is given,
-input will be taken from sys.stdin.
+\method{read()} and \method{readline()} methods. If no argument is given,
+input will be taken from \code{sys.stdin}.
\end{classdesc}
-\subsection{shlex Objects}
-\label{shlex-objects}
+\subsection{shlex Objects \label{shlex-objects}}
A \class{shlex} instance has the following methods:
\begin{methoddesc}{get_token}{}
-Return a token. If tokens have been stacked using \method{push_token},
-pop a token off the stack. Otherwise, read one from the input stream.
-If reading encounters an immediate end-of-file, '' is returned.
+Return a token. If tokens have been stacked using
+\method{push_token()}, pop a token off the stack. Otherwise, read one
+from the input stream. If reading encounters an immediate
+end-of-file, an empty string is returned.
\end{methoddesc}
\begin{methoddesc}{push_token}{str}
@@ -39,17 +44,18 @@ for debugging:
\begin{memberdesc}{commenters}
The string of characters that are recognized as comment beginners.
All characters from the comment beginner to end of line are ignored.
-Includes just '#' by default.
+Includes just \character{\#} by default.
\end{memberdesc}
\begin{memberdesc}{wordchars}
The string of characters that will accumulate into multi-character
-tokens. By default, includes all ASCII alphanumerics and underscore.
+tokens. By default, includes all \ASCII{} alphanumerics and
+underscore.
\end{memberdesc}
\begin{memberdesc}{whitespace}
Characters that will be considered whitespace and skipped. Whitespace
-bounds tokens. By default, includes space and tab and linefeed and
+bounds tokens. By default, includes space, tab, linefeed and
carriage-return.
\end{memberdesc}
@@ -57,14 +63,14 @@ carriage-return.
Characters that will be considered string quotes. The token
accumulates until the same quote is encountered again (thus, different
quote types protect each other as in the shall.) By default, includes
-ASCII single and double quotes.
+\ASCII{} single and double quotes.
\end{memberdesc}
Note that any character not declared to be a word character,
whitespace, or a quote will be returned as a single-character token.
Quote and comment characters are not recognized within words. Thus,
-the bare words ``ain't'' and ``ain#t'' would be returned as single
+the bare words \samp{ain't} and \samp{ain\#t} would be returned as single
tokens by the default parser.
\begin{memberdesc}{lineno}
@@ -72,6 +78,6 @@ Source line number (count of newlines seen so far plus one).
\end{memberdesc}
\begin{memberdesc}{token}
-The token buffer. It may be useful to examine this when catching exceptions.
+The token buffer. It may be useful to examine this when catching
+exceptions.
\end{memberdesc}
-