"""Module/script to byte-compile all .py files to .pyc (or .pyo) files.
When called as a script with arguments, this compiles the directories
given as arguments recursively; the -l option prevents it from
recursing into directories.
Without arguments, if compiles all modules on sys.path, without
recursing into subdirectories. (Even though it should do so for
packages -- for now, you'll have to deal with packages separately.)
See module py_compile for details of the actual byte-compilation.
__all__ = ["compile_dir","compile_file","compile_path"]
def compile_dir(dir, maxlevels=10, ddir=None,
force=0, rx=None, quiet=0):
"""Byte-compile all modules in the given directory tree.
Arguments (only dir is required):
dir: the directory to byte-compile
maxlevels: maximum recursion level (default 10)
ddir: the directory that will be prepended to the path to the
file as it is compiled into each byte-code file.
force: if 1, force compilation, even if timestamps are up-to-date
quiet: if 1, be quiet during compilation
print 'Listing', dir, '...'
fullname = os.path.join(dir, name)
dfile = os.path.join(ddir, name)
if not os.path.isdir(fullname):
if not compile_file(fullname, ddir, force, rx, quiet):
name != os.curdir and name != os.pardir and \
os.path.isdir(fullname) and \
not os.path.islink(fullname):
if not compile_dir(fullname, maxlevels - 1, dfile, force, rx,
def compile_file(fullname, ddir=None, force=0, rx=None, quiet=0):
"""Byte-compile one file.
Arguments (only fullname is required):
fullname: the file to byte-compile
ddir: if given, the directory name compiled in to the
force: if 1, force compilation, even if timestamps are up-to-date
quiet: if 1, be quiet during compilation
name = os.path.basename(fullname)
dfile = os.path.join(ddir, name)
if os.path.isfile(fullname):
head, tail = name[:-3], name[-3:]
mtime = int(os.stat(fullname).st_mtime)
expect = struct.pack('<4sl', imp.get_magic(), mtime)
cfile = fullname + (__debug__ and 'c' or 'o')
with open(cfile, 'rb') as chandle:
print 'Compiling', fullname, '...'
ok = py_compile.compile(fullname, None, dfile, True)
except py_compile.PyCompileError,err:
print 'Compiling', fullname, '...'
def compile_path(skip_curdir=1, maxlevels=0, force=0, quiet=0):
"""Byte-compile all module on sys.path.
Arguments (all optional):
skip_curdir: if true, skip current directory (default true)
maxlevels: max recursion level (default 0)
force: as for compile_dir() (default 0)
quiet: as for compile_dir() (default 0)
if (not dir or dir == os.curdir) and skip_curdir:
print 'Skipping current directory'
success = success and compile_dir(dir, maxlevels, None,
def expand_args(args, flist):
"""read names in flist and append to args"""
expanded.append(line[:-1])
print "Error reading file list %s" % flist
"""Script main program."""
opts, args = getopt.getopt(sys.argv[1:], 'lfqd:x:i:')
except getopt.error, msg:
print "usage: python compileall.py [-l] [-f] [-q] [-d destdir] " \
"[-x regexp] [-i list] [directory|file ...]"
print "arguments: zero or more file and directory names to compile; " \
"if no arguments given, "
print " defaults to the equivalent of -l sys.path"
print "-l: don't recurse into subdirectories"
print "-f: force rebuild even if timestamps are up-to-date"
print "-q: output only error messages"
print "-d destdir: directory to prepend to file paths for use in " \
"compile-time tracebacks and in"
print " runtime tracebacks in cases where the source " \
print "-x regexp: skip files matching the regular expression regexp; " \
"the regexp is searched for"
print " in the full path of each file considered for " \
print "-i file: add all the files and directories listed in file to " \
"the list considered for"
print ' compilation; if "-", names are read from stdin'
if o == '-l': maxlevels = 0
if len(args) != 1 and not os.path.isdir(args[0]):
print "-d destdir require exactly one directory argument"
args = expand_args(args, flist)
if not compile_dir(arg, maxlevels, ddir,
if not compile_file(arg, ddir, force, rx, quiet):
except KeyboardInterrupt:
if __name__ == '__main__':
exit_status = int(not main())