`sys` – системно-зависимые параметры и функции¶sys – System-specific parameters and functions

Этот модуль предоставляет доступ к некоторым переменным, используемым или поддерживаемым интерпретатором, а также к функциям, которые активно взаимодействуют с интерпретатором. Он всегда доступен. Если явно не указано иное, все переменные доступны только для чтения.

sys.abiflags¶: В системах POSIX, где Python был собран с помощью стандартного скрипта configure, этот атрибут содержит флаги ABI, как указано в PEP 3149.

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

Изменено в версии 3.8: Флаги по умолчанию стали пустой строкой (флаг m для pymalloc был удалён).

Доступность: Unix.

sys.addaudithook(hook)¶

Добавляет вызываемый объект hook в список активных аудиторных хуков для текущего (под)интерпретатора.

Когда аудиторное событие инициируется через функцию sys.audit(), каждый хук вызывается в порядке добавления с именем события и кортежем аргументов. Нативные хуки, добавленные с помощью PySys_AddAuditHook(), вызываются первыми, затем хуки, добавленные в текущем (под)интерпретаторе. Затем хуки могут зарегистрировать событие, вызвать исключение для прерывания операции или полностью завершить процесс.

Обратите внимание, что аудиторные хуки предназначены в первую очередь для сбора информации о внутренних или иным образом ненаблюдаемых действиях, будь то в Python или в библиотеках, написанных на Python. Они не подходят для реализации «песочницы». В частности, вредоносный код может легко отключить или обойти хуки, добавленные с помощью этой функции. Как минимум, любые чувствительные с точки зрения безопасности хуки должны быть добавлены с помощью C API PySys_AddAuditHook() до инициализации среды выполнения, а любые модули, допускающие произвольное изменение памяти (такие как ctypes), должны быть полностью удалены или находиться под тщательным наблюдением.

Вызов sys.addaudithook() сам по себе инициирует аудиторное событие с именем sys.addaudithook без аргументов. Если какой-либо существующий хук вызывает исключение, производное от RuntimeError, новый хук не будет добавлен, а исключение будет подавлено. В результате вызывающие не могут предполагать, что их хук был добавлен, если только они не контролируют все существующие хуки.

См. таблицу аудиторных событий для всех событий, инициируемых CPython, и PEP 578 для обсуждения исходного дизайна.

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

Изменено в версии 3.8.1: Исключения, производные от Exception, но не от RuntimeError, больше не подавляются.

Особенность реализации CPython: Когда трассировка включена (см. settrace()), хуки Python трассируются только в том случае, если вызываемый объект имеет атрибут __cantrace__, установленный в истинное значение. В противном случае функции трассировки пропускают хук.

sys.argv¶

Список аргументов командной строки, переданных скрипту Python. argv[0] – это имя скрипта (зависит от операционной системы, является ли это полным именем пути или нет). Если команда была выполнена с использованием опции командной строки -c интерпретатора, argv[0] устанавливается в строку '-c'. Если имя скрипта не было передано интерпретатору Python, argv[0] – пустая строка.

Для циклического чтения стандартного ввода или списка файлов, переданных в командной строке, обратитесь к модулю fileinput.

См. также sys.orig_argv.

Примечание

В Unix аргументы командной строки передаются в виде байтов от ОС. Python декодирует их с помощью кодировки файловой системы и обработчика ошибок «surrogateescape». Когда нужны исходные байты, их можно получить с помощью [os.fsencode(arg) for arg in sys.argv].

sys.audit(event, *args)¶

Инициирует аудиторное событие и запускает все активные аудиторные хуки. event – строка, идентифицирующая событие, а args может содержать необязательные аргументы с дополнительной информацией о событии. Количество и типы аргументов для данного события считаются публичным и стабильным API и не должны изменяться между выпусками.

Например, одно из аудиторных событий называется os.chdir. Это событие имеет один аргумент path, который будет содержать запрошенный новый рабочий каталог.

sys.audit() вызовет существующие аудиторные хуки, передав имя события и аргументы, и вызовет первое исключение, возникшее в любом хуке. В общем случае, если возникает исключение, его не следует обрабатывать, и процесс должен быть завершен как можно быстрее. Это позволяет реализациям хуков решать, как реагировать на конкретные события: они могут просто зарегистрировать событие или прервать операцию, вызвав исключение.

Хуки добавляются с помощью функций sys.addaudithook() или PySys_AddAuditHook().

Нативным эквивалентом этой функции является PySys_Audit(). По возможности предпочтительнее использовать нативную функцию.

См. таблицу аудиторных событий для всех событий, инициируемых CPython.

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

sys.base_exec_prefix¶: Устанавливается во время запуска Python, до выполнения site.py, в то же значение, что и exec_prefix. Если работа не ведётся в виртуальном окружении, значения останутся прежними; если site.py обнаруживает, что используется виртуальное окружение, значения prefix и exec_prefix будут изменены так, чтобы указывать на виртуальное окружение, тогда как base_prefix и base_exec_prefix останутся указывающими на базовую установку Python (ту, из которой было создано виртуальное окружение).

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

sys.base_prefix¶: Устанавливается во время запуска Python, до выполнения site.py, в то же значение, что и prefix. Если работа не ведётся в виртуальном окружении, значения останутся прежними; если site.py обнаруживает, что используется виртуальное окружение, значения prefix и exec_prefix будут изменены так, чтобы указывать на виртуальное окружение, тогда как base_prefix и base_exec_prefix останутся указывающими на базовую установку Python (ту, из которой было создано виртуальное окружение).

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

sys.byteorder¶: Индикатор естественного порядка байт. Имеет значение 'big' на платформах с big-endian (от старшего байта к младшему) и 'little' на платформах с little-endian (от младшего байта к старшему).

sys.builtin_module_names¶

Кортеж строк, содержащий имена всех модулей, встроенных в данный интерпретатор Python. (Эту информацию нельзя получить иным способом – modules.keys() перечисляет только импортированные модули.)

См. также список sys.stdlib_module_names.

sys.call_tracing(func, args)¶

Вызывает func(*args) при включённой трассировке. Состояние трассировки сохраняется и восстанавливается после завершения. Предназначена для вызова из отладчика в контрольной точке, чтобы рекурсивно отлаживать или профилировать другой код.

Трассировка приостанавливается при вызове трассирующей функции, установленной через settrace() или setprofile(), чтобы избежать бесконечной рекурсии. call_tracing() включает явную рекурсию трассирующей функции.

sys.copyright¶: Строка, содержащая сведения об авторских правах на интерпретатор Python.

sys._clear_type_cache()¶

Очищает внутренний кеш типов. Кеш типов используется для ускорения поиска атрибутов и методов. Эту функцию следует использовать только для удаления лишних ссылок при отладке утечек ссылок.

Эту функцию следует использовать только для внутренних и специальных целей.

Устарело с версии 3.13: Вместо неё используйте более общую функцию _clear_internal_caches().

sys._clear_internal_caches()¶: Очищает все внутренние кеши, связанные с производительностью. Используйте эту функцию только для освобождения лишних ссылок и блоков памяти при поиске утечек.

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

sys._current_frames()¶

Возвращает словарь, отображающий идентификатор каждого потока на верхний кадр стека, активный в этом потоке на момент вызова функции. Обратите внимание, что функции модуля traceback могут построить стек вызовов по такому кадру.

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

Эту функцию следует использовать только для внутренних и специальных целей.

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

sys._current_exceptions()¶

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

Это наиболее полезно для статистического профилирования.

Эту функцию следует использовать только для внутренних и специальных целей.

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

Изменено в версии 3.12: Каждое значение в словаре теперь является одним экземпляром исключения, а не кортежем из 3 элементов, как возвращается из sys.exc_info().

sys.breakpointhook()¶

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

Сигнатура этой функции зависит от того, что она вызывает. Например, привязка по умолчанию (например, pdb.set_trace()) не ожидает аргументов, но эту функцию можно привязать к функции, которая ожидает дополнительные аргументы (позиционные и/или именованные). Встроенная функция breakpoint() передаёт свои *args и **kws напрямую. Всё, что возвращает breakpointhooks(), возвращается из breakpoint().

Реализация по умолчанию сначала проверяет переменную окружения PYTHONBREAKPOINT. Если она установлена в "0", функция немедленно возвращается; то есть это пустая операция. Если переменная окружения не установлена или установлена в пустую строку, вызывается pdb.set_trace(). В противном случае эта переменная должна содержать имя функции для запуска, используя точечную нотацию импорта Python, например package.subpackage.module.function. В этом случае импортируется package.subpackage.module, и полученный модуль должен содержать вызываемый объект с именем function(). Он запускается с передачей *args и **kws, и всё, что возвращает function(), sys.breakpointhook() возвращает во встроенную функцию breakpoint().

Обратите внимание: если при импорте вызываемого объекта, указанного в PYTHONBREAKPOINT, что-то идёт не так, сообщается RuntimeWarning и точка останова игнорируется.

Также обратите внимание, что если sys.breakpointhook() переопределяется программно, PYTHONBREAKPOINT не учитывается.

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

sys._debugmallocstats()¶

Выводит в stderr низкоуровневую информацию о состоянии распределителя памяти CPython.

Если Python собран в отладочном режиме (configure --with-pydebug option), он также выполняет некоторые ресурсоёмкие проверки внутренней согласованности.

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

Особенность реализации CPython: Эта функция специфична для CPython. Точный формат вывода здесь не определён и может измениться.

sys.dllhandle¶: Целое число, задающее дескриптор DLL Python.

Доступность: Windows.

sys.displayhook(value)¶

Если value не равно None, эта функция выводит repr(value) в sys.stdout и сохраняет value в builtins._. Если repr(value) не кодируется в sys.stdout.encoding с обработчиком ошибок sys.stdout.errors (который, вероятно, 'strict'), он кодируется в sys.stdout.encoding с обработчиком ошибок 'backslashreplace'.

sys.displayhook вызывается для результата вычисления выражения, введённого в интерактивном сеансе Python. Отображение этих значений можно настроить, присвоив другую функцию с одним аргументом sys.displayhook.

Псевдокод:

def displayhook(value):
    if value is None:
        return
    # Установите '_' в None, чтобы избежать рекурсии
    builtins._ = None
    text = repr(value)
    try:
        sys.stdout.write(text)
    except UnicodeEncodeError:
        bytes = text.encode(sys.stdout.encoding, 'backslashreplace')
        if hasattr(sys.stdout, 'buffer'):
            sys.stdout.buffer.write(bytes)
        else:
            text = bytes.decode(sys.stdout.encoding, 'strict')
            sys.stdout.write(text)
    sys.stdout.write("\n")
    builtins._ = value

Изменено в версии 3.2: Используется обработчик ошибок 'backslashreplace' для UnicodeEncodeError.

sys.dont_write_bytecode¶: If this is true, Python won’t try to write .pyc files on the import of source modules. This value is initially set to True or False depending on the -B command line option and the PYTHONDONTWRITEBYTECODE environment variable, but you can set it yourself to control bytecode file generation.

sys._emscripten_info¶

Именованный кортеж, содержащий информацию об окружении на платформе wasm32-emscripten. Именованный кортеж является временным и может измениться в будущем.

_emscripten_info.emscripten_version¶: Версия Emscripten в виде кортежа целых чисел (major, minor, micro), например (3, 1, 8).

_emscripten_info.runtime¶: Строка среды выполнения, например, пользовательский агент браузера, 'Node.js v14.18.2' или 'UNKNOWN'.

_emscripten_info.pthreads¶: True, если Python скомпилирован с поддержкой Emscripten pthreads.

_emscripten_info.shared_memory¶: True, если Python скомпилирован с поддержкой разделяемой памяти.

Доступность: Emscripten.

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

sys.pycache_prefix¶

Если это установлено (не None), Python будет записывать файлы .pyc кэша байт-кода (и читать их) в параллельном дереве каталогов с корнем в этом каталоге, а не в каталогах __pycache__ в дереве исходного кода. Любые каталоги __pycache__ в дереве исходного кода будут игнорироваться, а новые файлы .pyc будут записываться внутри префикса pycache. Поэтому, если вы используете compileall в качестве этапа предварительной сборки, убедитесь, что запускаете его с тем же префиксом pycache (если он есть), который будете использовать во время выполнения.

Относительный путь интерпретируется относительно текущего рабочего каталога.

This value is initially set based on the value of the -X pycache_prefix=PATH command-line option or the PYTHONPYCACHEPREFIX environment variable (command-line takes precedence). If neither are set, it is None.

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

sys.excepthook(type, value, traceback)¶

Эта функция выводит заданную трассировку и исключение в sys.stderr.

Когда возникает неперехваченное исключение, отличное от SystemExit, интерпретатор вызывает sys.excepthook с тремя аргументами: классом исключения, экземпляром исключения и объектом трассировки. В интерактивном сеансе это происходит непосредственно перед возвратом управления в приглашение; в программе Python это происходит непосредственно перед выходом программы. Обработку таких исключений верхнего уровня можно настроить, присвоив другую функцию с тремя аргументами sys.excepthook.

Генерирует событие аудита sys.excepthook с аргументами hook, type, value, traceback, когда возникает неперехваченное исключение. Если обработчик не установлен, hook может быть None. Если какой-либо обработчик генерирует исключение, производное от RuntimeError, вызов обработчика будет подавлен. В противном случае исключение обработчика аудита будет зарегистрировано как необрабатываемое и будет вызван sys.excepthook.

См. также

Функция sys.unraisablehook() обрабатывает необрабатываемые исключения, а функция threading.excepthook() обрабатывает исключения, возникающие в threading.Thread.run().

sys.__breakpointhook__¶
sys.__displayhook__¶
sys.__excepthook__¶
sys.__unraisablehook__¶: Эти объекты содержат исходные значения breakpointhook, displayhook, excepthook и unraisablehook на момент запуска программы. Они сохраняются, чтобы breakpointhook, displayhook и excepthook, unraisablehook можно было восстановить, если они вдруг будут заменены повреждёнными или альтернативными объектами.

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

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

sys.exception()¶

Эта функция, вызванная во время выполнения обработчика исключений (например, в предложении except или except*), возвращает экземпляр исключения, перехваченного этим обработчиком. Когда обработчики исключений вложены друг в друга, доступно только исключение, обрабатываемое самым внутренним обработчиком.

Если ни один обработчик исключений не выполняется, эта функция возвращает None.

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

sys.exc_info()¶

Эта функция возвращает представление обработанного исключения в старом стиле. Если в данный момент обрабатывается исключение e (так что exception() вернёт e), exc_info() возвращает кортеж (type(e), e, e.__traceback__). То есть кортеж, содержащий тип исключения (подкласс BaseException), само исключение и traceback объект, который, как правило, инкапсулирует стек вызовов в точке, где последний раз произошло исключение.

Если нигде в стеке не обрабатывается исключение, эта функция возвращает кортеж из трёх значений None.

Изменено в версии 3.11: Поля type и traceback теперь берутся из value (экземпляра исключения), поэтому при изменении исключения во время его обработки изменения отражаются в результатах последующих вызовов exc_info().

sys.exec_prefix¶: Строка, содержащая префикс директории, зависящий от сайта, в который устанавливаются платформозависимые файлы Python; по умолчанию это также '/usr/local'. Этот префикс можно задать во время сборки с помощью аргумента --exec-prefix скрипта configure. В частности, все файлы конфигурации (например, заголовочный файл pyconfig.h) устанавливаются в каталог exec_prefix/lib/pythonX.Y/config, а модули разделяемых библиотек – в exec_prefix/lib/pythonX.Y/lib-dynload, где X.Y – номер версии Python, например 3.2.

Примечание

Если виртуальное окружение активно, это значение будет изменено в site.py так, чтобы указывать на виртуальное окружение. Значение для установки Python останется доступным через base_exec_prefix.

sys.executable¶: Строка, содержащая абсолютный путь к исполняемому файлу интерпретатора Python на системах, где это имеет смысл. Если Python не может получить реальный путь к своему исполняемому файлу, sys.executable будет пустой строкой или None.

sys.exit([arg])¶

Вызывает исключение SystemExit, сигнализируя о намерении завершить интерпретатор.

Необязательный аргумент arg может быть целым числом, задающим код завершения (по умолчанию ноль), или объектом другого типа. Если это целое число, ноль считается «успешным завершением», а любое ненулевое значение – «аварийным завершением» для оболочек и подобных программ. Большинство систем требуют, чтобы оно находилось в диапазоне 0–127, иначе результат неопределён. В некоторых системах существуют соглашения о присвоении определённых значений определённым кодам завершения, но обычно они слабо развиты; программы Unix обычно используют 2 для ошибок синтаксиса командной строки и 1 для всех остальных ошибок. Если передан объект другого типа, None эквивалентен передаче нуля, а любой другой объект выводится в stderr и приводит к коду завершения 1. В частности, sys.exit("some error message") – быстрый способ выйти из программы при возникновении ошибки.

Поскольку exit() в конечном счёте «всего лишь» вызывает исключение, он завершает процесс, только если вызван из главного потока и исключение не перехвачено. Действия по очистке, указанные в предложениях finally операторов try, выполняются, и попытку выхода можно перехватить на внешнем уровне.

Изменено в версии 3.6: Если возникает ошибка при очистке после того, как интерпретатор Python перехватил SystemExit (например, ошибка сброса буферизованных данных в стандартных потоках), код завершения изменяется на 120.

sys.flags¶

Именованный кортеж flags показывает состояние флагов командной строки. Атрибуты доступны только для чтения.

flags.debug¶	`-d`
flags.inspect¶	`-i`
flags.interactive¶	`-i`
flags.isolated¶	`-I`
flags.optimize¶	`-O` или `-OO`
flags.dont_write_bytecode¶	`-B`
flags.no_user_site¶	`-s`
flags.no_site¶	`-S`
flags.ignore_environment¶	`-E`
flags.verbose¶	`-v`
flags.bytes_warning¶	`-b`
flags.quiet¶	`-q`
flags.hash_randomization¶	`-R`
flags.dev_mode¶	`-X dev` (Режим разработки Python)
flags.utf8_mode¶	`-X utf8`
flags.safe_path¶	`-P`
flags.int_max_str_digits¶	`-X int_max_str_digits` (ограничение длины преобразования целого числа в строку)
flags.warn_default_encoding¶	`-X warn_default_encoding`

Изменено в версии 3.2: Добавлен атрибут quiet для нового флага -q.

Добавлено в версии 3.2.3: Атрибут hash_randomization.

Изменено в версии 3.3: Удалён устаревший атрибут division_warning.

Изменено в версии 3.4: Добавлен атрибут isolated для флага -I isolated.

Изменено в версии 3.7: Добавлен атрибут dev_mode для нового режима разработки Python, а также атрибут utf8_mode для нового флага -X utf8.

Изменено в версии 3.10: Добавлен атрибут warn_default_encoding для флага -X warn_default_encoding.

Изменено в версии 3.11: Добавлен атрибут safe_path для параметра -P.

Изменено в версии 3.11: Добавлен атрибут int_max_str_digits.

sys.float_info¶

Именованный кортеж, содержащий информацию о типе float. В нём представлены низкоуровневые сведения о точности и внутреннем представлении. Значения соответствуют различным константам с плавающей точкой, определённым в стандартном заголовочном файле float.h для языка программирования C; подробности см. в разделе 5.2.4.2.2 стандарта ISO/IEC C 1999 [C99], «Характеристики типов с плавающей точкой».

Атрибуты `float_info` именованного кортежа¶
атрибут	float.h макрос	объяснение
float_info.epsilon¶	`DBL_EPSILON`	разница между 1.0 и наименьшим значением, большим 1.0, которое можно представить в виде числа с плавающей запятой. См. также `math.ulp()`.
float_info.dig¶	`DBL_DIG`	Максимальное количество десятичных цифр, которое можно точно представить в виде числа с плавающей запятой; см. ниже.
float_info.mant_dig¶	`DBL_MANT_DIG`	Точность float: количество цифр по основанию `radix` в мантиссе числа с плавающей запятой.
float_info.max¶	`DBL_MAX`	Максимальное представимое положительное конечное число с плавающей запятой.
float_info.max_exp¶	`DBL_MAX_EXP`	Максимальное целое e, для которого `radix**(e-1)` является представимым конечным числом с плавающей запятой.
float_info.max_10_exp¶	`DBL_MAX_10_EXP`	Максимальное целое e, для которого `10**e` находится в диапазоне представимых конечных чисел с плавающей запятой.
float_info.min¶	`DBL_MIN`	Минимальное представимое положительное нормализованное число с плавающей запятой. Используйте `math.ulp(0.0)` для получения наименьшего положительного денормализованного представимого числа с плавающей запятой.
float_info.min_exp¶	`DBL_MIN_EXP`	Минимальное целое e, для которого `radix**(e-1)` является нормализованным числом с плавающей запятой.
float_info.min_10_exp¶	`DBL_MIN_10_EXP`	Минимальное целое e, для которого `10**e` является нормализованным числом с плавающей запятой.
float_info.radix¶	`FLT_RADIX`	Основание представления порядка.
float_info.rounds¶	`FLT_ROUNDS`	Целое число, представляющее режим округления для арифметики с плавающей запятой. Оно отражает значение системного макроса `FLT_ROUNDS` на момент запуска интерпретатора: `-1`: неопределимый `0`: к нулю `1`: к ближайшему `2`: к положительной бесконечности `3`: к отрицательной бесконечности Все остальные значения для `FLT_ROUNDS` описывают поведение округления, определяемое реализацией.

Атрибут sys.float_info.dig требует дополнительного пояснения. Если s – любая строка, представляющая десятичное число не более чем с sys.float_info.dig значащими цифрами, то преобразование s в float и обратно даст строку, представляющую то же десятичное значение:

>>> import sys
>>> sys.float_info.dig
15
>>> s = '3.14159265358979'    # десятичная строка с 15 значащими цифрами
>>> format(float(s), '.15g')  # Преобразование во float и обратно -> то же значение
'3.14159265358979'

Но для строк с более чем sys.float_info.dig значащими цифрами это верно не всегда:

>>> s = '9876543211234567'    # 16 значащих цифр – слишком много!
>>> format(float(s), '.16g')  # преобразование изменяет значение
'9876543211234568'

sys.float_repr_style¶: Строка, указывающая, как ведёт себя функция repr() для чисел с плавающей запятой. Если строка имеет значение 'short', то для конечного float x, repr(x) стремится создать короткую строку с тем свойством, что float(repr(x)) == x. Это обычное поведение в Python 3.1 и новее. В противном случае float_repr_style имеет значение 'legacy', и repr(x) ведёт себя так же, как в версиях Python до 3.1.

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

sys.getallocatedblocks()¶

Возвращает количество блоков памяти, выделенных в данный момент интерпретатором, независимо от их размера. Эта функция в основном полезна для отслеживания и отладки утечек памяти. Из-за внутренних кешей интерпретатора результат может меняться от вызова к вызову; возможно, потребуется вызвать _clear_internal_caches() и gc.collect(), чтобы получить более предсказуемые результаты.

Если сборка или реализация Python не может обоснованно вычислить эту информацию, getallocatedblocks() разрешено возвращать 0.

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

sys.getunicodeinternedsize()¶: Возвращает количество интернированных Unicode-объектов.

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

sys.getandroidapilevel()¶: Возвращает уровень API Android на момент сборки в виде целого числа. Это минимальная версия Android, на которой может работать данная сборка Python. Информацию о версии во время выполнения см. в platform.android_ver().

Доступность: Android.

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

sys.getdefaultencoding()¶: Возвращает 'utf-8'. Это имя кодировки строк по умолчанию, используемой в таких методах, как str.encode().

sys.getdlopenflags()¶: Возвращает текущее значение флагов, используемых для вызовов dlopen(). Символические имена значений флагов можно найти в модуле os (константы RTLD_xxx, например os.RTLD_LAZY).

Доступность: Unix.

sys.getfilesystemencoding()¶

Возвращает кодировку файловой системы: кодировку, используемую с обработчиком ошибок файловой системы для преобразования между именами файлов в Unicode и байтами. Обработчик ошибок файловой системы возвращается из getfilesystemencodeerrors().

Для лучшей совместимости во всех случаях следует использовать str для имён файлов, хотя представление имён файлов в виде байтов также поддерживается. Функции, принимающие или возвращающие имена файлов, должны поддерживать str или bytes и внутренне преобразовывать в предпочтительное представление системы.

os.fsencode() и os.fsdecode() следует использовать, чтобы гарантировать применение правильной кодировки и режима обработки ошибок.

Кодировка файловой системы и обработчик ошибок настраиваются при запуске Python функцией PyConfig_Read(): см. члены filesystem_encoding и filesystem_errors объекта PyConfig.

Изменено в версии 3.2: результат getfilesystemencoding() больше не может быть None.

Изменено в версии 3.6: Windows больше не гарантирует возврат 'mbcs'. Подробнее см. PEP 529 и _enablelegacywindowsfsencoding().

Изменено в версии 3.7: Возвращает 'utf-8', если включён режим UTF-8 Python.

sys.getfilesystemencodeerrors()¶

Возвращает обработчик ошибок файловой системы: обработчик ошибок, используемый с кодировкой файловой системы для преобразования между именами файлов в Unicode и байтами. Кодировка файловой системы возвращается из getfilesystemencoding().

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

sys.get_int_max_str_digits()¶: Возвращает текущее значение ограничения длины преобразования целого числа в строку. См. также set_int_max_str_digits().

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

sys.getrefcount(object)¶

Возвращает счётчик ссылок на объект. Возвращаемое значение обычно на единицу больше, чем можно ожидать, поскольку включает (временную) ссылку как аргумент getrefcount().

Обратите внимание, что возвращаемое значение может не отражать реальное количество ссылок на объект. Например, некоторые объекты являются бессмертными и имеют очень высокий счётчик ссылок, который не отражает фактическое количество ссылок. Поэтому не полагайтесь на точность возвращаемого значения, за исключением случаев, когда оно равно 0 или 1.

Изменено в версии 3.12: Бессмертные объекты имеют очень большие счётчики ссылок, которые не соответствуют фактическому количеству ссылок на объект.

sys.getrecursionlimit()¶: Возвращает текущее значение предела рекурсии – максимальную глубину стека интерпретатора Python. Этот предел предотвращает переполнение стека C и падение Python из-за бесконечной рекурсии. Его можно задать с помощью setrecursionlimit().

sys.getsizeof(object[, default])¶

Возвращает размер объекта в байтах. Объект может быть любого типа. Все встроенные объекты возвращают корректные результаты, но для сторонних расширений это не обязательно – результат зависит от реализации.

Учитывается только память, непосредственно занимаемая объектом, а не память объектов, на которые он ссылается.

Если задан параметр default, он будет возвращён в случае, если объект не предоставляет способа получить размер. В противном случае возбуждается TypeError.

getsizeof() вызывает метод __sizeof__ объекта и добавляет дополнительную нагрузку сборщика мусора, если объект управляется сборщиком мусора.

См. рецепт рекурсивного sizeof для примера использования getsizeof() рекурсивно для определения размера контейнеров и всего их содержимого.

sys.getswitchinterval()¶: Возвращает «интервал переключения потоков» интерпретатора в секундах; см. setswitchinterval().

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

sys._getframe([depth])¶

Возвращает объект кадра из стека вызовов. Если задан необязательный целочисленный параметр depth, возвращается кадр, находящийся на указанное количество вызовов ниже вершины стека. Если это глубже, чем стек вызовов, возбуждается ValueError. Значение по умолчанию для depth равно нулю – возвращается кадр на вершине стека вызовов.

Вызывает событие аудита sys._getframe с аргументом frame.

Особенности реализации CPython: Эта функция предназначена только для внутренних и специализированных целей. Она не гарантированно существует во всех реализациях Python.

sys._getframemodulename([depth])¶

Возвращает имя модуля из стека вызовов. Если задан необязательный целочисленный параметр depth, возвращается модуль, находящийся на указанное количество вызовов ниже вершины стека. Если это глубже, чем стек вызовов, или модуль не идентифицируется, возвращается None. Значение по умолчанию для depth равно нулю – возвращается модуль на вершине стека вызовов.

Вызывает событие аудита sys._getframemodulename с аргументом depth.

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

sys.getobjects(limit[, type])¶

Эта функция существует только в том случае, если CPython был собран с использованием специальной опции конфигурации --with-trace-refs. Она предназначена исключительно для отладки проблем сборки мусора.

Возвращает список из не более limit динамически выделенных объектов Python. Если задан type, включаются только объекты этого точного типа (не подтипы).

Объекты из списка небезопасно использовать. В частности, результат будет включать объекты из всех интерпретаторов, у которых общее состояние аллокатора объектов (то есть созданных с PyInterpreterConfig.use_main_obmalloc, установленным в 1, или с использованием Py_NewInterpreter(), а также главного интерпретатора). Смешивание объектов из разных интерпретаторов может привести к сбоям или другому неожиданному поведению.

Особенность реализации CPython: Эту функцию следует использовать только для специализированных целей. Не гарантируется её наличие во всех реализациях Python.

Изменено в версии 3.13.1: Результат может содержать объекты из других интерпретаторов.

sys.getprofile()¶: Возвращает профилирующую функцию, установленную с помощью setprofile().

sys.gettrace()¶: Возвращает трассировочную функцию, установленную с помощью settrace().

Особенность реализации CPython: Функция gettrace() предназначена только для реализации отладчиков, профилировщиков, инструментов покрытия кода и тому подобного. Её поведение является частью платформы реализации, а не частью определения языка, и поэтому может быть недоступно во всех реализациях Python.

sys.getwindowsversion()¶

Возвращает именованный кортеж с информацией о текущей версии Windows. Именованные элементы: major, minor, build, platform, service_pack, service_pack_minor, service_pack_major, suite_mask, product_type и platform_version. service_pack – строка, platform_version – кортеж из трёх элементов, все остальные значения – целые числа. К компонентам также можно обращаться по имени, так что sys.getwindowsversion()[0] эквивалентно sys.getwindowsversion().major. Для совместимости с предыдущими версиями по индексу доступны только первые 5 элементов.

platform будет равен 2 (VER_PLATFORM_WIN32_NT).

product_type может быть одним из следующих значений:

Константа	Значение
`1` (VER_NT_WORKSTATION)	Система является рабочей станцией.
`2` (VER_NT_DOMAIN_CONTROLLER)	Система является контроллером домена.
`3` (VER_NT_SERVER)	Система является сервером, но не контроллером домена.

Эта функция является обёрткой над функцией Win32 GetVersionEx(); см. документацию Microsoft по OSVERSIONINFOEX() для получения дополнительных сведений об этих полях.

platform_version возвращает основной номер версии, дополнительный номер версии и номер сборки текущей операционной системы, а не версию, которая эмулируется для процесса. Она предназначена для использования в журналировании, а не для определения возможностей.

Примечание

platform_version получает версию из kernel32.dll, которая может иметь версию, отличную от версии ОС. Для получения точной версии ОС используйте модуль platform.

Доступность: Windows.

Изменено в версии 3.2: Изменён на именованный кортеж и добавлены service_pack_minor, service_pack_major, suite_mask и product_type.

Изменено в версии 3.6: Добавлен platform_version

sys.get_asyncgen_hooks()¶: Возвращает объект asyncgen_hooks, который похож на namedtuple вида (firstiter, finalizer), где firstiter и finalizer должны быть либо None, либо функциями, принимающими итератор асинхронного генератора в качестве аргумента, и используются для планирования финализации асинхронного генератора в цикле событий.

Добавлено в версии 3.6: Подробнее см. PEP 525.

Примечание

Эта функция была добавлена на временной основе (см. PEP 411 для подробностей).

sys.get_coroutine_origin_tracking_depth()¶: Возвращает текущую глубину отслеживания источника корутины, установленную с помощью set_coroutine_origin_tracking_depth().

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

Примечание

Эта функция была добавлена на временной основе (см. PEP 411 для подробностей). Используйте её только для целей отладки.

sys.hash_info¶

Именованный кортеж, задающий параметры реализации числового хеша. Подробнее о хешировании числовых типов см. Хеширование числовых типов.

hash_info.width¶: Ширина в битах, используемая для значений хеша.

hash_info.modulus¶: Простой модуль P, используемый в схеме числового хеширования.

hash_info.inf¶: Хеш-значение, возвращаемое для положительной бесконечности.

hash_info.nan¶: (Этот атрибут больше не используется).

hash_info.imag¶: Множитель, используемый для мнимой части комплексного числа.

hash_info.algorithm¶: Название алгоритма хеширования для str, bytes и memoryview.

hash_info.hash_bits¶: Внутренний размер вывода алгоритма хеширования

hash_info.seed_bits¶: Размер начального ключа алгоритма хеширования

hash_info.cutoff¶: Порог для оптимизации DJBX33A для коротких строк в диапазоне [1, cutoff).

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

Изменено в версии 3.4: Добавлены algorithm, hash_bits, seed_bits и cutoff.

sys.hexversion¶

Номер версии, закодированный в виде одного целого числа. Гарантируется, что он увеличивается с каждой версией, включая надлежащую поддержку непроизводственных выпусков. Например, чтобы проверить, что интерпретатор Python имеет версию не ниже 1.5.2, используйте:

if sys.hexversion >= 0x010502F0:
    # используйте некоторую продвинутую функцию
    ...
else:
    # используйте альтернативную реализацию или предупредите пользователя
    ...

Это называется hexversion, поскольку оно действительно имеет смысл только при просмотре как результат передачи его встроенной функции hex(). Именованный кортеж sys.version_info может использоваться для более удобочитаемого кодирования той же информации.

Более подробная информация о hexversion доступна на API and ABI Versioning.

sys.implementation¶

Объект, содержащий информацию о реализации текущего интерпретатора Python. Следующие атрибуты должны существовать во всех реализациях Python.

name – идентификатор реализации, например 'cpython'. Фактическая строка определяется реализацией Python, но гарантированно состоит из строчных букв.

version – это именованный кортеж в том же формате, что и sys.version_info. Он представляет версию реализации Python. Это отличается от конкретной версии языка Python, которой соответствует текущий интерпретатор, которая представлена sys.version_info. Например, для PyPy 1.8 sys.implementation.version может быть sys.version_info(1, 8, 0, 'final', 0), тогда как sys.version_info будет sys.version_info(2, 7, 2, 'final', 0). Для CPython они совпадают, так как это эталонная реализация.

hexversion – это версия реализации в шестнадцатеричном формате, например sys.hexversion.

cache_tag – это тег, используемый механизмом импорта в именах файлов кэшированных модулей. По соглашению, он представляет собой комбинацию имени и версии реализации, например 'cpython-33'. Однако реализация Python может использовать другое значение, если это уместно. Если cache_tag установлено в None, это означает, что кэширование модулей должно быть отключено.

sys.implementation может содержать дополнительные атрибуты, специфичные для реализации Python. Эти нестандартные атрибуты должны начинаться с подчеркивания и не описываются здесь. Независимо от содержимого, sys.implementation не будет изменяться во время работы интерпретатора, а также между версиями реализации. (Однако он может измениться между версиями языка Python.) Смотри PEP 421 для получения дополнительной информации.

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

Примечание

Добавление новых обязательных атрибутов должно проходить через обычный процесс PEP. Смотри PEP 421 для получения дополнительной информации.

sys.int_info¶

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

int_info.bits_per_digit¶: Количество битов в каждом разряде. Целые числа Python хранятся внутри в системе с основанием 2**int_info.bits_per_digit.

int_info.sizeof_digit¶: Размер в байтах типа C, используемого для представления разряда.

int_info.default_max_str_digits¶: Значение по умолчанию для sys.get_int_max_str_digits(), если не задано явно.

int_info.str_digits_check_threshold¶: Минимальное ненулевое значение для sys.set_int_max_str_digits(), PYTHONINTMAXSTRDIGITS или -X int_max_str_digits.

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

Изменено в версии 3.11: Добавлены default_max_str_digits и str_digits_check_threshold.

sys.__interactivehook__¶

Когда этот атрибут существует, его значение автоматически вызывается (без аргументов) при запуске интерпретатора в интерактивном режиме. Это происходит после чтения файла PYTHONSTARTUP, чтобы можно было установить этот перехватчик там. Модуль site устанавливает это.

Вызывает событие аудита cpython.run_interactivehook с объектом перехватчика в качестве аргумента при вызове перехватчика при запуске.

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

sys.intern(string)¶

Помещает строку в таблицу «интернированных» строк и возвращает интернированную строку – строку (ту же самую или копию). Интернирование строк полезно для небольшого повышения производительности поиска в словаре: если ключи в словаре интернированы и искомый ключ интернирован, сравнение ключей (после хеширования) может выполняться сравнением указателей, а не строк. Обычно имена, используемые в программах Python, автоматически интернируются, и словари, используемые для хранения атрибутов модулей, классов или экземпляров, имеют интернированные ключи.

Интернированные строки не являются бессмертными; необходимо сохранять ссылку на возвращаемое значение intern(), чтобы извлечь из этого пользу.

sys._is_gil_enabled()¶: Возвращает True, если GIL включён, и False, если он отключён.

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

Особенность реализации CPython: Не гарантируется, что эта возможность существует во всех реализациях Python.

sys.is_finalizing()¶

Возвращает True, если главный интерпретатор Python завершает работу. В противном случае возвращает False.

Смотрите также исключение PythonFinalizationError.

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

sys.last_exc¶: Эта переменная определена не всегда; она устанавливается в экземпляр исключения, когда исключение не обработано и интерпретатор выводит сообщение об ошибке и стек вызовов. Предполагаемое использование – позволить интерактивному пользователю импортировать модуль отладчика и заняться пост-мортем отладкой без необходимости повторно выполнять команду, вызвавшую ошибку. (Обычное использование – import pdb; pdb.pm() для входа в пост-мортем отладчик; см. модуль pdb для получения дополнительной информации.)

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

sys._is_interned(string)¶: Возвращает True, если указанная строка «интернирована», False в противном случае.

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

Особенность реализации CPython: Не гарантируется, что эта возможность существует во всех реализациях Python.

sys.last_type¶
sys.last_value¶
sys.last_traceback¶: Эти три переменные устарели; вместо них используйте sys.last_exc. Они содержат устаревшее представление sys.last_exc, возвращаемое из exc_info() выше.

sys.maxsize¶: Целое число, задающее максимальное значение, которое может принимать переменная типа Py_ssize_t. Обычно это 2**31 - 1 на 32-битной платформе и 2**63 - 1 на 64-битной платформе.

sys.maxunicode¶: Целое число, задающее значение самого большого кодового пункта Unicode, то есть 1114111 (0x10FFFF в шестнадцатеричной записи).

Изменено в версии 3.3: До PEP 393, sys.maxunicode был либо 0xFFFF, либо 0x10FFFF, в зависимости от параметра конфигурации, определявшего, хранятся ли символы Unicode как UCS-2 или UCS-4.

sys.meta_path¶

Список объектов искателей по мета-пути, у которых вызываются методы find_spec(), чтобы определить, может ли один из объектов найти импортируемый модуль. По умолчанию содержит записи, реализующие стандартную семантику импорта Python. Метод find_spec() вызывается как минимум с абсолютным именем импортируемого модуля. Если импортируемый модуль находится в пакете, то атрибут __path__ родительского пакета передаётся вторым аргументом. Метод возвращает спецификацию модуля или None, если модуль не найден.

См. также

importlib.abc.MetaPathFinder: Абстрактный базовый класс, определяющий интерфейс объектов-искателей на meta_path.
importlib.machinery.ModuleSpec: Конкретный класс, экземпляры которого должен возвращать find_spec().

Изменено в версии 3.4: Спецификации модулей были введены в Python 3.4 согласно PEP 451.

Изменено в версии 3.12: Убран запасной вариант, который искал метод find_module(), если запись meta_path не имела метода find_spec().

sys.modules¶: Это словарь, отображающий имена модулей на уже загруженные модули. Его можно изменять, чтобы принудительно перезагружать модули и выполнять другие трюки. Однако замена словаря не обязательно сработает как ожидается, а удаление важных элементов из словаря может привести к сбою Python. Если нужно перебрать этот глобальный словарь, всегда используйте sys.modules.copy() или tuple(sys.modules), чтобы избежать исключений, так как его размер может меняться во время итерации из-за побочных эффектов кода или активности в других потоках.

sys.orig_argv¶

Список исходных аргументов командной строки, переданных исполняемому файлу Python.

Элементы sys.orig_argv – это аргументы интерпретатора Python, а элементы sys.argv – аргументы программы пользователя. Аргументы, потреблённые самим интерпретатором, будут присутствовать в sys.orig_argv и отсутствовать в sys.argv.

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

sys.path¶

Список строк, задающий путь поиска модулей. Инициализируется из переменной окружения PYTHONPATH, а также из специфичного для установки значения по умолчанию.

По умолчанию при инициализации при запуске программы потенциально небезопасный путь добавляется в начало sys.path (перед записями, вставленными в результате PYTHONPATH):

Командная строка python -m module: добавить в начало текущий рабочий каталог.
Командная строка python script.py: добавить в начало каталог скрипта. Если это символическая ссылка, разрешить символические ссылки.
Командные строки python -c code и python (REPL): добавить в начало пустую строку, что означает текущий рабочий каталог.

Чтобы не добавлять этот потенциально небезопасный путь, используйте параметр командной строки -P или переменную окружения PYTHONSAFEPATH.

Программа может изменять этот список для своих целей. В sys.path следует добавлять только строки; все остальные типы данных игнорируются при импорте.

См. также

Модуль site. В нём описано, как использовать файлы .pth для расширения sys.path.

sys.path_hooks¶

Список вызываемых объектов, которые принимают аргумент-путь и пытаются создать искатель для этого пути. Если искатель может быть создан, вызываемый объект должен вернуть его, иначе – возбудить ImportError.

Впервые описано в PEP 302.

sys.path_importer_cache¶

Словарь, выступающий в роли кэша для объектов finder. Ключами являются пути, переданные в sys.path_hooks, а значениями – найденные finder'ы. Если путь является корректным файловым системным путём, но на sys.path_hooks не найден ни один finder, то сохраняется None.

Впервые описано в PEP 302.

sys.platform¶

Строка, содержащая идентификатор платформы. Известные значения:

Система	`platform` значение
AIX	`'aix'`
Android	`'android'`
Emscripten	`'emscripten'`
iOS	`'ios'`
Linux	`'linux'`
macOS	`'darwin'`
Windows	`'win32'`
Windows/Cygwin	`'cygwin'`
WASI	`'wasi'`

На системах Unix, не перечисленных в таблице, значением является имя ОС в нижнем регистре, как возвращается uname -s, с добавлением первой части версии, как возвращается uname -r, например 'sunos5' или 'freebsd8', на момент сборки Python. Если не требуется проверять конкретную версию системы, рекомендуется использовать следующий идиоматический код:

if sys.platform.startswith('freebsd'):
    # Код, специфичный для FreeBSD, здесь...

Изменено в версии 3.3: На Linux sys.platform больше не содержит основной номер версии. Теперь это всегда 'linux' вместо 'linux2' или 'linux3'.

Изменено в версии 3.8: На AIX sys.platform больше не содержит основной номер версии. Теперь это всегда 'aix' вместо 'aix5' или 'aix7'.

Изменено в версии 3.13: На Android sys.platform теперь возвращает 'android' вместо 'linux'.

См. также

os.name имеет более грубую гранулярность. os.uname() выдаёт зависящую от системы информацию о версии.

Модуль platform предоставляет подробные проверки идентификации системы.

sys.platlibdir¶

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

Оно равно "lib" на большинстве платформ. На Fedora и SuSE на 64-битных платформах оно равно "lib64", что даёт следующие пути sys.path (где X.Y – это версия Python major.minor):

/usr/lib64/pythonX.Y/: Стандартная библиотека (например, os.py модуля os)
/usr/lib64/pythonX.Y/lib-dynload/: Модули C-расширений стандартной библиотеки (например, модуль errno, точное имя файла зависит от платформы)
/usr/lib/pythonX.Y/site-packages/ (всегда используйте lib, а не sys.platlibdir): Сторонние модули
/usr/lib64/pythonX.Y/site-packages/: Модули C-расширений сторонних пакетов

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

sys.prefix¶: Строка, содержащая префикс каталога, специфичный для сайта, куда устанавливаются платформенно-независимые файлы Python; на Unix по умолчанию используется /usr/local. Этот префикс можно задать во время сборки с помощью аргумента --prefix скрипта configure. Полученные пути описаны в путях установки.

Примечание

Если виртуальное окружение активно, это значение изменится в site.py, чтобы указывать на виртуальное окружение. Значение для установки Python по-прежнему будет доступно через base_prefix.

sys.ps1¶
sys.ps2¶: Строки, задающие основное и дополнительное приглашения интерпретатора. Они определены только в интерактивном режиме. Их начальные значения в этом случае – '>>> ' и '... '. Если одной из этих переменных присвоить объект, не являющийся строкой, его str() будет вычисляться заново каждый раз, когда интерпретатор готовится читать новую интерактивную команду; это можно использовать для реализации динамического приглашения.

sys.setdlopenflags(n)¶: Устанавливает флаги, используемые интерпретатором для вызовов dlopen(), например, при загрузке модулей расширений. В частности, это включает отложенное разрешение символов при импорте модуля, если вызвано как sys.setdlopenflags(0). Чтобы обмениваться символами между модулями расширений, вызывайте как sys.setdlopenflags(os.RTLD_GLOBAL). Символические имена значений флагов можно найти в модуле os (константы RTLD_xxx, например os.RTLD_LAZY).

Доступность: Unix.

sys.set_int_max_str_digits(maxdigits)¶: Устанавливает ограничение на длину строкового представления целых чисел, используемое этим интерпретатором. См. также get_int_max_str_digits().

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

sys.setprofile(profilefunc)¶

Устанавливает профилирующую функцию системы, которая позволяет реализовать профилировщик исходного кода Python на Python. Дополнительную информацию о профилировщике Python см. в главе Профилировщики Python. Системная профилирующая функция вызывается аналогично системной трассировочной функции (см. settrace()), но с другими событиями; например, она не вызывается для каждой исполняемой строки кода (только при вызове и возврате, причём событие возврата сообщается даже при установленном исключении). Функция привязана к потоку, но у профилировщика нет способа узнать о переключениях контекста между потоками, поэтому использовать её в многопоточном окружении не имеет смысла. Кроме того, её возвращаемое значение не используется, так что она может просто возвращать None. Ошибка в профилирующей функции приведёт к её сбросу.

Примечание

Тот же механизм трассировки используется для setprofile(), что и для settrace(). Чтобы трассировать вызовы с помощью setprofile() внутри трассировочной функции (например, в точке останова отладчика), см. call_tracing().

Функции профилирования должны принимать три аргумента: frame, event и arg. frame – это текущий стековый фрейм. event – строка: 'call', 'return', 'c_call', 'c_return' или 'c_exception'. arg зависит от типа события.

События имеют следующее значение:

'call': Вызывается функция (или выполняется вход в другой блок кода). Вызывается профилирующая функция; arg равен None.
'return': Функция (или другой блок кода) собирается вернуть результат. Вызывается профилирующая функция; arg – это возвращаемое значение, или None, если событие вызвано возбуждением исключения.
'c_call': Готовится вызов C-функции. Это может быть функция расширения или встроенная функция. arg – это объект C-функции.
'c_return': C-функция вернула результат. arg – это объект C-функции.
'c_exception': C-функция возбудила исключение. arg – это объект C-функции.

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

sys.setrecursionlimit(limit)¶

Устанавливает максимальную глубину стека интерпретатора Python в limit. Этот предел предотвращает переполнение C-стека из-за бесконечной рекурсии и аварийное завершение Python.

Максимально возможный предел зависит от платформы. Пользователь может увеличить предел, если программа требует глубокой рекурсии, а платформа поддерживает более высокий предел. Это следует делать с осторожностью, так как слишком высокий предел может привести к аварийному завершению.

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

Изменено в версии 3.5.1: Теперь возбуждается исключение RecursionError, если новый предел слишком мал для текущей глубины рекурсии.

sys.setswitchinterval(interval)¶: Устанавливает интервал переключения потоков интерпретатора (в секундах). Это значение с плавающей точкой определяет идеальную длительность «квантов времени», выделяемых одновременно работающим потокам Python. Обратите внимание, что фактическое значение может быть больше, особенно при использовании долго выполняющихся внутренних функций или методов. Кроме того, какой поток будет запланирован по окончании интервала, решает операционная система – у интерпретатора нет собственного планировщика.

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

sys.settrace(tracefunc)¶

Устанавливает трассировочную функцию системы, которая позволяет реализовать отладчик исходного кода Python на Python. Функция привязана к потоку; чтобы отладчик поддерживал несколько потоков, он должен зарегистрировать трассировочную функцию с помощью settrace() для каждого отлаживаемого потока или использовать threading.settrace().

Трассировочные функции должны принимать три аргумента: frame, event и arg. frame – это текущий стековый фрейм. event – строка: 'call', 'line', 'return', 'exception' или 'opcode'. arg зависит от типа события.

Трассировочная функция вызывается (с event, установленным в 'call') всякий раз, когда входит в новую локальную область видимости; она должна возвращать ссылку на локальную трассировочную функцию для новой области или None, если область не должна трассироваться.

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

Если в функции трассировки произошла ошибка, она будет отключена, как если бы была вызвана settrace(None).

Примечание

Трассировка отключается во время вызова функции трассировки (например, функции, установленной с помощью settrace()). О рекурсивной трассировке см. call_tracing().

События имеют следующее значение:

'call': Функция вызвана (или начат другой блок кода). Вызывается глобальная функция трассировки; arg равно None; возвращаемое значение задаёт локальную функцию трассировки.
'line': Интерпретатор собирается выполнить новую строку кода или повторно вычислить условие цикла. Вызывается локальная функция трассировки; arg равно None; возвращаемое значение задаёт новую локальную функцию трассировки. Подробное объяснение работы см. в Objects/lnotab_notes.txt. Построчные события можно отключить для фрейма, установив f_trace_lines в False для этого фрейма.
'return': Функция (или другой блок кода) собирается вернуть значение. Вызывается локальная функция трассировки; arg – это значение, которое будет возвращено, или None, если событие вызвано возбуждённым исключением. Возвращаемое значение функции трассировки игнорируется.
'exception': Произошло исключение. Вызывается локальная функция трассировки; arg – это кортеж (exception, value, traceback); возвращаемое значение задаёт новую локальную функцию трассировки.
'opcode': Интерпретатор собирается выполнить новый опкод (см. dis для подробностей об опкодах). Вызывается локальная функция трассировки; arg равно None; возвращаемое значение задаёт новую локальную функцию трассировки. Поопкодные события не генерируются по умолчанию: их нужно явно запросить, установив f_trace_opcodes в True для фрейма.

Обратите внимание, что при распространении исключения по цепочке вызывающих на каждом уровне генерируется событие 'exception'.

Для более тонкого управления можно задать функцию трассировки явно, присвоив frame.f_trace = tracefunc, а не полагаясь на то, что она будет установлена косвенно через возвращаемое значение уже установленной функции трассировки. Это также необходимо для активации функции трассировки на текущем фрейме, чего settrace() не делает. Обратите внимание, что для этого глобальная функция трассировки должна быть установлена с помощью settrace(), чтобы включить механизм трассировки времени выполнения, но это не обязательно должна быть та же самая функция трассировки (например, это может быть функция с низкими накладными расходами, которая просто возвращает None, чтобы немедленно отключить себя на каждом фрейме).

Дополнительную информацию об объектах кода и фреймах см. в Стандартной иерархии типов.

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

Особенность реализации CPython: Функция settrace() предназначена только для реализации отладчиков, профилировщиков, инструментов покрытия кода и тому подобного. Её поведение является частью платформы реализации, а не частью определения языка, и поэтому может быть недоступно во всех реализациях Python.

Изменено в версии 3.7: Добавлен тип события 'opcode'; добавлены атрибуты f_trace_lines и f_trace_opcodes у фреймов.

sys.set_asyncgen_hooks([firstiter] [, finalizer])¶

Принимает два необязательных именованных аргумента, которые являются вызываемыми объектами, принимающими итератор асинхронного генератора в качестве аргумента. Вызываемый объект firstiter будет вызван, когда асинхронный генератор будет итерирован в первый раз. Вызываемый объект finalizer будет вызван, когда асинхронный генератор будет готов к сборке мусора.

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

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

Генерируются два события аудита, поскольку базовый API состоит из двух вызовов, каждый из которых должен порождать собственное событие.

Добавлено в версии 3.6: См. PEP 525 для получения дополнительных сведений и пример реализации метода finalizer в реализации asyncio.Loop.shutdown_asyncgens в Lib/asyncio/base_events.py.

Примечание

Эта функция была добавлена на временной основе (см. PEP 411 для подробностей).

sys.set_coroutine_origin_tracking_depth(depth)¶

Позволяет включить или отключить отслеживание происхождения корутин. Если отслеживание включено, атрибут cr_origin объектов корутин будет содержать кортеж из кортежей (имя файла, номер строки, имя функции), описывающих трассировку, где был создан объект корутины, причем самый последний вызов будет первым. Если отслеживание отключено, cr_origin будет равно None.

Чтобы включить, передайте значение depth больше нуля; это задаёт количество фреймов, информация о которых будет захвачена. Чтобы отключить, передайте для depth значение ноль.

Эта настройка является потоковой.

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

Примечание

Эта функция была добавлена на временной основе (см. PEP 411 для подробностей). Используйте её только для целей отладки.

sys.activate_stack_trampoline(backend, /)¶

Активирует трамплин стекового профилировщика backend. Единственный поддерживаемый бэкенд – "perf".

Доступность: Linux.

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

См. также

Поддержка профилировщика Linux perf в PythonPython support for the Linux perf profiler
https://perf.wiki.kernel.org

sys.deactivate_stack_trampoline()¶

Деактивирует текущий бэкенд трамплина стекового профилировщика.

Если стековый профилировщик не активирован, эта функция не делает ничего.

Доступность: Linux.

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

sys.is_stack_trampoline_active()¶: Возвращает True, если трамплин стекового профилировщика активен.

Доступность: Linux.

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

sys._enablelegacywindowsfsencoding()¶

Изменяет кодировку файловой системы и обработчик ошибок на ‘mbcs’ и ‘replace’ соответственно для совместимости с версиями Python старше 3.6.

Это эквивалентно установке переменной окружения PYTHONLEGACYWINDOWSFSENCODING перед запуском Python.

См. также sys.getfilesystemencoding() и sys.getfilesystemencodeerrors().

Доступность: Windows.

Примечание

Изменение кодировки файловой системы после запуска Python рискованно, поскольку старая кодировка или пути, закодированные старой кодировкой, могут быть где-то кэшированы. Вместо этого используйте PYTHONLEGACYWINDOWSFSENCODING.

Добавлено в версии 3.6: Подробнее см. PEP 529.

Устарело с версии 3.13, будет удалено в версии 3.16: Вместо этого используйте PYTHONLEGACYWINDOWSFSENCODING.

sys.stdin¶

sys.stdout¶

sys.stderr¶

Объекты файлов, используемые интерпретатором для стандартного ввода, вывода и ошибок:

stdin используется для всего интерактивного ввода (включая вызовы input());
stdout используется для вывода print() и выражений, а также для приглашений input();
Собственные приглашения интерпретатора и его сообщения об ошибках выводятся в stderr.

Эти потоки являются обычными текстовыми файлами, подобными тем, что возвращает функция open(). Их параметры выбираются следующим образом:

Кодировка и обработка ошибок инициализируются из PyConfig.stdio_encoding и PyConfig.stdio_errors.

В Windows для консольного устройства используется UTF-8. Несимвольные устройства, такие как дисковые файлы и каналы, используют кодировку системной локали (то есть кодовую страницу ANSI). Не консольные символьные устройства, такие как NUL (то есть когда isatty() возвращает True), используют значения кодовых страниц консольного ввода и вывода при запуске, соответственно для stdin и stdout/stderr. По умолчанию это кодировка локали системы, если процесс изначально не прикреплен к консоли.

Особое поведение консоли можно переопределить, установив переменную окружения PYTHONLEGACYWINDOWSSTDIO перед запуском Python. В этом случае кодовые страницы консоли используются как для любого другого символьного устройства.

На всех платформах можно переопределить кодировку символов, установив переменную окружения PYTHONIOENCODING перед запуском Python или используя новый параметр командной строки -X utf8 и переменную окружения PYTHONUTF8. Однако для консоли Windows это применимо только в том случае, если также установлена PYTHONLEGACYWINDOWSSTDIO.
В интерактивном режиме поток stdout буферизуется построчно. В противном случае он буферизуется блоками, как обычные текстовые файлы. Поток stderr буферизуется построчно в обоих случаях. Оба потока можно сделать небуферизованными, передав параметр командной строки -u или установив переменную окружения PYTHONUNBUFFERED.

Изменено в версии 3.9: Неинтерактивный stderr теперь буферизуется построчно вместо полной буферизации.

Примечание

Для записи или чтения двоичных данных в/из стандартных потоков используйте базовый двоичный объект buffer. Например, для записи байтов в stdout используйте sys.stdout.buffer.write(b'abc').

Однако если вы пишете библиотеку (и не контролируете, в каком контексте будет выполняться её код), имейте в виду, что стандартные потоки могут быть заменены объектами, подобными файлам, такими как io.StringIO, которые не поддерживают атрибут buffer.

sys.__stdin__¶

sys.__stdout__¶

sys.__stderr__¶

Эти объекты содержат исходные значения stdin, stderr и stdout в начале программы. Они используются во время финализации и могут быть полезны для вывода в реальный стандартный поток, независимо от того, был ли перенаправлен объект sys.std*.

Его также можно использовать для восстановления реальных файлов до известных работающих файловых объектов, если они были перезаписаны некорректным объектом. Однако предпочтительный способ – явно сохранить предыдущий поток перед его заменой и восстановить сохранённый объект.

Примечание

При некоторых условиях stdin, stdout и stderr, а также исходные значения __stdin__, __stdout__ и __stderr__ могут быть None. Обычно это происходит в Windows GUI-приложениях, не подключённых к консоли, и в приложениях Python, запущенных с помощью pythonw.

sys.stdlib_module_names¶

Frozenset строк, содержащий имена модулей стандартной библиотеки.

Он одинаков на всех платформах. Также перечислены модули, недоступные на некоторых платформах, и модули, отключённые при сборке Python. Перечислены все типы модулей: чистые Python-, встроенные, замороженные и модули-расширения. Тестовые модули исключены.

Для пакетов перечислен только основной пакет: подпакеты и подмодули не перечисляются. Например, пакет email перечислен, а подпакет email.mime и подмодуль email.message – нет.

См. также список sys.builtin_module_names.

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

sys.thread_info¶

Именованный кортеж, содержащий информацию о реализации потоков.

thread_info.name¶

Имя реализации потоков:

"nt": потоки Windows
"pthread": потоки POSIX
"pthread-stubs": заглушки потоков POSIX (на платформах WebAssembly без поддержки потоков)
"solaris": потоки Solaris

thread_info.lock¶

Имя реализации блокировки:

"semaphore": блокировка использует семафор
"mutex+cond": блокировка использует мьютекс и переменную условия
None, если эта информация неизвестна

thread_info.version¶: Имя и версия библиотеки потоков. Это строка или None, если эта информация неизвестна.

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

sys.tracebacklimit¶: Когда этой переменной присвоено целое значение, она определяет максимальное количество уровней трассировки, выводимых при необработанном исключении. По умолчанию 1000. Если установлено 0 или меньше, вся информация трассировки подавляется и выводятся только тип и значение исключения.

sys.unraisablehook(unraisable, /)¶

Обрабатывает неподнимаемое исключение.

Вызывается, когда произошло исключение, но у Python нет способа его обработать. Например, когда деструктор вызывает исключение или во время сборки мусора (gc.collect()).

Аргумент unraisable имеет следующие атрибуты:

exc_type: Тип исключения.
exc_value: Значение исключения, может быть None.
exc_traceback: трассировка исключения, может быть None.
err_msg: сообщение об ошибке, может быть None.
object: объект, вызвавший исключение, может быть None.

Стандартный перехватчик форматирует err_msg и object как: f'{err_msg}: {object!r}'; используется сообщение об ошибке «Исключение проигнорировано в», если err_msg равно None.

sys.unraisablehook() можно переопределить, чтобы управлять обработкой неподнимаемых исключений.

См. также

excepthook(), который обрабатывает неперехваченные исключения.

Предупреждение

Сохранение exc_value с помощью пользовательского перехватчика может создать циклическую ссылку. Её следует явно очистить, чтобы разорвать цикл, когда исключение больше не нужно.

Сохранение object с помощью пользовательского перехватчика может воскресить его, если он установлен на объект, который находится в процессе финализации. Избегайте сохранения object после завершения пользовательского перехватчика, чтобы не воскрешать объекты.

Вызывает событие аудита sys.unraisablehook с аргументами hook, unraisable, когда возникает исключение, которое невозможно обработать. Объект unraisable совпадает с тем, что будет передан перехватчику. Если перехватчик не установлен, hook может быть None.

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

sys.version¶: Строка, содержащая номер версии интерпретатора Python, а также дополнительную информацию о номере сборки и используемом компиляторе. Эта строка отображается при запуске интерактивного интерпретатора. Не извлекайте из неё информацию о версии; вместо этого используйте version_info и функции, предоставляемые модулем platform.

sys.api_version¶: Версия C API для данного интерпретатора. Программисты могут счесть это полезным при отладке конфликтов версий между Python и модулями расширения.

sys.version_info¶: Кортеж, содержащий пять компонентов номера версии: major, minor, micro, releaselevel и serial. Все значения, кроме releaselevel, являются целыми числами; уровень выпуска – 'alpha', 'beta', 'candidate' или 'final'. Значение version_info, соответствующее версии Python 2.0, равно (2, 0, 0, 'final', 0). Компоненты также можно получать по имени, поэтому sys.version_info[0] эквивалентно sys.version_info.major и так далее.

Изменено в версии 3.1: Добавлены именованные атрибуты компонентов.

sys.warnoptions¶: Это деталь реализации механизма предупреждений; не изменяйте это значение. Обратитесь к модулю warnings за дополнительной информацией о механизме предупреждений.

sys.winver¶: Номер версии, используемый для формирования ключей реестра на платформах Windows. Он хранится как строковый ресурс 1000 в DLL Python. Обычно значение представляет собой основной и дополнительный номера версии работающего интерпретатора Python. Он предоставляется в модуле sys в информационных целях; изменение этого значения не влияет на ключи реестра, используемые Python.

Доступность: Windows.

sys.monitoring: Пространство имён, содержащее функции и константы для регистрации колбэков и управления событиями мониторинга. Подробнее см. sys.monitoring.

sys._xoptions¶

Словарь различных флагов, специфичных для реализации, переданных через параметр командной строки -X. Имена параметров либо сопоставляются с их значениями, если они указаны явно, либо с True. Пример:

$ ./python -Xa=b -Xc
Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50)
[GCC 4.4.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys._xoptions
{'a': 'b', 'c': True}

Особенность реализации CPython: Это специфичный для CPython способ доступа к параметрам, переданным через -X. Другие реализации могут экспортировать их другими средствами или не экспортировать вовсе.

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

Ссылки

[C99]

ISO/IEC 9899:1999. «Programming languages – C». Публичный проект этого стандарта доступен по адресу https://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf.

sys – системно-зависимые параметры и функции¶sys – System-specific parameters and functions

`sys` – системно-зависимые параметры и функции¶sys – System-specific parameters and functions