Home | History | Annotate | Download | only in Lib 
      1 """Module/script to byte-compile all .py files to .pyc (or .pyo) files.
      2 
      3 When called as a script with arguments, this compiles the directories
      4 given as arguments recursively; the -l option prevents it from
      5 recursing into directories.
      6 
      7 Without arguments, if compiles all modules on sys.path, without
      8 recursing into subdirectories.  (Even though it should do so for
      9 packages -- for now, you'll have to deal with packages separately.)
     10 
     11 See module py_compile for details of the actual byte-compilation.
     12 """
     13 import os
     14 import sys
     15 import py_compile
     16 import struct
     17 import imp
     18 
     19 __all__ = ["compile_dir","compile_file","compile_path"]
     20 
     21 def compile_dir(dir, maxlevels=10, ddir=None,
     22                 force=0, rx=None, quiet=0):
     23     """Byte-compile all modules in the given directory tree.
     24 
     25     Arguments (only dir is required):
     26 
     27     dir:       the directory to byte-compile
     28     maxlevels: maximum recursion level (default 10)
     29     ddir:      the directory that will be prepended to the path to the
     30                file as it is compiled into each byte-code file.
     31     force:     if 1, force compilation, even if timestamps are up-to-date
     32     quiet:     if 1, be quiet during compilation
     33     """
     34     if not quiet:
     35         print 'Listing', dir, '...'
     36     try:
     37         names = os.listdir(dir)
     38     except os.error:
     39         print "Can't list", dir
     40         names = []
     41     names.sort()
     42     success = 1
     43     for name in names:
     44         fullname = os.path.join(dir, name)
     45         if ddir is not None:
     46             dfile = os.path.join(ddir, name)
     47         else:
     48             dfile = None
     49         if not os.path.isdir(fullname):
     50             if not compile_file(fullname, ddir, force, rx, quiet):
     51                 success = 0
     52         elif maxlevels > 0 and \
     53              name != os.curdir and name != os.pardir and \
     54              os.path.isdir(fullname) and \
     55              not os.path.islink(fullname):
     56             if not compile_dir(fullname, maxlevels - 1, dfile, force, rx,
     57                                quiet):
     58                 success = 0
     59     return success
     60 
     61 def compile_file(fullname, ddir=None, force=0, rx=None, quiet=0):
     62     """Byte-compile one file.
     63 
     64     Arguments (only fullname is required):
     65 
     66     fullname:  the file to byte-compile
     67     ddir:      if given, the directory name compiled in to the
     68                byte-code file.
     69     force:     if 1, force compilation, even if timestamps are up-to-date
     70     quiet:     if 1, be quiet during compilation
     71     """
     72     success = 1
     73     name = os.path.basename(fullname)
     74     if ddir is not None:
     75         dfile = os.path.join(ddir, name)
     76     else:
     77         dfile = None
     78     if rx is not None:
     79         mo = rx.search(fullname)
     80         if mo:
     81             return success
     82     if os.path.isfile(fullname):
     83         head, tail = name[:-3], name[-3:]
     84         if tail == '.py':
     85             if not force:
     86                 try:
     87                     mtime = int(os.stat(fullname).st_mtime)
     88                     expect = struct.pack('<4sl', imp.get_magic(), mtime)
     89                     cfile = fullname + (__debug__ and 'c' or 'o')
     90                     with open(cfile, 'rb') as chandle:
     91                         actual = chandle.read(8)
     92                     if expect == actual:
     93                         return success
     94                 except IOError:
     95                     pass
     96             if not quiet:
     97                 print 'Compiling', fullname, '...'
     98             try:
     99                 ok = py_compile.compile(fullname, None, dfile, True)
    100             except py_compile.PyCompileError,err:
    101                 if quiet:
    102                     print 'Compiling', fullname, '...'
    103                 print err.msg
    104                 success = 0
    105             except IOError, e:
    106                 print "Sorry", e
    107                 success = 0
    108             else:
    109                 if ok == 0:
    110                     success = 0
    111     return success
    112 
    113 def compile_path(skip_curdir=1, maxlevels=0, force=0, quiet=0):
    114     """Byte-compile all module on sys.path.
    115 
    116     Arguments (all optional):
    117 
    118     skip_curdir: if true, skip current directory (default true)
    119     maxlevels:   max recursion level (default 0)
    120     force: as for compile_dir() (default 0)
    121     quiet: as for compile_dir() (default 0)
    122     """
    123     success = 1
    124     for dir in sys.path:
    125         if (not dir or dir == os.curdir) and skip_curdir:
    126             print 'Skipping current directory'
    127         else:
    128             success = success and compile_dir(dir, maxlevels, None,
    129                                               force, quiet=quiet)
    130     return success
    131 
    132 def expand_args(args, flist):
    133     """read names in flist and append to args"""
    134     expanded = args[:]
    135     if flist:
    136         try:
    137             if flist == '-':
    138                 fd = sys.stdin
    139             else:
    140                 fd = open(flist)
    141             while 1:
    142                 line = fd.readline()
    143                 if not line:
    144                     break
    145                 expanded.append(line[:-1])
    146         except IOError:
    147             print "Error reading file list %s" % flist
    148             raise
    149     return expanded
    150 
    151 def main():
    152     """Script main program."""
    153     import getopt
    154     try:
    155         opts, args = getopt.getopt(sys.argv[1:], 'lfqd:x:i:')
    156     except getopt.error, msg:
    157         print msg
    158         print "usage: python compileall.py [-l] [-f] [-q] [-d destdir] " \
    159               "[-x regexp] [-i list] [directory|file ...]"
    160         print
    161         print "arguments: zero or more file and directory names to compile; " \
    162               "if no arguments given, "
    163         print "           defaults to the equivalent of -l sys.path"
    164         print
    165         print "options:"
    166         print "-l: don't recurse into subdirectories"
    167         print "-f: force rebuild even if timestamps are up-to-date"
    168         print "-q: output only error messages"
    169         print "-d destdir: directory to prepend to file paths for use in " \
    170               "compile-time tracebacks and in"
    171         print "            runtime tracebacks in cases where the source " \
    172               "file is unavailable"
    173         print "-x regexp: skip files matching the regular expression regexp; " \
    174               "the regexp is searched for"
    175         print "           in the full path of each file considered for " \
    176               "compilation"
    177         print "-i file: add all the files and directories listed in file to " \
    178               "the list considered for"
    179         print '         compilation; if "-", names are read from stdin'
    180 
    181         sys.exit(2)
    182     maxlevels = 10
    183     ddir = None
    184     force = 0
    185     quiet = 0
    186     rx = None
    187     flist = None
    188     for o, a in opts:
    189         if o == '-l': maxlevels = 0
    190         if o == '-d': ddir = a
    191         if o == '-f': force = 1
    192         if o == '-q': quiet = 1
    193         if o == '-x':
    194             import re
    195             rx = re.compile(a)
    196         if o == '-i': flist = a
    197     if ddir:
    198         if len(args) != 1 and not os.path.isdir(args[0]):
    199             print "-d destdir require exactly one directory argument"
    200             sys.exit(2)
    201     success = 1
    202     try:
    203         if args or flist:
    204             try:
    205                 if flist:
    206                     args = expand_args(args, flist)
    207             except IOError:
    208                 success = 0
    209             if success:
    210                 for arg in args:
    211                     if os.path.isdir(arg):
    212                         if not compile_dir(arg, maxlevels, ddir,
    213                                            force, rx, quiet):
    214                             success = 0
    215                     else:
    216                         if not compile_file(arg, ddir, force, rx, quiet):
    217                             success = 0
    218         else:
    219             success = compile_path()
    220     except KeyboardInterrupt:
    221         print "\n[interrupted]"
    222         success = 0
    223     return success
    224 
    225 if __name__ == '__main__':
    226     exit_status = int(not main())
    227     sys.exit(exit_status)
    228