44 lines
1.8 KiB
TeX
44 lines
1.8 KiB
TeX
\section{\module{codeop} ---
|
|
Compile Python code}
|
|
|
|
% LaTeXed from excellent doc-string.
|
|
|
|
\declaremodule{standard}{codeop}
|
|
\sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}
|
|
\modulesynopsis{Compile (possibly incomplete) Python code.}
|
|
|
|
The \module{codeop} module provides a function to compile Python code
|
|
with hints on whether it is certainly complete, possibly complete or
|
|
definitely incomplete. This is used by the \refmodule{code} module
|
|
and should not normally be used directly.
|
|
|
|
The \module{codeop} module defines the following function:
|
|
|
|
\begin{funcdesc}{compile_command}
|
|
{source\optional{, filename\optional{, symbol}}}
|
|
Tries to compile \var{source}, which should be a string of Python
|
|
code and return a code object if \var{source} is valid
|
|
Python code. In that case, the filename attribute of the code object
|
|
will be \var{filename}, which defaults to \code{'<input>'}.
|
|
Returns \code{None} if \var{source} is \emph{not} valid Python
|
|
code, but is a prefix of valid Python code.
|
|
|
|
If there is a problem with \var{source}, an exception will be raised.
|
|
\exception{SyntaxError} is raised if there is invalid Python syntax,
|
|
and \exception{OverflowError} if there is an invalid numeric
|
|
constant.
|
|
|
|
The \var{symbol} argument determines whether \var{source} is compiled
|
|
as a statement (\code{'single'}, the default) or as an expression
|
|
(\code{'eval'}). Any other value will cause \exception{ValueError} to
|
|
be raised.
|
|
|
|
\strong{Caveat:}
|
|
It is possible (but not likely) that the parser stops parsing
|
|
with a successful outcome before reaching the end of the source;
|
|
in this case, trailing symbols may be ignored instead of causing an
|
|
error. For example, a backslash followed by two newlines may be
|
|
followed by arbitrary garbage. This will be fixed once the API
|
|
for the parser is better.
|
|
\end{funcdesc}
|