2007-08-15 14:28:22 +00:00
|
|
|
:mod:`py_compile` --- Compile Python source files
|
|
|
|
|
=================================================
|
|
|
|
|
|
|
|
|
|
.. module:: py_compile
|
|
|
|
|
:synopsis: Generate byte-code files from Python source files.
|
Merged revisions 59605-59624 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r59606 | georg.brandl | 2007-12-29 11:57:00 +0100 (Sat, 29 Dec 2007) | 2 lines
Some cleanup in the docs.
........
r59611 | martin.v.loewis | 2007-12-29 19:49:21 +0100 (Sat, 29 Dec 2007) | 2 lines
Bug #1699: Define _BSD_SOURCE only on OpenBSD.
........
r59612 | raymond.hettinger | 2007-12-29 23:09:34 +0100 (Sat, 29 Dec 2007) | 1 line
Simpler documentation for itertools.tee(). Should be backported.
........
r59613 | raymond.hettinger | 2007-12-29 23:16:24 +0100 (Sat, 29 Dec 2007) | 1 line
Improve docs for itertools.groupby(). The use of xrange(0) to create a unique object is less obvious than object().
........
r59620 | christian.heimes | 2007-12-31 15:47:07 +0100 (Mon, 31 Dec 2007) | 3 lines
Added wininst-9.0.exe executable for VS 2008
Integrated bdist_wininst into PCBuild9 directory
........
r59621 | christian.heimes | 2007-12-31 15:51:18 +0100 (Mon, 31 Dec 2007) | 1 line
Moved PCbuild directory to PC/VS7.1
........
r59622 | christian.heimes | 2007-12-31 15:59:26 +0100 (Mon, 31 Dec 2007) | 1 line
Fix paths for build bot
........
r59623 | christian.heimes | 2007-12-31 16:02:41 +0100 (Mon, 31 Dec 2007) | 1 line
Fix paths for build bot, part 2
........
r59624 | christian.heimes | 2007-12-31 16:18:55 +0100 (Mon, 31 Dec 2007) | 1 line
Renamed PCBuild9 directory to PCBuild
........
2007-12-31 16:14:33 +00:00
|
|
|
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
|
|
|
|
|
.. documentation based on module docstrings
|
2007-08-15 14:28:22 +00:00
|
|
|
|
|
|
|
|
.. index:: pair: file; byte-code
|
|
|
|
|
|
|
|
|
|
The :mod:`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 permission to write the
|
|
|
|
|
byte-code cache files in the directory containing the source code.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. exception:: PyCompileError
|
|
|
|
|
|
|
|
|
|
Exception raised when an error occurs while attempting to compile the file.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. function:: compile(file[, cfile[, dfile[, doraise]]])
|
|
|
|
|
|
|
|
|
|
Compile a source file to byte-code and write out the byte-code cache file. The
|
|
|
|
|
source code is loaded from the file name *file*. The byte-code is written to
|
|
|
|
|
*cfile*, which defaults to *file* ``+`` ``'c'`` (``'o'`` if optimization is
|
|
|
|
|
enabled in the current interpreter). If *dfile* is specified, it is used as the
|
|
|
|
|
name of the source file in error messages instead of *file*. If *doraise* is
|
|
|
|
|
true, a :exc:`PyCompileError` is raised when an error is encountered while
|
|
|
|
|
compiling *file*. If *doraise* is false (the default), an error string is
|
|
|
|
|
written to ``sys.stderr``, but no exception is raised.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. function:: main([args])
|
|
|
|
|
|
|
|
|
|
Compile several source files. The files named in *args* (or on the command
|
|
|
|
|
line, if *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.
|
|
|
|
|
|
|
|
|
|
When this module is run as a script, the :func:`main` is used to compile all the
|
|
|
|
|
files named on the command line.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. seealso::
|
|
|
|
|
|
|
|
|
|
Module :mod:`compileall`
|
|
|
|
|
Utilities to compile all Python source files in a directory tree.
|
|
|
|
|
|