Revamped, to match py_compile.py:

- added docstrings
- support option to specify a different purported directory name
- reindented with 4 spaces

Lib/compileall.py

@@ -1,70 +1,109 @@
-# Routines to force "compilation" of all .py files in a directory
+"""Module/script to "compile" all .py files to .pyc (or .pyo) file.
-# tree or on sys.path.  By default recursion is pruned at a depth of
+
-# 10 and the current directory, if it occurs in sys.path, is skipped.
+When called as a script with arguments, this compiles the directories
-# When called as a script, compiles argument directories, or sys.path
+given as arguments recursively; the -l option prevents it from
-# if no arguments.
+recursing into directories.
-# After a similar module by Sjoerd Mullender.
+
+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.
+
+"""
 
 import os
 import sys
 import py_compile
 
-def compile_dir(dir, maxlevels = 10):
+def compile_dir(dir, maxlevels=10, ddir=None):
-	print 'Listing', dir, '...'
+    """Byte-compile all modules in the given directory tree.
-	try:
-		names = os.listdir(dir)
-	except os.error:
-		print "Can't list", dir
-		names = []
-	names.sort()
-	for name in names:
-		fullname = os.path.join(dir, name)
-		if os.path.isfile(fullname):
-			head, tail = name[:-3], name[-3:]
-			if tail == '.py':
-				print 'Compiling', fullname, '...'
-				try:
-					py_compile.compile(fullname)
-				except KeyboardInterrupt:
-					del names[:]
-					print '\n[interrupt]'
-					break
-				except:
-					if type(sys.exc_type) == type(''):
-						exc_type_name = sys.exc_type
-					else: exc_type_name = sys.exc_type.__name__
-					print 'Sorry:', exc_type_name + ':',
-					print sys.exc_value
-		elif maxlevels > 0 and \
-		     name != os.curdir and name != os.pardir and \
-		     os.path.isdir(fullname) and \
-		     not os.path.islink(fullname):
-			compile_dir(fullname, maxlevels - 1)
 
-def compile_path(skip_curdir = 1):
+    Arguments (only dir is required):
-	for dir in sys.path:
+
-		if (not dir or dir == os.curdir) and skip_curdir:
+    dir:       the directory to byte-compile
-			print 'Skipping current directory'
+    maxlevels: maximum recursion level (default 10)
-		else:
+    ddir:      if given, purported directory name (this is the
-			compile_dir(dir, 0)
+               directory name that will show up in error messages)
+
+    """
+    print 'Listing', dir, '...'
+    try:
+	names = os.listdir(dir)
+    except os.error:
+	print "Can't list", dir
+	names = []
+    names.sort()
+    for name in names:
+	fullname = os.path.join(dir, name)
+	if ddir:
+	    dfile = os.path.join(ddir, name)
+	else:
+	    dfile = None
+	if os.path.isfile(fullname):
+	    head, tail = name[:-3], name[-3:]
+	    if tail == '.py':
+		print 'Compiling', fullname, '...'
+		try:
+		    py_compile.compile(fullname, None, dfile)
+		except KeyboardInterrupt:
+		    raise KeyboardInterrupt
+		except:
+		    if type(sys.exc_type) == type(''):
+			exc_type_name = sys.exc_type
+		    else: exc_type_name = sys.exc_type.__name__
+		    print 'Sorry:', exc_type_name + ':',
+		    print sys.exc_value
+	elif maxlevels > 0 and \
+	     name != os.curdir and name != os.pardir and \
+	     os.path.isdir(fullname) and \
+	     not os.path.islink(fullname):
+	    compile_dir(fullname, maxlevels - 1, dfile)
+
+def compile_path(skip_curdir=1, maxlevels=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)
+
+    """
+    for dir in sys.path:
+	if (not dir or dir == os.curdir) and skip_curdir:
+	    print 'Skipping current directory'
+	else:
+	    compile_dir(dir, maxlevels)
 
 def main():
-	import getopt
+    """Script main program."""
-	try:
+    import getopt
-		opts, args = getopt.getopt(sys.argv[1:], 'l')
+    try:
-	except getopt.error, msg:
+	opts, args = getopt.getopt(sys.argv[1:], 'ld:')
-		print msg
+    except getopt.error, msg:
-		print "usage: compileall [-l] [directory ...]"
+	print msg
-		print "-l: don't recurse down"
+	print "usage: compileall [-l] [-d destdir] [directory ...]"
-		print "if no arguments, -l sys.path is assumed"
+	print "-l: don't recurse down"
-	maxlevels = 10
+	print "-d destdir: purported directory name for error messages"
-	for o, a in opts:
+	print "if no arguments, -l sys.path is assumed"
-		if o == '-l': maxlevels = 0
+	sys.exit(2)
+    maxlevels = 10
+    ddir = None
+    for o, a in opts:
+	if o == '-l': maxlevels = 0
+	if o == '-d': ddir = a
+    if ddir:
+	if len(args) != 1:
+	    print "-d destdir require exactly one directory argument"
+	    sys.exit(2)
+    try:
 	if args:
-		for dir in sys.argv[1:]:
+	    for dir in args:
-			compile_dir(dir, maxlevels)
+		compile_dir(dir, maxlevels, ddir)
 	else:
-		compile_path()
+	    compile_path()
+    except KeyboardInterrupt:
+	print "\n[interrupt]"
 
 if __name__ == '__main__':
-	main()
+    main()