summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libpycompile.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-08-11 15:46:25 (GMT)
committerFred Drake <fdrake@acm.org>1998-08-11 15:46:25 (GMT)
commit4756bb3e54824be3b892ff0323932fbc3fb5ec4a (patch)
treeab08076fc393691b3ecb58b52aff358e94357503 /Doc/lib/libpycompile.tex
parent64c105d3d26a8cdb40616f5c2b8f81a843e8b5a2 (diff)
downloadcpython-4756bb3e54824be3b892ff0323932fbc3fb5ec4a.zip
cpython-4756bb3e54824be3b892ff0323932fbc3fb5ec4a.tar.gz
cpython-4756bb3e54824be3b892ff0323932fbc3fb5ec4a.tar.bz2
Documentation for the py_compile module.
Diffstat (limited to 'Doc/lib/libpycompile.tex')
-rw-r--r--Doc/lib/libpycompile.tex35
1 files changed, 35 insertions, 0 deletions
diff --git a/Doc/lib/libpycompile.tex b/Doc/lib/libpycompile.tex
new file mode 100644
index 0000000..fad749b
--- /dev/null
+++ b/Doc/lib/libpycompile.tex
@@ -0,0 +1,35 @@
+% Documentation based on module docstrings, by Fred L. Drake, Jr.
+% <fdrake@acm.org>
+
+\section{\module{py_compile} ---
+ Compile Python source files.}
+
+\declaremodule[pycompile]{standard}{py_compile}
+
+\modulesynopsis{Compile Python source files to byte-code files.}
+
+
+\indexii{file}{byte-code}
+The \module{py_compile} module provides a single function to generate
+a byte-code file from a source file.
+
+Though not often needed, this function can be useful when installing
+modules for shared use, especially if some of the users may not have
+permission to write the byte-code cache files in the directory
+containing the source code.
+
+
+\begin{funcdesc}{compile}{file\optional{, cfile\optional{, dfile}}}
+ Compile a source file to byte-code and write out the byte-code cache
+ file. The source code is loaded from the file name \var{file}. The
+ byte-code is written to \var{cfile}, which defaults to \var{file}
+ \code{+} \code{'c'} (\code{'o'} if optimization is enabled in the
+ current interpreter). If \var{dfile} is specified, it is used as
+ the name of the source file in error messages instead of \var{file}.
+\end{funcdesc}
+
+
+\begin{seealso}
+ \seemodule{compileall}{Utilities to compile all Python source files
+ in a directory tree.}
+\end{seealso}