Module py_compile
[hide private]
[frames] | no frames]

Module py_compile

Routine to "compile" a .py file to a .pyc (or .pyo) file.

This module has intimate knowledge of the format of .pyc files.

Classes [hide private]
PyCompileError
Exception raised when an error occurs while attempting to compile the file.
Functions [hide private]
 
set_creator_type(file)
 
wr_long(f, x)
Internal; write a 32-bit int to a file in little-endian order.
 
compile(file, cfile=None, dfile=None, doraise=False)
Byte-compile one Python source file to Python bytecode.
 
main(args=None)
Compile several source files.
Variables [hide private]
  MAGIC = '\xb3\xf2\r\n'

Imports: __builtin__, imp, marshal, os, sys, traceback, MacOS


Function Details [hide private]

compile(file, cfile=None, dfile=None, doraise=False)

 
Byte-compile one Python source file to Python bytecode.

Arguments:

file:    source filename
cfile:   target filename; defaults to source with 'c' or 'o' appended
         ('c' normally, 'o' in optimizing mode, giving .pyc or .pyo)
dfile:   purported filename; defaults to source (this is the filename
         that will show up in error messages)
doraise: flag indicating whether or not an exception should be
         raised when a compile error is found. If an exception
         occurs and this flag is set to False, a string
         indicating the nature of the exception will be printed,
         and the function will return to the caller. If an
         exception occurs and this flag is set to True, a
         PyCompileError exception will be raised.

Note that it isn't necessary to byte-compile Python modules for
execution efficiency -- Python itself byte-compiles a module when
it is loaded, and if it can, writes out the bytecode to the
corresponding .pyc (or .pyo) file.

However, if a Python installation is shared between users, it is a
good idea to byte-compile all modules upon installation, since
other users may not be able to write in the source directories,
and thus they won't be able to write the .pyc/.pyo file, and then
they would be byte-compiling every module each time it is loaded.
This can slow down program start-up considerably.

See compileall.py for a script/module that uses this module to
byte-compile all installed files (or all files in selected
directories).

main(args=None)

 

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.