1. Командная строка и окружение¶Command line and environment

1.1.1. Опции интерфейса¶Interface options

Интерфейс интерпретатора напоминает интерфейс командной оболочки UNIX, но предоставляет дополнительные способы запуска:

• При вызове со стандартным вводом, подключённым к tty-устройству, он выводит приглашение для команд и выполняет их до тех пор, пока не будет прочитан EOF (символ конца файла; на UNIX это можно сделать с помощью Ctrl-D, а на Windows – с помощью Ctrl-Z, Enter). Дополнительную информацию об интерактивном режиме см. в разделе Интерактивный режим.

• При вызове с именем файла в качестве аргумента или с файлом в качестве стандартного ввода он читает и выполняет скрипт из этого файла.

• При вызове с именем каталога в качестве аргумента он читает и выполняет соответствующий скрипт из этого каталога.

• При вызове с -c command выполняет инструкцию(и) Python, переданную(ые) в виде команды. Здесь команда может содержать несколько инструкций, разделённых переводами строк.

• При вызове с -m module-name указанный модуль находится с помощью стандартного механизма импорта и выполняется как скрипт.

В неинтерактивном режиме весь ввод анализируется до его выполнения.

При указании опции интерфейса список параметров, обрабатываемых интерпретатором, завершается, и все последующие аргументы попадают в sys.argv – первый элемент (индекс ноль, sys.argv[0]) является строкой, указывающей на источник программы.

-c <command>¶

Выполняет код Python, указанный в command. command может содержать одну или несколько инструкций, разделённых переводами строк; начальные пробелы, как и в обычном коде модуля, имеют значение.

Если указана эта опция, первый элемент sys.argv будет равен "-c", а текущий каталог будет добавлен в начало sys.path (что позволяет импортировать модули из этого каталога как модули верхнего уровня).

Вызывает событие аудита cpython.run_command с аргументом command.

Изменено в версии 3.14: command автоматически очищается от начальных отступов перед выполнением.

-m <module-name>¶

Находит модуль с помощью стандартного механизма импорта и выполняет его содержимое как модуль __main__.

Поскольку аргумент является именем модуля, не следует указывать расширение файла (.py). Имя модуля должно быть допустимым абсолютным именем модуля Python, но реализация может не всегда это проверять (например, может позволить использовать имя, содержащее дефис).

Имена пакетов (включая пакеты пространств имён) также допускаются. Если вместо обычного модуля указано имя пакета, интерпретатор выполнит <pkg>.__main__ в качестве главного модуля. Это поведение намеренно аналогично обработке каталогов и zip-файлов, которые передаются интерпретатору в качестве аргумента скрипта.

Примечание

Эту опцию нельзя использовать со встроенными модулями и модулями расширения, написанными на C, поскольку у них нет файлов модулей Python. Однако её можно использовать для предварительно скомпилированных модулей, даже если исходный файл недоступен.

Если эта опция указана, первый элемент sys.argv будет содержать полный путь к файлу модуля (пока файл модуля находится, первый элемент будет установлен в "-m"). Как и в случае с опцией -c, текущий каталог будет добавлен в начало sys.path.

Опция -I может использоваться для запуска скрипта в изолированном режиме, когда sys.path не содержит ни текущего каталога, ни каталога site-packages пользователя. Все переменные окружения PYTHON* также игнорируются.

Многие модули стандартной библиотеки содержат код, который вызывается при их выполнении в качестве скрипта. Примером может служить модуль timeit:

python -m timeit -s "setup here" "benchmarked code here"
python -m timeit -h # подробнее

Вызывает событие аудита cpython.run_module с аргументом module-name.

См. также

runpy.run_module()

Эквивалентная функциональность, доступная напрямую из кода Python

PEP 338 – Выполнение модулей как сценариев

Изменено в версии 3.1: Укажите имя пакета, чтобы запустить подмодуль __main__.

Изменено в версии 3.4: также поддерживаются пространственные пакеты

-

Читает команды из стандартного ввода (sys.stdin). Если стандартный ввод является терминалом, подразумевается -i.

Если указана эта опция, первым элементом sys.argv будет "-", а текущий каталог будет добавлен в начало sys.path.

Возбуждает событие аудита cpython.run_stdin без аргументов.

<script>

Выполняет код Python, содержащийся в скрипте, который должен быть файловым путем (абсолютным или относительным), указывающим на файл Python, каталог с файлом __main__.py или ZIP-файл, содержащий файл __main__.py.

Если указана эта опция, первым элементом sys.argv будет имя скрипта, заданное в командной строке.

Если имя скрипта указывает непосредственно на файл Python, каталог, содержащий этот файл, добавляется в начало sys.path, а сам файл выполняется как модуль __main__.

Если имя скрипта ссылается на каталог или ZIP-файл, имя скрипта добавляется в начало sys.path, а файл __main__.py в этом расположении выполняется как модуль __main__.

Опция -I может использоваться для запуска скрипта в изолированном режиме, когда sys.path не содержит ни каталога скрипта, ни каталога site-packages пользователя. Все переменные окружения PYTHON* также игнорируются.

Вызывает событие аудита cpython.run_file с аргументом filename.

См. также

runpy.run_path()

Эквивалентная функциональность, доступная напрямую из кода Python

Если не указана опция интерфейса, подразумевается -i, sys.argv[0] является пустой строкой (""), а текущий каталог будет добавлен в начало sys.path. Кроме того, автодополнение по табуляции и редактирование истории автоматически включаются, если это доступно на вашей платформе (см. конфигурацию Readline).

1.1.2. Общие опции¶Generic options

-?¶

-h¶

--help¶

Выводит краткое описание всех опций командной строки и соответствующих переменных окружения и завершает работу.

--help-env¶

Выводит краткое описание переменных окружения, специфичных для Python, и завершает работу.

Добавлено в версии 3.12.

--help-xoptions¶

Выводит описание специфичных для реализации опций -X и завершает работу.

Добавлено в версии 3.12.

--help-all¶

Выводит полную информацию об использовании и завершает работу.

Добавлено в версии 3.12.

-V¶

--version¶

Выводит номер версии Python и завершает работу. Пример вывода:

Python 3.8.0b2+

При указании дважды выводит более подробную информацию о сборке, например:

Python 3.8.0b2+ (3.8:0c076caaa8, Apr 20 2019, 21:55:00)
[GCC 6.2.0 20161005]

Добавлено в версии 3.6: Опция -VV.

1.1.3. Прочие опции¶Miscellaneous options

-b¶

Выдаёт предупреждение при преобразовании bytes или bytearray в str без указания кодировки или при сравнении bytes или bytearray с str, либо bytes с int. Выдаёт ошибку, если опция указана дважды (-bb).

Изменено в версии 3.5: Также влияет на сравнения bytes с int.

Устарело с версии 3.15: Опции командной строки -b и -bb помечены как устаревшие, и планируется сделать их недействующими (no-op) в Python 3.17. Они в основном были вспомогательными для перехода с Python 2 на 3. Начиная с Python 3.17, для этих случаев BytesWarning не будет возбуждаться; вместо этого используйте анализатор типов.

-B¶

Если указан, Python не будет пытаться записывать файлы .pyc при импорте исходных модулей. См. также PYTHONDONTWRITEBYTECODE.

--check-hash-based-pycs default|always|never¶

Управляет проверкой файлов .pyc на основе хэша. См. Инвалидация кэшированного байт-кода. Если установлено в default, проверенные и непроверенные кэш-файлы байт-кода на основе хэша проверяются в соответствии с их стандартной семантикой. Если установлено в always, все файлы .pyc на основе хэша, как проверенные, так и непроверенные, проверяются на соответствие соответствующему исходному файлу. Если установлено в never, файлы .pyc на основе хэша не проверяются на соответствие соответствующим исходным файлам.

На семантику файлов .pyc на основе временных меток эта опция не влияет.

-d¶

Включает отладочный вывод парсера (только для экспертов). См. также переменную окружения PYTHONDEBUG.

Эта опция требует отладочной сборки Python, иначе она игнорируется.

-E¶

Игнорировать все переменные окружения PYTHON*, например PYTHONPATH и PYTHONHOME, которые могли быть установлены.

См. также опции -P и -I (изолированный режим).

-i¶

Войти в интерактивный режим после выполнения.

Использование опции -i приведёт к входу в интерактивный режим в любом из следующих случаев:

• Когда скрипт передан первым аргументом

• Когда используется опция -c

• Когда используется опция -m

Интерактивный режим запустится, даже если sys.stdin не выглядит как терминал. Файл PYTHONSTARTUP не читается.

Это может быть полезно для проверки глобальных переменных или трассировки стека, когда скрипт вызывает исключение. См. также PYTHONINSPECT.

-I¶

Запустить Python в изолированном режиме. Это также подразумевает опции -E, -P и -s.

В изолированном режиме sys.path не содержит ни каталог скрипта, ни каталог site-packages пользователя. Все переменные окружения PYTHON* также игнорируются. Могут быть наложены дополнительные ограничения для предотвращения внедрения пользователем вредоносного кода.

Добавлено в версии 3.4.

-O¶

Удаляет операторы assert и любой код, зависящий от значения __debug__. Дополняет имя файла для скомпилированных (байт-код) файлов, добавляя .opt-1 перед расширением .pyc (см. PEP 488). См. также PYTHONOPTIMIZE.

Изменено в версии 3.5: Изменяет имена файлов .pyc в соответствии с PEP 488.

-OO¶

Выполняет -O, а также отбрасывает строки документации. Дополняет имя файла для скомпилированных (байт-код) файлов, добавляя .opt-2 перед расширением .pyc (см. PEP 488).

Изменено в версии 3.5: Изменяет имена файлов .pyc в соответствии с PEP 488.

-P¶

Не добавлять потенциально небезопасный путь к sys.path:

• Командная строка python -m module: не добавлять текущую рабочую директорию.

• Командная строка python script.py: не добавлять каталог скрипта. Если это символическая ссылка, разрешать символические ссылки.

• Командные строки python -c code и python (REPL) не добавляют в начало пустую строку, что означает текущий рабочий каталог.

См. также переменную окружения PYTHONSAFEPATH, а также опции -E и -I (изолированный режим).

Добавлено в версии 3.12.

-q¶

Не выводить сообщения об авторских правах и версии, даже в интерактивном режиме.

Добавлено в версии 3.2.

-R¶

Включает рандомизацию хешей. Эта опция действует, только если переменная окружения PYTHONHASHSEED имеет значение, отличное от random, поскольку по умолчанию рандомизация хешей включена.

В предыдущих версиях Python эта опция включала рандомизацию хешей, так что значения __hash__() объектов str и bytes «солились» непредсказуемым случайным значением. Хотя они остаются постоянными в рамках одного процесса Python, они не являются предсказуемыми при повторных запусках Python.

Рандомизация хешей предназначена для защиты от отказа в обслуживании, вызванного специально подобранными входными данными, которые используют наихудшую производительность при создании словаря – сложность O(n²). Подробнее см. https://ocert.org/advisories/ocert-2011-003.html.

PYTHONHASHSEED позволяет задать фиксированное значение для секрета начального значения хеша.

Добавлено в версии 3.2.3.

Изменено в версии 3.7: Опция больше не игнорируется.

-s¶

Не добавляет user site-packages directory в sys.path.

См. также PYTHONNOUSERSITE.

См. также

PEP 370 – Каталог site-packages для каждого пользователя

-S¶

Отключает импорт модуля site и связанные с ним site-зависимые манипуляции с sys.path. Также отключает эти манипуляции, если site явно импортирован позже (для их выполнения следует вызвать site.main()).

-u¶

Принудительно отключает буферизацию для потоков stdout и stderr. Эта опция не влияет на поток stdin.

См. также PYTHONUNBUFFERED.

Изменено в версии 3.7: Текстовый слой потоков stdout и stderr теперь не буферизуется.

-v¶

Выводить сообщение каждый раз, когда инициализируется модуль, с указанием места (имя файла или встроенный модуль), откуда он загружается. При указании дважды (-vv) выводить сообщение для каждого файла, который проверяется при поиске модуля. Также предоставляет информацию об очистке модуля при завершении.

Изменено в версии 3.10: Модуль site теперь сообщает о специфичных для сайта путях и обрабатываемых файлах .pth.

См. также PYTHONVERBOSE.

-W arg¶

Управление предупреждениями. Механизм предупреждений Python по умолчанию выводит предупреждающие сообщения в sys.stderr.

Простейшие настройки применяют определённое действие безусловно ко всем предупреждениям, выдаваемым процессом (даже к тем, которые в противном случае игнорируются по умолчанию):

-Wdefault  # Предупреждать один раз на место вызова
-Werror    # Преобразовывать в исключения
-Walways   # Предупреждать каждый раз
-Wall      # То же, что и -Walways
-Wmodule   # Предупреждать один раз на вызывающий модуль
-Wonce     # Предупреждать один раз на процесс Python
-Wignore   # Никогда не предупреждать

Названия действий можно сокращать по желанию, и интерпретатор преобразует их в соответствующее полное имя. Например, -Wi – то же самое, что -Wignore.

Полная форма аргумента:

action:message:category:module:lineno

Пустые поля соответствуют всем значениям; конечные пустые поля можно опускать. Например, -W ignore::DeprecationWarning игнорирует все предупреждения DeprecationWarning.

Поле action работает так, как описано выше, но применяется только к предупреждениям, соответствующим остальным полям.

Поле сообщение должно совпадать с началом предупреждения; это сравнение нечувствительно к регистру. Если оно начинается и заканчивается косой чертой (/), то задаётся регулярное выражение, иначе – литеральная строка.

Поле category соответствует категории предупреждения (например: DeprecationWarning). Это должно быть имя класса; проверка определяет, является ли фактическая категория предупреждения подклассом указанной категории.

Поле модуль совпадает с (полным) именем модуля; это сравнение чувствительно к регистру. Если оно начинается и заканчивается косой чертой (/), то задаётся регулярное выражение, которому должно соответствовать начало полного имени модуля, иначе – литеральная строка, которой полное имя модуля должно быть равно.

Поле lineno соответствует номеру строки; ноль соответствует всем номерам строк и поэтому эквивалентен отсутствующему номеру строки.

Можно указать несколько опций -W; если предупреждение соответствует более чем одной опции, выполняется действие последней подходящей опции. Некорректные опции -W игнорируются (однако при выдаче первого предупреждения выводится сообщение о некорректных опциях).

Предупреждениями также можно управлять с помощью переменной окружения PYTHONWARNINGS и из программы на Python с использованием модуля warnings. Например, функция warnings.filterwarnings() позволяет применить регулярное выражение к сообщению предупреждения.

См. Фильтр предупреждений и Описание фильтров предупреждений для получения дополнительных сведений.

Изменено в версии 3.15: Добавлена поддержка регулярных выражений для message и module.

-x¶

Пропускает первую строку исходного файла, позволяя использовать не-юниксовые формы #!cmd. Это предназначено только для специфического хака DOS.

-X¶

Зарезервировано для различных опций, специфичных для реализации. В настоящее время CPython определяет следующие возможные значения:

• -X faulthandler для включения faulthandler. См. также PYTHONFAULTHANDLER.

  Добавлено в версии 3.3.

• -X showrefcount выводит общее количество ссылок и количество использованных блоков памяти при завершении программы или после каждого оператора в интерактивном интерпретаторе. Это работает только на отладочных сборках.

  Добавлено в версии 3.4.

• -X tracemalloc для начала трассировки выделений памяти Python с использованием модуля tracemalloc. По умолчанию в трассировочном стеке сохраняется только последний кадр. Используйте -X tracemalloc=NFRAME для начала трассировки с ограничением на NFRAME кадров. См. tracemalloc.start() и PYTHONTRACEMALLOC для получения дополнительной информации.

  Добавлено в версии 3.4.

• -X int_max_str_digits настраивает ограничение длины преобразования целых чисел в строки. См. также PYTHONINTMAXSTRDIGITS.

  Добавлено в версии 3.12.

• -X importtime для отображения времени каждого импорта. Показывает имя модуля, общее время (включая вложенные импорты) и собственное время (без вложенных импортов). Обратите внимание, что вывод может быть нарушен в многопоточных приложениях. Типичное использование: python -X importtime -c 'import asyncio'.

  -X importtime=2 включает дополнительный вывод, указывающий, когда импортированный модуль уже был загружен. В таких случаях строка cached будет выведена в обеих колонках времени.

  См. также PYTHONPROFILEIMPORTTIME.

  Добавлено в версии 3.7.

  Изменено в версии 3.14: Добавлен -X importtime=2 для трассировки импорта уже загруженных модулей, а также зарезервированы значения, отличные от 1 и 2, для будущего использования.

• -X dev: включает режим разработки Python, вводя дополнительные проверки во время выполнения, которые слишком дороги для включения по умолчанию. См. также PYTHONDEVMODE.

  Добавлено в версии 3.7.

• -X utf8 включает режим UTF-8 Python. -X utf8=0 явно отключает режим UTF-8 Python (даже если в противном случае он был бы активирован автоматически). См. также PYTHONUTF8.

  Добавлено в версии 3.7.

• -X pycache_prefix=PATH включает запись файлов .pyc в параллельное дерево с корнем в указанном каталоге, а не в дерево кода. См. также PYTHONPYCACHEPREFIX.

  Добавлено в версии 3.8.

• -X warn_default_encoding выдает EncodingWarning, когда для открытия файлов используется кодировка по умолчанию, зависящая от локали. См. также PYTHONWARNDEFAULTENCODING.

  Добавлено в версии 3.10.

• -X no_debug_ranges отключает включение таблиц, сопоставляющих дополнительную информацию о местоположении (конечная строка, начальное смещение столбца и конечное смещение столбца) каждой инструкции в объектах кода. Это полезно, когда нужны меньшие объекты кода и файлы pyc, а также для подавления дополнительных визуальных индикаторов местоположения при отображении трассировок интерпретатором. См. также PYTHONNODEBUGRANGES.

  Добавлено в версии 3.12.

• -X frozen_modules определяет, игнорируются ли замороженные модули механизмом импорта. Значение on означает, что они импортируются, а off – что они игнорируются. По умолчанию on, если это установленный Python (обычный случай). Если он находится в разработке (запуск из дерева исходников), то по умолчанию off. Обратите внимание, что замороженные модули importlib_bootstrap и importlib_bootstrap_external всегда используются, даже если этот флаг установлен в off. См. также PYTHON_FROZEN_MODULES.

  Добавлено в версии 3.12.

• -X perf включает поддержку профилировщика perf в Linux. Когда эта опция задана, профилировщик perf сможет сообщать о вызовах Python. Эта опция доступна только на некоторых платформах и ничего не делает, если не поддерживается в текущей системе. Значение по умолчанию – «off». См. также PYTHONPERFSUPPORT и поддержка Python для профилировщиков, совместимых с perf map.

  Добавлено в версии 3.12.

• -X perf_jit включает поддержку профилировщика perf в Linux с поддержкой DWARF. Когда эта опция задана, профилировщик perf сможет сообщать о вызовах Python с использованием информации DWARF. Эта опция доступна только на некоторых платформах и ничего не делает, если не поддерживается в текущей системе. Значение по умолчанию – «off». См. также PYTHON_PERF_JIT_SUPPORT и поддержка Python для профилировщиков, совместимых с perf map.

  Добавлено в версии 3.13.

• -X disable_remote_debug отключает поддержку удаленной отладки, как описано в PEP 768. Это включает как возможность запланировать выполнение кода в другом процессе, так и возможность получать код для выполнения в текущем процессе.

  Эта опция доступна только на некоторых платформах и ничего не делает, если не поддерживается текущей системой. См. также PYTHON_DISABLE_REMOTE_DEBUG и PEP 768.

  Добавлено в версии 3.14.

• -X cpu_count=n переопределяет os.cpu_count(), os.process_cpu_count() и multiprocessing.cpu_count(). n должно быть больше или равно 1. Эта опция может быть полезна пользователям, которым нужно ограничить ресурсы ЦП контейнерной системы. См. также PYTHON_CPU_COUNT. Если n равно default, ничего не переопределяется.

  Добавлено в версии 3.13.

• -X presite=module или -X presite=module:func указывает точку входа, которая должна быть выполнена до того, как модуль site будет выполнен и до того, как модуль __main__ существует. Поэтому импортированный модуль не является __main__. Это можно использовать для выполнения кода на ранних этапах инициализации Python. Для существования этой опции Python должен быть собран в режиме отладки. См. также PYTHON_PRESITE.

  Изменено в версии 3.15: Принимает также module:func формат точки входа.

  Добавлено в версии 3.13.

• -X gil=0,1 принудительно отключает или включает GIL соответственно. Установка в 0 доступна только в сборках, настроенных с --disable-gil. См. также PYTHON_GIL и Free-threaded CPython.

  Добавлено в версии 3.13.

• -X thread_inherit_context=0,1 заставляет Thread по умолчанию использовать копию контекста вызывающего Thread.start() при запуске. В противном случае потоки будут запускаться с пустым контекстом. Если не задано, значение этой опции по умолчанию равно 1 в free-threaded сборках и 0 в остальных случаях. См. также PYTHON_THREAD_INHERIT_CONTEXT.

  Добавлено в версии 3.14.

• -X context_aware_warnings=0,1 заставляет контекстный менеджер warnings.catch_warnings использовать ContextVar для хранения состояния фильтра предупреждений. Если не задано, значение этой опции по умолчанию равно 1 в free-threaded сборках и 0 в остальных случаях. См. также PYTHON_CONTEXT_AWARE_WARNINGS.

  Добавлено в версии 3.14.

• -X pathconfig_warnings=0,1 если true (1), то инициализация пути поиска модулей sys.path может записывать предупреждения в stderr. Если false (0) – подавлять эти предупреждения. По умолчанию установлено в true. См. также PYTHON_PATHCONFIG_WARNINGS.

  Добавлено в версии 3.15.

• -X tlbc=0,1 включает (1, по умолчанию) или отключает (0) байткод, локальный для потока, в сборках, настроенных с --disable-gil. При отключении также отключается специализирующий интерпретатор. См. также PYTHON_TLBC.

  Добавлено в версии 3.14.

• -X lazy_imports=all,normal управляет поведением ленивого импорта. all делает все импорты ленивыми по умолчанию, а normal (по умолчанию) учитывает ключевое слово lazy в исходном коде. См. также PYTHON_LAZY_IMPORTS.

  Добавлено в версии 3.15.

Он также позволяет передавать произвольные значения и извлекать их через словарь sys._xoptions.

Добавлено в версии 3.2.

Изменено в версии 3.9: Удалена опция -X showalloccount.

Изменено в версии 3.10: Удалена опция -X oldparser.

1.1.4. Управление цветом¶Controlling color

Интерпретатор Python по умолчанию настроен использовать цвета для выделения вывода в определённых ситуациях, например при отображении трассировок. Это поведение можно контролировать с помощью настройки различных переменных окружения.

Установка переменной окружения TERM в значение dumb отключит цвет.

Если установлена переменная окружения FORCE_COLOR, цвет будет включён независимо от значения TERM. Это полезно в системах CI, которые не являются терминалами, но всё же могут отображать ANSI-escape-последовательности.

Если установлена переменная окружения NO_COLOR, Python отключит все цвета в выводе. Она имеет приоритет над FORCE_COLOR.

Все эти переменные окружения также используются другими инструментами для управления цветным выводом. Чтобы управлять цветным выводом только в интерпретаторе Python, можно использовать переменную окружения PYTHON_COLORS. Эта переменная имеет приоритет над NO_COLOR, которая, в свою очередь, имеет приоритет над FORCE_COLOR.

1.2.1. Переменные режима отладки¶Debug-mode variables

PYTHONDUMPREFS¶

Если установлено, Python будет выгружать объекты и счетчики ссылок, все еще живые после завершения работы интерпретатора.

Требуется Python, собранный с опцией сборки --with-trace-refs.

PYTHONDUMPREFSFILE¶

Если установлено, Python будет выгружать объекты и счетчики ссылок, все еще живые после завершения работы интерпретатора, в файл по пути, заданному значением этой переменной окружения.

Требуется Python, собранный с опцией сборки --with-trace-refs.

Добавлено в версии 3.12.

PYTHON_PRESITE¶

Если этой переменной присвоено имя модуля, этот модуль будет импортирован на раннем этапе жизненного цикла интерпретатора, до выполнения модуля site и до создания модуля __main__. Поэтому импортированный модуль не рассматривается как __main__.

Это можно использовать для выполнения кода на раннем этапе инициализации Python.

Чтобы импортировать подмодуль, используйте в качестве значения package.module, как в инструкции import.

См. также параметр командной строки -X presite, который имеет приоритет над этой переменной.

Требуется Python, собранный с опцией сборки --with-pydebug.

Изменено в версии 3.15: Принимает также module:func формат точки входа.

Добавлено в версии 3.13.