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

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

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

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

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

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

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

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

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

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

-c <command>¶

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

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

-m <module-name>¶

Ищет sys.path указанный модуль и выполняет его содержимое как модуль __main__.

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

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

Примечание

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

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

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

python -mtimeit -s 'setup here' 'benchmarked code here'
python -mtimeit -h # подробнее

См. также

runpy.run_module()

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

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

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

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

-

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

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

<script>

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

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

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

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

См. также

runpy.run_path()

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

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

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

-?¶

-h¶

--help¶

Выводит краткое описание всех параметров командной строки.

-V¶

--version¶

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

Python 3.6.0b2+

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

Python 3.6.0b2+ (3.6:84a3c5003510+, Oct 26 2016, 02:33:55)
[GCC 6.2.0 20161005]

Новое в версии 3.6: Опция -VV.

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

-b¶

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

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

-B¶

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

-d¶

Включить отладочный вывод парсера (только для волшебников, в зависимости от опций компиляции).\nСм. также PYTHONDEBUG.

-E¶

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

-i¶

Когда в качестве первого аргумента передан сценарий или используется опция -c, интерактивный режим запускается после выполнения сценария или команды, даже если sys.stdin не выглядит как терминал. Файл PYTHONSTARTUP при этом не читается.

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

-I¶

Запускает Python в изолированном режиме. Это также подразумевает -E и -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.

-q¶

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

Новое в версии 3.2.

-R¶

Сохранено для совместимости. Начиная с Python 3.3, рандомизация хешей включена по умолчанию.

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

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

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

Новое в версии 3.2.3.

-s¶

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

См. также

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

-S¶

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

-u¶

Принудительно сделать двоичный слой потоков stdout и stderr (доступный\nкак их атрибут buffer) небуферизованным. Текстовый слой ввода-вывода\nпо-прежнему будет буферизован построчно при выводе в консоль или\nпоблочно при перенаправлении в неинтерактивный файл.

См. также PYTHONUNBUFFERED.

-v¶

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

-W arg¶

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

file:line: category: message

По умолчанию каждое предупреждение выводится один раз для каждой строки исходного кода, в которой оно возникает. Этот параметр управляет частотой вывода предупреждений.

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

Предупреждениями также можно управлять из программы Python с помощью\nмодуля warnings.

Простейшая форма аргумента – одна из следующих строк действий (или\nуникальное сокращение):

ignore

Игнорировать все предупреждения.

default

Явно запросить поведение по умолчанию (вывод каждого предупреждения один раз на\nстроку исходного кода).

all

Выводить предупреждение при каждом его появлении (это может породить много сообщений, если\nпредупреждение вызывается многократно для одной и той же строки, например, внутри\nцикла).

module

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

once

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

error

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

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

action:message:category:module:line

Здесь action (действие) как описано выше, но применяется только к сообщениям, соответствующим\nостальным полям. Пустые поля соответствуют любым значениям; конечные пустые поля можно\nопускать. Поле message соответствует началу выводимого сообщения\nпредупреждения; сравнение нечувствительно к регистру. Поле category соответствует\nкатегории предупреждения. Это должно быть имя класса; при сравнении проверяется,\nявляется ли фактическая категория предупреждения сообщения подклассом указанной\nкатегории. Необходимо указывать полное имя класса. Поле module соответствует\n(полному) имени модуля; сравнение чувствительно к регистру. Поле line\nсоответствует номеру строки; ноль соответствует всем номерам строк и, таким образом,\nэквивалентен отсутствующему номеру строки.

См. также

warnings – модуль warnings

PEP 230 – инфраструктура предупреждений

PYTHONWARNINGS

-x¶

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

-X¶

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

• -X faulthandler для включения faulthandler;

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

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

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

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

Изменено в версии 3.2: Был добавлен параметр -X.

Новое в версии 3.3: Параметр -X faulthandler.

Новое в версии 3.4: Параметры -X showrefcount и -X tracemalloc.

Новое в версии 3.6: Опция -X showalloccount.

1.1.4. Параметры, которые не стоит использовать¶Options you shouldn’t use

-J¶

Зарезервировано для Jython.

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

Установка этих переменных работает только в отладочной сборке Python, то есть если Python был сконфигурирован с параметром сборки --with-pydebug.

PYTHONTHREADDEBUG¶

Если установлено, Python будет выводить отладочную информацию о потоках.

PYTHONDUMPREFS¶

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