annotate Doc/lib/libcode.tex @ 6719:faebc1940432 legacy-trunk

Understand -Xlinker option.
author Guido van Rossum <guido@python.org>
date Tue, 02 Dec 1997 20:38:11 +0000
parents 35b14d78c61d
children e70c4af157d5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5842
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 % Template for a library manual section.
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
2
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
3 \section{Standard module \sectcode{code}}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 \label{module-code}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 \stmodindex{code}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
6
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 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
8 objects.
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 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
11
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 \renewcommand{\indexsubitem}{(in module code)}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
13
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 \begin{funcdesc}{compile_command}{source\,
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 \optional{filename\optional{\, symbol}}}
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 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
17 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
18 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
19 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
20 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
21 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
22
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 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
24 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
25 \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
26 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
27 \code{"eval"}.
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
28
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 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
30 \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
31 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
32 \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
33
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
34
35b14d78c61d added code.py; codehack.py is obsolete
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 \end{funcdesc}