summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorJeremy Hylton <jeremy@alum.mit.edu>2001-12-04 02:48:52 (GMT)
committerJeremy Hylton <jeremy@alum.mit.edu>2001-12-04 02:48:52 (GMT)
commitdb5a93cd6adcdf21ade2d7299a42cbeb475e656f (patch)
tree1fab24f51043ae64df50b7466b04efb58c9bcf93 /Doc/lib
parent86424e333f1736591114da975c8d2926ba6f51f5 (diff)
downloadcpython-db5a93cd6adcdf21ade2d7299a42cbeb475e656f.zip
cpython-db5a93cd6adcdf21ade2d7299a42cbeb475e656f.tar.gz
cpython-db5a93cd6adcdf21ade2d7299a42cbeb475e656f.tar.bz2
Update docs to reflect new compile() and compileFile()
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/compiler.tex21
1 files changed, 18 insertions, 3 deletions
diff --git a/Doc/lib/compiler.tex b/Doc/lib/compiler.tex
index 860d2ca..0c7c06d 100644
--- a/Doc/lib/compiler.tex
+++ b/Doc/lib/compiler.tex
@@ -57,9 +57,24 @@ appropriate method on the \var{visitor} instance for each node
encountered.
\end{funcdesc}
-\begin{funcdesc}{compile}{path}
-Compile the file \var{path} and generate the corresponding \file{.pyc}
-file.
+\begin{funcdesc}{compile}{source, filename, mode, flags=None,
+ dont_inherit=None}
+Compile the string \var{source}, a Python module, statement or
+expression, into a code object that can be executed by the exec
+statement or \function{eval()}. This function is a replacement for the
+built-in \function{compile()} function.
+
+The \var{filename} will be used for run-time error messages.
+
+The \var{mode} must be 'exec' to compile a module, 'single' to compile a
+single (interactive) statement, or 'eval' to compile an expression.
+
+The \var{flags} and \var{dont_inherit} arguments affect future-related
+statements, but are not supported yet.
+\end{funcdesc}
+
+\begin{funcdesc}{compileFile}{source}
+Compiles the file \var{source} and generates a .pyc file.
\end{funcdesc}
The \module{compiler} package contains the following modules: