Fred Drake | e72e1e0 | 1998-08-11 15:46:42 +0000 | [diff] [blame] | 1 | \section{\module{compileall} --- |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 2 | Byte-compile Python libraries} |
Fred Drake | e72e1e0 | 1998-08-11 15:46:42 +0000 | [diff] [blame] | 3 | |
| 4 | \declaremodule{standard}{compileall} |
Fred Drake | e72e1e0 | 1998-08-11 15:46:42 +0000 | [diff] [blame] | 5 | \modulesynopsis{Tools for byte-compiling all Python source files in a |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 6 | directory tree.} |
Fred Drake | e72e1e0 | 1998-08-11 15:46:42 +0000 | [diff] [blame] | 7 | |
| 8 | |
| 9 | This module provides some utility functions to support installing |
| 10 | Python libraries. These functions compile Python source files in a |
| 11 | directory tree, allowing users without permission to write to the |
| 12 | libraries to take advantage of cached byte-code files. |
| 13 | |
| 14 | The source file for this module may also be used as a script to |
| 15 | compile Python sources in directories named on the command line or in |
| 16 | \code{sys.path}. |
| 17 | |
| 18 | |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 19 | \begin{funcdesc}{compile_dir}{dir\optional{, maxlevels\optional{, |
| 20 | ddir\optional{, force}}}} |
Fred Drake | e72e1e0 | 1998-08-11 15:46:42 +0000 | [diff] [blame] | 21 | Recursively descend the directory tree named by \var{dir}, compiling |
| 22 | all \file{.py} files along the way. The \var{maxlevels} parameter |
| 23 | is used to limit the depth of the recursion; it defaults to |
| 24 | \code{10}. If \var{ddir} is given, it is used as the base path from |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 25 | which the filenames used in error messages will be generated. If |
| 26 | \var{force} is true, modules are re-compiled even if the timestamps |
| 27 | are up to date. |
Fred Drake | e72e1e0 | 1998-08-11 15:46:42 +0000 | [diff] [blame] | 28 | \end{funcdesc} |
| 29 | |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 30 | \begin{funcdesc}{compile_path}{\optional{skip_curdir\optional{, |
| 31 | maxlevels\optional{, force}}}} |
Fred Drake | e72e1e0 | 1998-08-11 15:46:42 +0000 | [diff] [blame] | 32 | Byte-compile all the \file{.py} files found along \code{sys.path}. |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 33 | If \var{skip_curdir} is true (the default), the current directory is |
| 34 | not included in the search. The \var{maxlevels} and |
| 35 | \var{force} parameters default to \code{0} and are passed to the |
| 36 | \function{compile_dir()} function. |
Fred Drake | e72e1e0 | 1998-08-11 15:46:42 +0000 | [diff] [blame] | 37 | \end{funcdesc} |
| 38 | |
| 39 | |
| 40 | \begin{seealso} |
| 41 | \seemodule[pycompile]{py_compile}{Byte-compile a single source file.} |
| 42 | \end{seealso} |