Mercurial > cpython-lru_cache-weakref

annotate Doc/libcode.tex @ 6896:e70c4af157d5 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Make the word "Module" in the section header start with an upper-case "M". Remove the leading comment declaring this to be a template for module documentation.
author Fred Drake <fdrake@acm.org>
date Wed, 17 Dec 1997 13:47:39 +0000
parents 35b14d78c61d
children 319a51c381ce
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6896
e70c4af157d5 Make the word "Module" in the section header start with an upper-case "M".
Fred Drake <fdrake@acm.org>
parents: 5842
diff changeset
1 \section{Standard Module \sectcode{code}}
5842
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 \label{module-code}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
3 \stmodindex{code}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
4
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 The \code{code} module defines operations pertaining to Python code
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 objects.
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 The \code{code} module defines the following functions:
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
9
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 \renewcommand{\indexsubitem}{(in module code)}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
11
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 \begin{funcdesc}{compile_command}{source\,
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 \optional{filename\optional{\, symbol}}}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 This function is useful for programs that want to emulate Python's
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 interpreter main loop (a.k.a. the read-eval-print loop). The tricky
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 part is to determine when the user has entered an incomplete command
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 that can be completed by entering more text (as opposed to a complete
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 command or a syntax error). This function \emph{almost} always makes
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 the same decision as the real interpreter main loop.
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
20
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 Arguments: \var{source} is the source string; \var{filename} is the
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 optional filename from which source was read, defaulting to
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 \code{"<input>"}; and \var{symbol} is the optional grammar start
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 symbol, which should be either \code{"single"} (the default) or
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 \code{"eval"}.
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
26
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 Return a code object (the same as \code{compile(\var{source},
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 \var{filename}, \var{symbol})}) if the command is complete and valid;
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 return \code{None} if the command is incomplete; raise
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 \code{SyntaxError} if the command is a syntax error.
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
31
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
32
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 \end{funcdesc}