py_compile — Compile Python source files

소스 코드: Lib/py_compile.py

py_compile 모듈은 소스 파일에서 바이트 코드 파일을 생성하는 함수와 모듈 소스 파일이 스크립트로 호출될 때 사용되는 또 다른 함수를 제공합니다.

자주 사용되지는 않지만, 특히 일부 사용자가 소스 코드가 들어있는 디렉터리에 바이트 코드 캐시 파일을 쓸 수 있는 권한이 없을 때, 이 함수는 공유 사용을 위해 모듈을 설치할 때 유용할 수 있습니다.

exception py_compile.PyCompileError

파일을 컴파일하는 도중 에러가 일어날 때 발생하는 예외.

py_compile.compile(file, cfile=None, dfile=None, doraise=False, optimize=-1, invalidation_mode=PycInvalidationMode.TIMESTAMP, quiet=0)

Compile a source file to byte-code and write out the byte-code cache file. The source code is loaded from the file named file. The byte-code is written to cfile, which defaults to the PEP 3147/PEP 488 path, ending in .pyc. For example, if file is /foo/bar/baz.py cfile will default to /foo/bar/__pycache__/baz.cpython-32.pyc for Python 3.2. If dfile is specified, it is used instead of file as the name of the source file from which source lines are obtained for display in exception tracebacks. If doraise is true, a PyCompileError is raised when an error is encountered while compiling file. If doraise is false (the default), an error string is written to sys.stderr, but no exception is raised. This function returns the path to byte-compiled file, i.e. whatever cfile value was used.

doraise와 quiet 인자는 파일을 컴파일하는 동안 에러를 처리하는 방법을 결정합니다. quiet가 0이나 1이고, doraise가 거짓이면, 기본 동작이 활성화됩니다: 에러 문자열이 sys.stderr에 기록되고, 함수는 경로 대신 None을 반환합니다. doraise가 참이면, 대신 PyCompileError가 발생합니다. 그러나 quiet가 2이면, 아무런 메시지도 기록되지 않고, doraise는 효과가 없습니다.

cfile이 되는 경로(명시적으로 지정되거나 계산된 경로)가 심볼릭 링크나 비정규 파일이면, FileExistsError가 발생합니다. 이것은 바이트 컴파일된 파일을 해당 경로에 쓸 수 있을 때 임포트가 해당 경로를 일반 파일로 바꾼다는 경고로 작용합니다. 이는 동시 파일 기록 문제를 방지하기 위해 최종 바이트 컴파일된 파일을 위치시키는데 파일 이름 바꾸기를 사용하는 임포트의 부작용입니다.

optimize는 최적화 수준을 제어하고 내장 compile() 함수로 전달됩니다. 기본값 -1은 현재 인터프리터의 최적화 수준을 선택합니다.

invalidation_mode는 PycInvalidationMode enum의 멤버여야 하며 실행 시간에 생성된 바이트 코드 캐시를 무효로 하는 방법을 제어합니다. SOURCE_DATE_EPOCH 환경 변수가 설정되면 기본값은 PycInvalidationMode.CHECKED_HASH이고, 그렇지 않으면 기본값은 PycInvalidationMode.TIMESTAMP입니다.

버전 3.2에서 변경: cfile의 기본값을 PEP 3147과 호환되도록 변경했습니다. 이전 기본값은 file + 'c'(최적화가 활성화되었으면 'o')입니다. 또한 optimize 매개 변수가 추가되었습니다.

버전 3.4에서 변경: 바이트 코드 캐시 파일 쓰기에 importlib를 사용하도록 코드를 변경했습니다. 이것은 파일 생성/기록 의미가 이제 importlib가 하는 것과 일치한다는 것을 의미합니다, 예를 들어 권한, 쓰기-와-이동 의미 등. 또한, cfile이 심볼릭 링크나 비정규 파일이면 FileExistsError가 발생시키는 경고를 추가했습니다.

버전 3.7에서 변경: invalidation_mode 매개 변수가 PEP 552에 지정된 대로 추가되었습니다. SOURCE_DATE_EPOCH 환경 변수가 설정되면, invalidation_mode는 PycInvalidationMode.CHECKED_HASH로 강제 설정됩니다.

버전 3.7.2에서 변경: SOURCE_DATE_EPOCH 환경 변수는 더는 invalidation_mode 인자의 값을 재정의하지 않으며, 대신 기본값을 결정합니다.

버전 3.8에서 변경: quiet 매개 변수가 추가되었습니다.

class py_compile.PycInvalidationMode

An enumeration of possible methods the interpreter can use to determine whether a bytecode file is up to date with a source file. The .pyc file indicates the desired invalidation mode in its header. See 캐시된 바이트 코드 무효화 for more information on how Python invalidates .pyc files at runtime.

Added in version 3.7.

TIMESTAMP

.pyc 파일은 파이썬이 실행 시간에 소스 파일의 메타 데이터와 비교하여 .pyc 파일을 재생성해야 하는지를 결정할 소스 파일의 타임스탬프와 크기를 포함합니다.

CHECKED_HASH

.pyc 파일은 파이썬이 실행 시간에 소스와 비교하여 .pyc 파일을 다시 생성해야 하는지를 결정할 소스 파일 내용의 해시를 포함합니다.

UNCHECKED_HASH

CHECKED_HASH와 마찬가지로, .pyc 파일에는 소스 파일 내용의 해시가 포함됩니다. 하지만, 파이썬은 실행 시간에 .pyc 파일이 최신 버전이라고 가정하고, 소스 파일에 대해 .pyc를 전혀 검증하지 않습니다.

이 옵션은 .pycs가 빌드 시스템처럼 파이썬 외부 시스템에 의해 최신 상태로 유지될 때 유용합니다.

Command-Line Interface

This module can be invoked as a script to compile several source files. The files named in filenames are compiled and the resulting bytecode is cached in the normal manner. This program does not search a directory structure to locate source files; it only compiles files named explicitly. The exit status is nonzero if one of the files could not be compiled.

<file> ... <fileN>
-

Positional arguments are files to compile. If - is the only parameter, the list of files is taken from standard input.

-q, --quiet

Suppress errors output.

버전 3.2에서 변경: Added support for -.

버전 3.10에서 변경: Added support for -q.

더 보기

모듈 compileall

디렉터리 트리에 있는 모든 파이썬 소스 파일을 컴파일하는 유틸리티.