Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 1 | """Module/script to "compile" all .py files to .pyc (or .pyo) file. |
| 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 | """ |
Guido van Rossum | 3bb5448 | 1994-08-29 10:52:58 +0000 | [diff] [blame] | 14 | import os |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 15 | import errno |
Guido van Rossum | 3bb5448 | 1994-08-29 10:52:58 +0000 | [diff] [blame] | 16 | import sys |
| 17 | import py_compile |
Brett Cannon | befb14f | 2009-02-10 02:10:16 +0000 | [diff] [blame] | 18 | import struct |
| 19 | import imp |
Guido van Rossum | 3bb5448 | 1994-08-29 10:52:58 +0000 | [diff] [blame] | 20 | |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 21 | __all__ = ["compile_dir","compile_file","compile_path"] |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 22 | |
Martin v. Löwis | 5c137c2 | 2002-03-18 12:44:08 +0000 | [diff] [blame] | 23 | def compile_dir(dir, maxlevels=10, ddir=None, |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 24 | force=False, rx=None, quiet=False, legacy=False): |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 25 | """Byte-compile all modules in the given directory tree. |
Guido van Rossum | 3bb5448 | 1994-08-29 10:52:58 +0000 | [diff] [blame] | 26 | |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 27 | Arguments (only dir is required): |
| 28 | |
| 29 | dir: the directory to byte-compile |
| 30 | maxlevels: maximum recursion level (default 10) |
| 31 | ddir: if given, purported directory name (this is the |
| 32 | directory name that will show up in error messages) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 33 | force: if True, force compilation, even if timestamps are up-to-date |
| 34 | quiet: if True, be quiet during compilation |
| 35 | legacy: if True, produce legacy pyc paths instead of PEP 3147 paths |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 36 | |
| 37 | """ |
Martin v. Löwis | 5c137c2 | 2002-03-18 12:44:08 +0000 | [diff] [blame] | 38 | if not quiet: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 39 | print('Listing', dir, '...') |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 40 | try: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 41 | names = os.listdir(dir) |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 42 | except os.error: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 43 | print("Can't list", dir) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 44 | names = [] |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 45 | names.sort() |
Fred Drake | 9065ea3 | 1999-03-29 20:25:40 +0000 | [diff] [blame] | 46 | success = 1 |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 47 | for name in names: |
Barry Warsaw | c04317f | 2010-04-26 15:59:03 +0000 | [diff] [blame] | 48 | if name == '__pycache__': |
| 49 | continue |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 50 | fullname = os.path.join(dir, name) |
Raymond Hettinger | 8989ea6 | 2002-06-01 00:06:20 +0000 | [diff] [blame] | 51 | if ddir is not None: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 52 | dfile = os.path.join(ddir, name) |
| 53 | else: |
| 54 | dfile = None |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 55 | if not os.path.isdir(fullname): |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 56 | if not compile_file(fullname, ddir, force, rx, quiet, legacy): |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 57 | success = 0 |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 58 | elif maxlevels > 0 and \ |
| 59 | name != os.curdir and name != os.pardir and \ |
| 60 | os.path.isdir(fullname) and \ |
| 61 | not os.path.islink(fullname): |
Brett Cannon | befb14f | 2009-02-10 02:10:16 +0000 | [diff] [blame] | 62 | if not compile_dir(fullname, maxlevels - 1, dfile, force, rx, |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 63 | quiet, legacy): |
Jeremy Hylton | 12b6457 | 2001-04-18 01:20:21 +0000 | [diff] [blame] | 64 | success = 0 |
Fred Drake | 9065ea3 | 1999-03-29 20:25:40 +0000 | [diff] [blame] | 65 | return success |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 66 | |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 67 | def compile_file(fullname, ddir=None, force=0, rx=None, quiet=False, |
| 68 | legacy=False): |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 69 | """Byte-compile file. |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 70 | fullname: the file to byte-compile |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 71 | ddir: if given, purported directory name (this is the |
| 72 | directory name that will show up in error messages) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 73 | force: if True, force compilation, even if timestamps are up-to-date |
| 74 | quiet: if True, be quiet during compilation |
| 75 | legacy: if True, produce legacy pyc paths instead of PEP 3147 paths |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 76 | |
| 77 | """ |
| 78 | success = 1 |
| 79 | name = os.path.basename(fullname) |
| 80 | if ddir is not None: |
| 81 | dfile = os.path.join(ddir, name) |
| 82 | else: |
| 83 | dfile = None |
| 84 | if rx is not None: |
| 85 | mo = rx.search(fullname) |
| 86 | if mo: |
| 87 | return success |
| 88 | if os.path.isfile(fullname): |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 89 | if legacy: |
| 90 | cfile = fullname + ('c' if __debug__ else 'o') |
| 91 | else: |
| 92 | cfile = imp.cache_from_source(fullname) |
| 93 | cache_dir = os.path.dirname(cfile) |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 94 | head, tail = name[:-3], name[-3:] |
| 95 | if tail == '.py': |
| 96 | if not force: |
| 97 | try: |
| 98 | mtime = int(os.stat(fullname).st_mtime) |
| 99 | expect = struct.pack('<4sl', imp.get_magic(), mtime) |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 100 | with open(cfile, 'rb') as chandle: |
| 101 | actual = chandle.read(8) |
| 102 | if expect == actual: |
| 103 | return success |
| 104 | except IOError: |
| 105 | pass |
| 106 | if not quiet: |
| 107 | print('Compiling', fullname, '...') |
| 108 | try: |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 109 | ok = py_compile.compile(fullname, cfile, dfile, True) |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 110 | except py_compile.PyCompileError as err: |
| 111 | if quiet: |
| 112 | print('*** Error compiling', fullname, '...') |
| 113 | else: |
| 114 | print('*** ', end='') |
Martin v. Löwis | 4b00307 | 2010-03-16 13:19:21 +0000 | [diff] [blame] | 115 | # escape non-printable characters in msg |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 116 | msg = err.msg.encode(sys.stdout.encoding, |
| 117 | errors='backslashreplace') |
Martin v. Löwis | 4b00307 | 2010-03-16 13:19:21 +0000 | [diff] [blame] | 118 | msg = msg.decode(sys.stdout.encoding) |
| 119 | print(msg) |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 120 | success = 0 |
| 121 | except (SyntaxError, UnicodeError, IOError) as e: |
| 122 | if quiet: |
| 123 | print('*** Error compiling', fullname, '...') |
| 124 | else: |
| 125 | print('*** ', end='') |
| 126 | print(e.__class__.__name__ + ':', e) |
| 127 | success = 0 |
| 128 | else: |
| 129 | if ok == 0: |
| 130 | success = 0 |
| 131 | return success |
| 132 | |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 133 | def compile_path(skip_curdir=1, maxlevels=0, force=False, quiet=False, |
| 134 | legacy=False): |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 135 | """Byte-compile all module on sys.path. |
| 136 | |
| 137 | Arguments (all optional): |
| 138 | |
| 139 | skip_curdir: if true, skip current directory (default true) |
| 140 | maxlevels: max recursion level (default 0) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 141 | force: as for compile_dir() (default False) |
| 142 | quiet: as for compile_dir() (default False) |
| 143 | legacy: as for compile_dir() (default False) |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 144 | |
| 145 | """ |
Fred Drake | 9065ea3 | 1999-03-29 20:25:40 +0000 | [diff] [blame] | 146 | success = 1 |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 147 | for dir in sys.path: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 148 | if (not dir or dir == os.curdir) and skip_curdir: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 149 | print('Skipping current directory') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 150 | else: |
Martin v. Löwis | 5c137c2 | 2002-03-18 12:44:08 +0000 | [diff] [blame] | 151 | success = success and compile_dir(dir, maxlevels, None, |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 152 | force, quiet=quiet, |
| 153 | legacy=legacy) |
Fred Drake | 9065ea3 | 1999-03-29 20:25:40 +0000 | [diff] [blame] | 154 | return success |
Guido van Rossum | 3bb5448 | 1994-08-29 10:52:58 +0000 | [diff] [blame] | 155 | |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 156 | def expand_args(args, flist): |
| 157 | """read names in flist and append to args""" |
| 158 | expanded = args[:] |
| 159 | if flist: |
| 160 | try: |
| 161 | if flist == '-': |
| 162 | fd = sys.stdin |
| 163 | else: |
| 164 | fd = open(flist) |
| 165 | while 1: |
| 166 | line = fd.readline() |
| 167 | if not line: |
| 168 | break |
| 169 | expanded.append(line[:-1]) |
| 170 | except IOError: |
| 171 | print("Error reading file list %s" % flist) |
| 172 | raise |
| 173 | return expanded |
| 174 | |
Guido van Rossum | 3bb5448 | 1994-08-29 10:52:58 +0000 | [diff] [blame] | 175 | def main(): |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 176 | """Script main program.""" |
| 177 | import getopt |
| 178 | try: |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 179 | opts, args = getopt.getopt(sys.argv[1:], 'lfqd:x:i:b') |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 180 | except getopt.error as msg: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 181 | print(msg) |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 182 | print("usage: python compileall.py [-l] [-f] [-q] [-d destdir] " |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 183 | "[-x regexp] [-i list] [directory|file ...]") |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 184 | print("-l: don't recurse down") |
| 185 | print("-f: force rebuild even if timestamps are up-to-date") |
| 186 | print("-q: quiet operation") |
| 187 | print("-d destdir: purported directory name for error messages") |
| 188 | print(" if no directory arguments, -l sys.path is assumed") |
| 189 | print("-x regexp: skip files matching the regular expression regexp") |
Christian Heimes | 7864476 | 2008-03-04 23:39:23 +0000 | [diff] [blame] | 190 | print(" the regexp is searched for in the full path of the file") |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 191 | print("-i list: expand list with its content " |
| 192 | "(file and directory names)") |
| 193 | print("-b: Produce legacy byte-compile file paths") |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 194 | sys.exit(2) |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 195 | maxlevels = 10 |
| 196 | ddir = None |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 197 | force = False |
| 198 | quiet = False |
Jeremy Hylton | 12b6457 | 2001-04-18 01:20:21 +0000 | [diff] [blame] | 199 | rx = None |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 200 | flist = None |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 201 | legacy = False |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 202 | for o, a in opts: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 203 | if o == '-l': maxlevels = 0 |
| 204 | if o == '-d': ddir = a |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 205 | if o == '-f': force = True |
| 206 | if o == '-q': quiet = True |
Jeremy Hylton | 12b6457 | 2001-04-18 01:20:21 +0000 | [diff] [blame] | 207 | if o == '-x': |
| 208 | import re |
| 209 | rx = re.compile(a) |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 210 | if o == '-i': flist = a |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 211 | if o == '-b': legacy = True |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 212 | if ddir: |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 213 | if len(args) != 1 and not os.path.isdir(args[0]): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 214 | print("-d destdir require exactly one directory argument") |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 215 | sys.exit(2) |
Fred Drake | 9065ea3 | 1999-03-29 20:25:40 +0000 | [diff] [blame] | 216 | success = 1 |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 217 | try: |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 218 | if args or flist: |
| 219 | try: |
| 220 | if flist: |
| 221 | args = expand_args(args, flist) |
| 222 | except IOError: |
| 223 | success = 0 |
| 224 | if success: |
| 225 | for arg in args: |
| 226 | if os.path.isdir(arg): |
| 227 | if not compile_dir(arg, maxlevels, ddir, |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 228 | force, rx, quiet, legacy): |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 229 | success = 0 |
| 230 | else: |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 231 | if not compile_file(arg, ddir, force, rx, |
| 232 | quiet, legacy): |
Matthias Klose | c33b902 | 2010-03-16 00:36:26 +0000 | [diff] [blame] | 233 | success = 0 |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 234 | else: |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 235 | success = compile_path(legacy=legacy) |
Guido van Rossum | c567b81 | 1998-01-19 23:07:55 +0000 | [diff] [blame] | 236 | except KeyboardInterrupt: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 237 | print("\n[interrupt]") |
Fred Drake | 9065ea3 | 1999-03-29 20:25:40 +0000 | [diff] [blame] | 238 | success = 0 |
| 239 | return success |
Guido van Rossum | 3bb5448 | 1994-08-29 10:52:58 +0000 | [diff] [blame] | 240 | |
| 241 | if __name__ == '__main__': |
Raymond Hettinger | 7b4b788 | 2004-12-20 00:29:29 +0000 | [diff] [blame] | 242 | exit_status = int(not main()) |
Jeremy Hylton | 12b6457 | 2001-04-18 01:20:21 +0000 | [diff] [blame] | 243 | sys.exit(exit_status) |