summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-08-21 20:56:21 (GMT)
committerFred Drake <fdrake@acm.org>2002-08-21 20:56:21 (GMT)
commit61cf4407be9c726c935e1fe82b06a2617b15287e (patch)
tree6864cac7e3c8e42b47c4be2f56cd8fb2aeb24b03 /Doc/lib
parenta96f1a3c08fbe9452c24bb163b4480b5c67d1e8d (diff)
downloadcpython-61cf4407be9c726c935e1fe82b06a2617b15287e.zip
cpython-61cf4407be9c726c935e1fe82b06a2617b15287e.tar.gz
cpython-61cf4407be9c726c935e1fe82b06a2617b15287e.tar.bz2
Added a main() function and support to run this module as a script.
Closes SF feature request #588768.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libpycompile.tex16
1 files changed, 14 insertions, 2 deletions
diff --git a/Doc/lib/libpycompile.tex b/Doc/lib/libpycompile.tex
index ebbc9b9..a28b4fe 100644
--- a/Doc/lib/libpycompile.tex
+++ b/Doc/lib/libpycompile.tex
@@ -10,8 +10,9 @@
\indexii{file}{byte-code}
-The \module{py_compile} module provides a single function to generate
-a byte-code file from a source file.
+The \module{py_compile} module provides a function to generate a
+byte-code file from a source file, and another function used when the
+module source file is invoked as a script.
Though not often needed, this function can be useful when installing
modules for shared use, especially if some of the users may not have
@@ -29,6 +30,17 @@ containing the source code.
\end{funcdesc}
+\begin{funcdesc}{main}{\optional{args}}
+ Compile several source files. The files named in \var{args} (or on
+ the command line, if \var{args} is not specified) are compiled and
+ the resulting bytecode is cached in the normal manner. This
+ function does not search a directory structure to locate source
+ files; it only compiles files named explicitly.
+\end{funcdesc}
+
+When this module is run as a script, the \function{main()} is used to
+compile all the files named on the command line.
+
\begin{seealso}
\seemodule{compileall}{Utilities to compile all Python source files
in a directory tree.}