compileall.md

1> **Источник:** https://python-all.ru/3.9/library/compileall.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`compileall`](https://python-all.ru/3.9/library/compileall.html#module-compileall) – байт-компиляция библиотек Python89**Исходный код:** [Lib/compileall.py](https://python-all.ru/src/3.9/Lib/compileall.py)1011---1213Этот модуль предоставляет несколько утилитных функций для поддержки установки библиотек Python. Эти функции компилируют исходные файлы Python в дереве каталогов. Модуль можно использовать для создания кэшированных файлов байт-кода во время установки библиотеки, что делает их доступными для использования даже пользователями, у которых нет прав на запись в библиотечные каталоги.1415## Использование в командной строке1617Этот модуль может работать как скрипт (используя **python -m compileall**) для компиляции исходников Python.1819#### `directory ...`2021#### `file ...`2223Позиционные аргументы – это файлы для компиляции или каталоги, содержащие исходные файлы, которые обходятся рекурсивно. Если аргументы не указаны, поведение эквивалентно командной строке `-l <directories from sys.path>`.2425#### `-l`2627Не рекурсивно обходить подкаталоги, а компилировать только исходные файлы, непосредственно содержащиеся в указанных или подразумеваемых каталогах.2829#### `-f`3031Принудительная пересборка, даже если метки времени актуальны.3233#### `-q`3435Не печатать список скомпилированных файлов. Если указан один раз, сообщения об ошибках все равно будут выводиться. Если указан дважды (`-qq`), весь вывод подавляется.3637#### `-d destdir`3839Каталог, добавляемый в начало пути к каждому компилируемому файлу. Он будет отображаться в трассировках во время компиляции, а также будет встроен в файл байт-кода, где будет использоваться в трассировках и других сообщениях в случаях, когда исходный файл не существует на момент выполнения файла байт-кода.4041#### `-s strip_prefix`4243#### `-p prepend_prefix`4445Удаляет (`-s`) или добавляет (`-p`) указанный префикс путей, записанных в файлы `.pyc`. Нельзя сочетать с `-d`.4647#### `-x regex`4849Регулярное выражение используется для поиска в полном пути каждого файла, рассматриваемого для компиляции, и если есть совпадение, файл пропускается.5051#### `-i list`5253Читает файл `list` и добавляет каждую строку из него в список файлов и каталогов для компиляции. Если `list` равно `-`, строки читаются из `stdin`.5455#### `-b`5657Записывает файлы байт-кода в их устаревшие расположения и имена, что может перезаписать файлы байт-кода, созданные другой версией Python. По умолчанию файлы записываются в расположения и имена согласно [**PEP 3147**](https://python-all.ru/3.9/library/compileall.html), что позволяет файлам байт-кода от нескольких версий Python сосуществовать.5859#### `-r`6061Управляет максимальным уровнем рекурсии для подкаталогов. Если этот параметр указан, то опция `-l` не принимается во внимание. **python -m compileall \<directory\> -r 0** эквивалентно **python -m compileall \<directory\> -l**.6263#### `-j N`6465Используется *N* рабочих для компиляции файлов в указанном каталоге. Если используется `0`, то будет использован результат [`os.cpu_count()`](https://python-all.ru/3.9/library/os.html#os.cpu_count).6667#### `--invalidation-mode [timestamp|checked-hash|unchecked-hash]`6869Управление тем, как сгенерированные файлы байт-кода становятся недействительными во время выполнения. Значение `timestamp` означает, что будут созданы файлы `.pyc` с встроенными временной меткой и размером исходного файла. Значения `checked-hash` и `unchecked-hash` вызывают создание pyc на основе хеша. Pyc на основе хеша содержат хеш содержимого исходного файла, а не временную метку. См. [Инвалидация кэшированного байт-кода](https://python-all.ru/3.9/reference/import.html#pyc-invalidation) для получения дополнительной информации о том, как Python проверяет файлы кэша байт-кода во время выполнения. По умолчанию используется `timestamp`, если переменная окружения `SOURCE_DATE_EPOCH` не установлена, и `checked-hash`, если переменная окружения `SOURCE_DATE_EPOCH` установлена.7071#### `-o level`7273Компиляция с заданным уровнем оптимизации. Может использоваться несколько раз для компиляции сразу для нескольких уровней (например, `compileall -o 1 -o 2`).7475#### `-e dir`7677Игнорировать символические ссылки, указывающие за пределы указанного каталога.7879#### `--hardlink-dupes`8081Если два файла `.pyc` с разными уровнями оптимизации имеют одинаковое содержимое, используются жёсткие ссылки для объединения дублирующихся файлов.8283Изменено в версии 3.2: Добавлены опции `-i`, `-b` и `-h`.8485Изменено в версии 3.5: Добавлены опции `-j`, `-r` и `-qq`. Опция `-q` была изменена на многоуровневое значение. `-b` всегда будет создавать файл байт-кода с расширением `.pyc`, а не `.pyo`.8687Изменено в версии 3.7: Добавлена опция `--invalidation-mode`.8889Изменено в версии 3.9: Добавлены опции `-s`, `-p`, `-e` и `--hardlink-dupes`. Увеличено ограничение рекурсии по умолчанию с 10 до [`sys.getrecursionlimit()`](https://python-all.ru/3.9/library/sys.html#sys.getrecursionlimit). Добавлена возможность указывать опцию `-o` несколько раз.9091Не существует опции командной строки для управления уровнем оптимизации, используемым функцией [`compile()`](https://python-all.ru/3.9/library/functions.html#compile), поскольку сам интерпретатор Python уже предоставляет такую возможность: **python -O -m compileall**.9293Аналогично, функция [`compile()`](https://python-all.ru/3.9/library/functions.html#compile) учитывает настройку [`sys.pycache_prefix`](https://python-all.ru/3.9/library/sys.html#sys.pycache_prefix). Сгенерированный кэш байт-кода будет полезен только в том случае, если [`compile()`](https://python-all.ru/3.9/library/functions.html#compile) запускается с тем же [`sys.pycache_prefix`](https://python-all.ru/3.9/library/sys.html#sys.pycache_prefix) (если он есть), который будет использоваться во время выполнения.9495## Публичные функции9697#### `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)`9899Рекурсивно обходит дерево каталогов, указанное параметром *dir*, компилируя все файлы `.py` по пути. Возвращает истинное значение, если все файлы скомпилированы успешно, и ложное в противном случае.100101Параметр *maxlevels* используется для ограничения глубины рекурсии; по умолчанию он равен `sys.getrecursionlimit()`.102103Если указан параметр *ddir*, он добавляется в начало пути к каждому компилируемому файлу для использования в трассировках во время компиляции, а также компилируется в файл байт-кода, где будет использоваться в трассировках и других сообщениях в случаях, когда исходный файл не существует на момент выполнения файла байт-кода.104105Если *force* равен true, модули перекомпилируются, даже если временные метки актуальны.106107Если указан *rx*, его метод `search` вызывается для полного пути к каждому файлу, рассматриваемому для компиляции, и если он возвращает истинное значение, файл пропускается. Это можно использовать для исключения файлов, соответствующих регулярному выражению, заданному в виде объекта [re.Pattern](https://python-all.ru/3.9/library/re.html#re-objects).108109Если *quiet* равен `False` или `0` (по умолчанию), имена файлов и другая информация выводятся в стандартный поток вывода. При значении `1` выводятся только ошибки. При значении `2` весь вывод подавляется.110111Если *legacy* истинен, файлы байт-кода записываются в их устаревшие расположения и имена, что может перезаписать файлы байт-кода, созданные другой версией Python. По умолчанию файлы записываются в их расположения и имена [**PEP 3147**](https://python-all.ru/3.9/library/compileall.html), что позволяет файлам байт-кода от разных версий Python сосуществовать.112113*optimize* задаёт уровень оптимизации для компилятора. Он передаётся встроенной функции [`compile()`](https://python-all.ru/3.9/library/functions.html#compile). Также принимает последовательность уровней оптимизации, которая приводит к многократной компиляции одного файла `.py` за один вызов.114115Аргумент *workers* указывает, сколько рабочих процессов используется для параллельной компиляции файлов. По умолчанию несколько рабочих процессов не используются. Если платформа не может использовать несколько рабочих процессов и указан аргумент *workers*, то в качестве запасного варианта используется последовательная компиляция. Если *workers* равен 0, используется количество ядер в системе. Если *workers* меньше `0`, будет возбуждено [`ValueError`](https://python-all.ru/3.9/library/exceptions.html#ValueError).116117*invalidation\_mode* должен быть элементом перечисления [`py_compile.PycInvalidationMode`](https://python-all.ru/3.9/library/py_compile.html#py_compile.PycInvalidationMode) и управляет тем, как сгенерированные pyc-файлы становятся недействительными во время выполнения.118119Аргументы *stripdir*, *prependdir* и *limit\_sl\_dest* соответствуют опциям `-s`, `-p` и `-e`, описанным выше. Их можно задать как `str`, `bytes` или [`os.PathLike`](https://python-all.ru/3.9/library/os.html#os.PathLike).120121Если *hardlink\_dupes* истинен и два файла `.pyc` с разным уровнем оптимизации имеют одинаковое содержимое, используются жёсткие ссылки для объединения дублирующихся файлов.122123Изменено в версии 3.2: Добавлены параметры *legacy* и *optimize*.124125Изменено в версии 3.5: Добавлен параметр *workers*.126127Изменено в версии 3.5: Параметр *quiet* изменён на многоуровневое значение.128129Изменено в версии 3.5: Параметр *legacy* записывает только файлы `.pyc`, а не `.pyo` независимо от значения *optimize*.130131Изменено в версии 3.6: Принимает [объект, подобный пути](https://python-all.ru/3.9/glossary.html#term-path-like-object).132133Изменено в версии 3.7: Добавлен параметр *invalidation\_mode*.134135Изменено в версии 3.7.2: Значение по умолчанию параметра *invalidation\_mode* изменено на None.136137Изменено в версии 3.8: Установка *workers* в 0 теперь выбирает оптимальное количество ядер.138139Изменено в версии 3.9: Добавлены аргументы *stripdir*, *prependdir*, *limit\_sl\_dest* и *hardlink\_dupes*. Значение по умолчанию *maxlevels* изменено с `10` на `sys.getrecursionlimit()`140141#### `compileall.compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=None, *, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)`142143Компилирует файл с путём *fullname*. Возвращает истинное значение, если файл скомпилирован успешно, и ложное значение в противном случае.144145Если указан *ddir*, он добавляется в начало пути к компилируемому файлу для использования в трассировках во время компиляции, а также встраивается в файл байт-кода, где будет использоваться в трассировках и других сообщениях в случаях, когда исходный файл не существует на момент выполнения файла байт-кода.146147Если указан *rx*, его методу `search` передаётся полный путь к компилируемому файлу, и если он возвращает истинное значение, файл не компилируется и возвращается `True`. Это можно использовать для исключения файлов, соответствующих регулярному выражению, заданному в виде объекта [re.Pattern](https://python-all.ru/3.9/library/re.html#re-objects).148149Если *quiet* равен `False` или `0` (по умолчанию), имена файлов и другая информация выводятся в стандартный поток вывода. При значении `1` выводятся только ошибки. При значении `2` весь вывод подавляется.150151Если *legacy* истинен, файлы байт-кода записываются в их устаревшие расположения и имена, что может перезаписать файлы байт-кода, созданные другой версией Python. По умолчанию файлы записываются в их расположения и имена [**PEP 3147**](https://python-all.ru/3.9/library/compileall.html), что позволяет файлам байт-кода от разных версий Python сосуществовать.152153*optimize* задаёт уровень оптимизации для компилятора. Он передаётся встроенной функции [`compile()`](https://python-all.ru/3.9/library/functions.html#compile). Также принимает последовательность уровней оптимизации, которая приводит к многократной компиляции одного файла `.py` за один вызов.154155*invalidation\_mode* должен быть элементом перечисления [`py_compile.PycInvalidationMode`](https://python-all.ru/3.9/library/py_compile.html#py_compile.PycInvalidationMode) и управляет тем, как сгенерированные pyc-файлы становятся недействительными во время выполнения.156157Аргументы *stripdir*, *prependdir* и *limit\_sl\_dest* соответствуют опциям `-s`, `-p` и `-e`, описанным выше. Их можно задать как `str`, `bytes` или [`os.PathLike`](https://python-all.ru/3.9/library/os.html#os.PathLike).158159Если *hardlink\_dupes* истинен и два файла `.pyc` с разным уровнем оптимизации имеют одинаковое содержимое, используются жёсткие ссылки для объединения дублирующихся файлов.160161Новое в версии 3.2.162163Изменено в версии 3.5: Параметр *quiet* изменён на многоуровневое значение.164165Изменено в версии 3.5: Параметр *legacy* записывает только файлы `.pyc`, а не `.pyo` независимо от значения *optimize*.166167Изменено в версии 3.7: Добавлен параметр *invalidation\_mode*.168169Изменено в версии 3.7.2: Значение по умолчанию параметра *invalidation\_mode* изменено на None.170171Изменено в версии 3.9: Добавлены аргументы *stripdir*, *prependdir*, *limit\_sl\_dest* и *hardlink\_dupes*.172173#### `compileall.compile_path(skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=-1, invalidation_mode=None)`174175Байт-компилирует все файлы `.py`, найденные вдоль `sys.path`. Возвращает истинное значение, если все файлы скомпилированы успешно, и ложное значение в противном случае.176177Если *skip\_curdir* истинен (по умолчанию), текущий каталог не включается в поиск. Все остальные параметры передаются функции [`compile_dir()`](https://python-all.ru/3.9/library/compileall.html#compileall.compile_dir). Обратите внимание, что в отличие от других функций компиляции, `maxlevels` по умолчанию равен `0`.178179Изменено в версии 3.2: Добавлены параметры *legacy* и *optimize*.180181Изменено в версии 3.5: Параметр *quiet* изменён на многоуровневое значение.182183Изменено в версии 3.5: Параметр *legacy* записывает только файлы `.pyc`, а не `.pyo` независимо от значения *optimize*.184185Изменено в версии 3.7: Добавлен параметр *invalidation\_mode*.186187Изменено в версии 3.7.2: Значение по умолчанию параметра *invalidation\_mode* изменено на None.188189Чтобы принудительно перекомпилировать все файлы `.py` в подкаталоге `Lib/` и всех его подкаталогах:190191```python192import compileall193194compileall.compile_dir('Lib/', force=True)195196# Выполнить ту же компиляцию, исключая файлы в каталогах .svn.197import re198compileall.compile_dir('Lib/', rx=re.compile(r'[/\\][.]svn'), force=True)199200# Объекты pathlib.Path также можно использовать.201import pathlib202compileall.compile_dir(pathlib.Path('Lib/'), force=True)203```204205> **См. также**206>207> **Модуль [`py_compile`](https://python-all.ru/3.9/library/py_compile.html#module-py_compile)**208>209> Байт-компилирует один исходный файл.210