compileall — 字节编译 Python 库 ¶

源代码： Lib/compileall.py

---

此模块提供一些实用函数来支持安装 Python 库。这些函数编译目录树下的 Python 源文件。此模块可以用于在库安装时创建缓存字节码文件，即使用户没有库目录写入权限也可以使用它们。

可用性 ：非 WASI。

This module does not work or is not available on WebAssembly. See WebAssembly 平台 了解更多信息。

命令行用法 ¶

此模块可以作为脚本工作 (使用 python -m compileall ) 以编译 Python 源代码。

directory ... ¶

file ... ¶

Positional arguments are files to compile or directories that contain source files, traversed recursively. If no argument is given, behave as if the command line was -l <directories from sys.path> .

-l ¶

Do not recurse into subdirectories, only compile source code files directly contained in the named or implied directories.

-f ¶

Force rebuild even if timestamps are up-to-date.

-q ¶

Do not print the list of files compiled. If passed once, error messages will still be printed. If passed twice ( -qq )，所有输出被抑制。

-d destdir ¶

Directory prepended to the path to each file being compiled. This will appear in compilation time tracebacks, and is also compiled in to the byte-code file, where it will be used in tracebacks and other messages in cases where the source file does not exist at the time the byte-code file is executed.

-s strip_prefix ¶

-p prepend_prefix ¶

移除 ( -s ) 或追加 ( -p ) the given prefix of paths recorded in the .pyc files. Cannot be combined with -d .

-x regex ¶

regex is used to search the full path to each file considered for compilation, and if the regex produces a match, the file is skipped.

-i list ¶

读取文件 list and add each line that it contains to the list of files and directories to compile. If list is - ，读取行从 stdin .

-b ¶

Write the byte-code files to their legacy locations and names, which may overwrite byte-code files created by another version of Python. The default is to write files to their PEP 3147 locations and names, which allows byte-code files from multiple versions of Python to coexist.

-r ¶

Control the maximum recursion level for subdirectories. If this is given, then -l option will not be taken into account. python -m compileall <directory> -r 0 相当于 python -m compileall <directory> -l .

-j N ¶

使用 N workers to compile the files within the given directory. If 0 is used, then the result of os.process_cpu_count() 会被使用。

--invalidation-mode [timestamp|checked-hash|unchecked-hash] ¶

Control how the generated byte-code files are invalidated at runtime. The timestamp value, means that .pyc files with the source timestamp and size embedded will be generated. The checked-hash and unchecked-hash values cause hash-based pycs to be generated. Hash-based pycs embed a hash of the source file contents rather than a timestamp. See 缓存字节码无效 for more information on how Python validates bytecode cache files at runtime. The default is timestamp 若 SOURCE_DATE_EPOCH environment variable is not set, and checked-hash 若 SOURCE_DATE_EPOCH environment variable is set.

-o level ¶

Compile with the given optimization level. May be used multiple times to compile for multiple levels at a time (for example, compileall -o 1 -o 2 ).

-e dir ¶

Ignore symlinks pointing outside the given directory.

--hardlink-dupes ¶

If two .pyc files with different optimization level have the same content, use hard links to consolidate duplicate files.

3.2 版改变： 添加 -i , -b and -h 选项。

3.5 版改变： 添加 -j , -r ，和 -qq 选项。 -q option was changed to a multilevel value. -b will always produce a byte-code file ending in .pyc , never .pyo .

3.7 版改变： 添加 --invalidation-mode 选项。

3.9 版改变： 添加 -s , -p , -e and --hardlink-dupes options. Raised the default recursion limit from 10 to sys.getrecursionlimit() . Added the possibility to specify the -o option multiple times.

There is no command-line option to control the optimization level used by the compile() function, because the Python interpreter itself already provides the option: python -O -m compileall .

同样， compile() 函数遵守 sys.pycache_prefix 设置。生成的字节码缓存才有用若 compile() 的运行是采用相同 sys.pycache_prefix (if any) that will be used at runtime.

公共函数 ¶

compileall. compile_dir ( dir , maxlevels = sys.getrecursionlimit() , ddir = None , force = False , rx = None , quiet = 0 , legacy = False , optimize = -1 , workers = 1 , invalidation_mode = None , * , stripdir = None , prependdir = None , limit_sl_dest = None , hardlink_dupes = False ) ¶

Recursively descend the directory tree named by dir , compiling all .py files along the way. Return a true value if all the files compiled successfully, and a false value otherwise.

The maxlevels parameter is used to limit the depth of the recursion; it defaults to sys.getrecursionlimit() .

若 ddir is given, it is prepended to the path to each file being compiled for use in compilation time tracebacks, and is also compiled in to the byte-code file, where it will be used in tracebacks and other messages in cases where the source file does not exist at the time the byte-code file is executed.

若 force is true, modules are re-compiled even if the timestamps are up to date.

若 rx is given, its search method is called on the complete path to each file considered for compilation, and if it returns a true value, the file is skipped. This can be used to exclude files matching a regular expression, given as a re.Pattern 对象。

若 quiet is False or 0 (the default), the filenames and other information are printed to standard out. Set to 1 , only errors are printed. Set to 2 , all output is suppressed.

若 legacy is true, byte-code files are written to their legacy locations and names, which may overwrite byte-code files created by another version of Python. The default is to write files to their PEP 3147 locations and names, which allows byte-code files from multiple versions of Python to coexist.

optimize specifies the optimization level for the compiler. It is passed to the built-in compile() function. Accepts also a sequence of optimization levels which lead to multiple compilations of one .py file in one call.

自变量 workers specifies how many workers are used to compile files in parallel. The default is to not use multiple workers. If the platform can’t use multiple workers and workers argument is given, then sequential compilation will be used as a fallback. If workers is 0, the number of cores in the system is used. If workers is lower than 0 ， ValueError 会被引发。

invalidation_mode should be a member of the py_compile.PycInvalidationMode enum and controls how the generated pycs are invalidated at runtime.

The stripdir , prependdir and limit_sl_dest 自变量对应于 -s , -p and -e 选项如上所述。它们可以指定为 str or os.PathLike .

若 hardlink_dupes 为 True 且两 .pyc files with different optimization level have the same content, use hard links to consolidate duplicate files.

3.2 版改变： 添加 legacy and optimize 参数。

3.5 版改变： 添加 workers 参数。

3.5 版改变： quiet 参数被改成多级值。

3.5 版改变： The legacy 参数仅写入输出 .pyc files, not .pyo files no matter what the value of optimize is.

3.6 版改变： 接受 像路径对象 .

3.7 版改变： The invalidation_mode 参数被添加。

3.7.2 版改变： The invalidation_mode parameter’s default value is updated to None .

3.8 版改变： 设置 workers to 0 now chooses the optimal number of cores.

3.9 版改变： 添加 stripdir , prependdir , limit_sl_dest and hardlink_dupes arguments. Default value of maxlevels was changed from 10 to sys.getrecursionlimit()