libcode.tex 1.23 KB
Newer Older
Fred Drake's avatar
Fred Drake committed
1 2
\section{\module{code} ---
         Code object services.}
3 4 5 6
\declaremodule{standard}{code}

\modulesynopsis{Code object services.}

7 8

The \code{code} module defines operations pertaining to Python code
9
objects.  It defines the following function:
10 11


12
\begin{funcdesc}{compile_command}{source, \optional{filename\optional{, symbol}}}
13 14 15 16 17 18 19 20 21
This function is useful for programs that want to emulate Python's
interpreter main loop (a.k.a. the read-eval-print loop).  The tricky
part is to determine when the user has entered an incomplete command
that can be completed by entering more text (as opposed to a complete
command or a syntax error).  This function \emph{almost} always makes
the same decision as the real interpreter main loop.

Arguments: \var{source} is the source string; \var{filename} is the
optional filename from which source was read, defaulting to
22 23 24
\code{'<input>'}; and \var{symbol} is the optional grammar start
symbol, which should be either \code{'single'} (the default) or
\code{'eval'}.
25 26 27 28

Return a code object (the same as \code{compile(\var{source},
\var{filename}, \var{symbol})}) if the command is complete and valid;
return \code{None} if the command is incomplete; raise
29
\exception{SyntaxError} if the command is a syntax error.
30
\end{funcdesc}