# `py_compile` — Compile Python source files

Вихідний код: Lib/py_compile.py

The `py_compile` module provides a function to generate a byte-code file from a source file, and another function used when the module source file is invoked as a script.

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

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 — 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`.

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

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

  Змінено в версії 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` містить мітку часу та розмір вихідного файлу, який Python порівнює з метаданими вихідного файлу під час виконання, щоб визначити, чи потрібно генерувати файл `.pyc` повторно.

  CHECKED_HASH

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

  UNCHECKED_HASH

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

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

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

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

<file> ... <fileN>
-

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

-q, --quiet

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

Змінено в версії 3.2: Додано підтримку `-`.

Змінено в версії 3.10: Додано підтримку `-q`.

Дивись також

Модуль `compileall`

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