py_compile
index
/usr/local/lib/python2.5/py_compile.py
Module Docs

Routine to "compile" a .py file to a .pyc (or .pyo) file.
 
This module has intimate knowledge of the format of .pyc files.

 
Modules
       
__builtin__
imp
marshal
os
sys
traceback

 
Classes
       
exceptions.Exception(exceptions.BaseException)
PyCompileError

 
class PyCompileError(exceptions.Exception)
    Exception raised when an error occurs while attempting to
compile the file.
 
To raise this exception, use
 
    raise PyCompileError(exc_type,exc_value,file[,msg])
 
where
 
    exc_type:   exception type to be used in error message
                type name can be accesses as class variable
                'exc_type_name'
 
    exc_value:  exception value to be used in error message
                can be accesses as class variable 'exc_value'
 
    /get.cgi/       name of file being compiled to be used in error message
                can be accesses as class variable 'file'
 
    msg:        string message to be written as error message
                If no value is given, a default exception message will be given,
                consistent with 'standard' py_compile output.
                message (or default) can be accesses as class variable 'msg'
 
 
Method resolution order:
PyCompileError
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods defined here:
__init__(self, exc_type, exc_value, file, msg='')
__str__(self)

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object at 0x8125440>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message
exception message

 
Functions
       
compile(file, cfile=None, dfile=None, doraise=False)
Byte-compile one Python source file to Python bytecode.
 
Arguments:
 
/get.cgi/    source filename
c/get.cgi/   target filename; defaults to source with 'c' or 'o' appended
         ('c' normally, 'o' in optimizing mode, giving .pyc or .pyo)
d/get.cgi/   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.

 
Data
        __all__ = ['compile', 'main', 'PyCompileError']