py_compile — Компилировать исходные файлы Python

Kod źródłowy: 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)

Скомпилируйте исходный файл в байт-код и запишите файл кэша байт-кода. Исходный код загружается из файла с именем file. Байт-код записывается в cfile, который по умолчанию соответствует пути PEP 3147/PEP 488, оканчивающемуся на .pyc. Например, если file равен /foo/bar/baz.py, cfile по умолчанию будет иметь значение /foo/bar/__pycache__/baz.cpython-32.pyc для Python 3.2. Если указано dfile, оно используется вместо file в качестве имени исходного файла, из которого извлекаются исходные строки для отображения в обратных трассировках исключений. Если doraise истинно, при компиляции file возникает ошибка PyCompileError. Если doraise имеет значение false (по умолчанию), строка ошибки записывается в sys.stderr, но исключение не создается. Эта функция возвращает путь к скомпилированному побайтно файлу, т.е. любое использованное значение cfile.

Аргументи doraise і quiet визначають спосіб обробки помилок під час компіляції файлу. Якщо quiet дорівнює 0 або 1, а doraise — false, увімкнено поведінку за замовчуванням: рядок помилки записується в sys.stderr, а функція повертає None замість шляху. Якщо doraise має значення true, натомість виникає помилка PyCompileError. Однак, якщо quiet дорівнює 2, повідомлення не буде написано, і doraise не матиме ефекту.

Якщо шлях, яким стає cfile (явно вказаний або обчислений), є символічним посиланням або незвичайним файлом, буде викликано FileExistsError. Це попереджає про те, що імпорт перетворить ці шляхи на звичайні файли, якщо дозволено записувати скомпільовані файли в ці шляхи. Це побічний ефект імпорту за допомогою перейменування файлу для розміщення остаточного скомпільованого файлу на місце, щоб запобігти проблемам одночасного запису файлу.

optimize контролює рівень оптимізації та передається до вбудованої функції compile(). Значення за замовчуванням -1 вибирає рівень оптимізації поточного інтерпретатора.

invalidation_mode має бути членом переліку PycInvalidationMode і керувати тим, як згенерований кеш байт-коду стає недійсним під час виконання. Типовим значенням є PycInvalidationMode.CHECKED_HASH, якщо встановлено змінну середовища SOURCE_DATE_EPOCH, інакше значенням за замовчуванням є PycInvalidationMode.TIMESTAMP.

Zmienione w wersji 3.2: Значення за замовчуванням cfile змінено на PEP 3147-сумісне. Попереднє значення за умовчанням було file + 'c' ('o', якщо оптимізацію було ввімкнено). Також додано параметр optimize.

Zmienione w wersji 3.4: Змінено код для використання importlib для запису файлу кешу байт-коду. Це означає, що семантика створення/запису файлів тепер відповідає тому, що робить importlib, напр. дозволи, семантика запису та переміщення тощо. Також додано застереження, що FileExistsError виникає, якщо cfile є символічним посиланням або незвичайним файлом.

Zmienione w wersji 3.7: Параметр invalidation_mode додано, як зазначено в PEP 552. Якщо встановлено змінну середовища SOURCE_DATE_EPOCH, invalidation_mode буде змушений PycInvalidationMode.CHECKED_HASH.

Zmienione w wersji 3.7.2: Змінна середовища SOURCE_DATE_EPOCH більше не перевизначає значення аргументу invalidation_mode і визначає його значення за умовчанням.

Zmienione w wersji 3.8: Додано параметр quiet.

class py_compile.PycInvalidationMode

Перечисление возможных методов, которые интерпретатор может использовать, чтобы определить, соответствует ли файл байт-кода исходному файлу. Файл .pyc указывает желаемый режим недействительности в своем заголовке. См. Cached bytecode invalidation для получения дополнительной информации о том, как Python делает недействительными файлы .pyc во время выполнения.

Dodane w wersji 3.7.

TIMESTAMP

Файл .pyc містить мітку часу та розмір вихідного файлу, який Python порівнює з метаданими вихідного файлу під час виконання, щоб визначити, чи потрібно генерувати файл .pyc повторно.

CHECKED_HASH

Файл .pyc містить хеш вмісту вихідного файлу, який Python порівнює з джерелом під час виконання, щоб визначити, чи потрібно файл .pyc повторно генерувати.

UNCHECKED_HASH

Як і CHECKED_HASH, файл .pyc містить хеш вмісту вихідного файлу. Однак під час виконання Python вважатиме, що файл .pyc оновлений, і взагалі не перевірятиме .pyc на вихідний файл.

Цей параметр корисний, коли .pycs підтримується в актуальному стані деякою системою, зовнішньою для Python, наприклад системою збірки.

Інтерфейс командного рядка

Цей модуль можна викликати як сценарій для компіляції кількох вихідних файлів. Файли, названі в імена файлів, компілюються, а отриманий байт-код кешується звичайним способом. Ця програма не шукає структуру каталогів для пошуку вихідних файлів; він компілює лише файли з явним іменем. Статус виходу відмінний від нуля, якщо один із файлів не вдалося скомпілювати.

<file> ... <fileN>
-

Позиційні аргументи — це файли для компіляції. Якщо - є єдиним параметром, список файлів береться зі стандартного введення.

-q, --quiet

Придушення виведення помилок.

Zmienione w wersji 3.2: Додано підтримку -.

Zmienione w wersji 3.10: Додано підтримку -q.

Zobacz także

Модуль compileall

Утиліти для компіляції всіх вихідних файлів Python у дереві каталогів.