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

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

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

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

sys.argv¶

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

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

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.call_tracing(func, args)¶: Вызывает func(*args) при включённой трассировке. Состояние трассировки сохраняется и восстанавливается после. Предназначено для вызова из отладчика из точки останова, чтобы рекурсивно отладить другой код.

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

sys._clear_type_cache()¶

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

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

sys._current_frames()¶

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

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

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

sys._debugmallocstats()¶

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

Если Python настроен с ключом –with-pydebug, он также выполняет некоторые дорогостоящие проверки внутренней согласованности.

Новое в версии 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.excepthook(type, value, traceback)¶

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

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

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

sys.exc_info()¶

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

Если нигде в стеке не обрабатывается исключение, возвращается кортеж, содержащий три значения None. В противном случае возвращаются значения (type, value, traceback). Их смысл: type получает тип обрабатываемого исключения (подкласс BaseException); value получает экземпляр исключения (экземпляр типа исключения); traceback получает объект трассировки (см. справочное руководство), который инкапсулирует стек вызовов в точке, где изначально произошло исключение.

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])¶

Выход из Python. Реализуется путём возбуждения исключения SystemExit , поэтому выполняются действия очистки, заданные в предложениях finally операторов try, и можно перехватить попытку выхода на внешнем уровне.

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

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

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

sys.flags¶

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

атрибут	флаг
`debug`	`-d`
`inspect`	`-i`
`interactive`	`-i`
`isolated`	`-I`
`optimize`	`-O` или `-OO`
`dont_write_bytecode`	`-B`
`no_user_site`	`-s`
`no_site`	`-S`
`ignore_environment`	`-E`
`verbose`	`-v`
`bytes_warning`	`-b`
`quiet`	`-q`
`hash_randomization`	`-R`

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

Новое в версии 3.2.3: Атрибут hash_randomization.

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

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

sys.float_info¶

struct sequence, содержащий информацию о типе float. Он содержит низкоуровневую информацию о точности и внутреннем представлении. Значения соответствуют различным константам с плавающей точкой, определённым в стандартном заголовочном файле float.h для языка программирования ‘C’; см. раздел 5.2.4.2.2 стандарта ISO/IEC C 1999 [C99], ‘Characteristics of floating types’, для подробностей.

атрибут	float.h макрос	объяснение
`epsilon`	DBL_EPSILON	разница между 1 и наименьшим значением, большим 1, которое может быть представлено как float
`dig`	DBL_DIG	maximum number of decimal digits that can be faithfully represented in a float; see below
`mant_dig`	DBL_MANT_DIG	float precision: the number of base-`radix` digits in the significand of a float
`max`	DBL_MAX	максимальное представимое конечное число типа float
`max_exp`	DBL_MAX_EXP	максимальное целое e, такое что `radix**(e-1)` является представимым конечным числом типа float
`max_10_exp`	DBL_MAX_10_EXP	максимальное целое e, такое что `10**e` находится в диапазоне представимых конечных чисел с плавающей запятой
`min`	DBL_MIN	минимальное положительное нормализованное число типа float
`min_exp`	DBL_MIN_EXP	минимальное целое e, такое что `radix**(e-1)` является нормализованным числом типа float
`min_10_exp`	DBL_MIN_10_EXP	минимальное целое e, такое что `10**e` является нормализованным числом типа float
`radix`	FLT_RADIX	radix of exponent representation
`rounds`	FLT_ROUNDS	Целочисленная константа, представляющая режим округления, используемый для арифметических операций. Она отражает значение макроса системы FLT_ROUNDS на момент запуска интерпретатора. См. раздел 5.2.4.2.2 стандарта C99 для объяснения возможных значений и их смысла.

Атрибут 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_type_cache() и gc.collect(), чтобы получить более предсказуемые результаты.

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

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

sys.getcheckinterval()¶: Возвращает «интервал проверки» интерпретатора; см. setcheckinterval().

Устарело с версии 3.2: Используйте getswitchinterval() вместо.

sys.getdefaultencoding()¶: Возвращает имя текущей кодировки строк по умолчанию, используемой реализацией Unicode.

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

sys.getfilesystemencoding()¶

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

Эта кодировка всегда совместима с ASCII.

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

На Mac OS X кодировка – 'utf-8'.
На Unix кодировкой является кодировка локали.
На Windows кодировкой может быть 'utf-8' или 'mbcs', в зависимости от настроек пользователя.

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

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

sys.getfilesystemencodeerrors()¶

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

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

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

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 равно нулю – возвращается кадр на вершине стека вызовов.

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

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 элементов.

платформа будет 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 возвращает точные номера старшей версии, младшей версии и номер сборки текущей операционной системы, а не версию, которая эмулируется для процесса. Она предназначена для использования в журналировании, а не для определения возможностей.

Доступность: 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_wrapper()¶: Возвращает None или обёртку, установленную set_coroutine_wrapper().

Новое в версии 3.5: См. PEP 492 для получения дополнительной информации.

Примечание

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

sys.hash_info¶

struct sequence, предоставляющий параметры реализации числового хеша. Для более подробной информации о хешировании числовых типов см. Хеширование числовых типов.

атрибут	объяснение
`width`	разрядность в битах, используемая для хеш-значений
`modulus`	простой модуль P, используемый для числовой схемы хеширования
`inf`	хэш-значение, возвращаемое для положительной бесконечности
`nan`	значение хэша, возвращаемое для nan
`imag`	множитель для мнимой части комплексного числа
`algorithm`	имя алгоритма хэширования для str, bytes и memoryview
`hash_bits`	внутренний размер вывода алгоритма хэширования
`seed_bits`	размер ключа начальной инициализации (seed) алгоритма хэширования

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

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

sys.hexversion¶

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

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

Это называется hexversion, поскольку оно действительно имеет смысл только при просмотре как результат передачи его встроенной функции hex(). struct sequence 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.

sys.int_info¶

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

Атрибут	Пояснение
`bits_per_digit`	количество бит в каждом разряде. Целые числа Python хранятся внутри в системе с основанием `2**int_info.bits_per_digit`
`sizeof_digit`	размер в байтах типа C, используемого для представления разряда

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

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

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

sys.intern(string)¶

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

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

sys.is_finalizing()¶: Возвращает True, если интерпретатор Python завершает работу, иначе False.

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

sys.last_type¶

sys.last_value¶

sys.last_traceback¶

Эти три переменные определены не всегда; они устанавливаются, когда исключение не обработано и интерпретатор выводит сообщение об ошибке и трассировку стека. Их предназначение – позволить интерактивному пользователю импортировать модуль отладчика и заняться посмертной отладкой без необходимости повторно выполнять команду, вызвавшую ошибку. (Типичное использование – import pdb; pdb.pm() для входа в посмертный отладчик; см. модуль pdb для получения дополнительной информации.)

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

См. также

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

Изменено в версии 3.4: Спецификации модулей были введены в Python 3.4, PEP 451. В более ранних версиях Python искался метод с именем find_module(). Он по-прежнему вызывается как запасной вариант, если запись meta_path не имеет метода find_spec().

sys.modules¶: Это словарь, сопоставляющий имена модулей с уже загруженными модулями. С его помощью можно принудительно перезагружать модули и выполнять другие трюки. Однако замена словаря не обязательно сработает как ожидается, а удаление важных элементов из словаря может привести к сбою Python.

sys.path¶

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

При инициализации при запуске программы первый элемент этого списка, path[0], содержит каталог со скриптом, который был использован для вызова интерпретатора Python. Если каталог скрипта недоступен (например, если интерпретатор запущен в интерактивном режиме или скрипт читается из стандартного ввода), path[0] является пустой строкой, что заставляет Python сначала искать модули в текущем каталоге. Обратите внимание, что каталог скрипта вставляется до записей, добавленных в результате PYTHONPATH

Программа может изменять этот список для своих целей. В 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.

Изменено в версии 3.3: None сохраняется вместо imp.NullImporter, когда finder не найден.

sys.platform¶

Эта строка содержит идентификатор платформы, который можно использовать, например, для добавления платформозависимых компонентов к sys.path.

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

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

Для остальных систем значения следующие:

Система	`platform` значение
Linux	`'linux'`
Windows	`'win32'`
Windows/Cygwin	`'cygwin'`
Mac OS X	`'darwin'`

Изменено в версии 3.3: В Linux sys.platform больше не содержит основной номер версии. Теперь это всегда 'linux', а не 'linux2' или 'linux3'. Поскольку более старые версии Python включали номер версии, рекомендуется всегда использовать startswith идиоматический код, представленный выше.

См. также

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

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

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

Примечание

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

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

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

Устарело с версии 3.2: Эта функция больше не действует, так как внутренняя логика переключения потоков и асинхронных задач была переписана. Используйте setswitchinterval() вместо неё.

sys.setdlopenflags(n)¶

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

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

sys.setprofile(profilefunc)¶

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

Функции профилирования должны принимать три аргумента: 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.setrecursionlimit(limit)¶

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

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

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

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

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

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

sys.settrace(tracefunc)¶

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

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

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

Локальная трассировочная функция должна возвращать ссылку на себя (или на другую функцию для дальнейшей трассировки в этой области видимости) или None для отключения трассировки в этой области

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

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

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

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

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

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

Новое в версии 3.6: Подробности см. в PEP 525, а пример реализации метода finalizer – в коде asyncio.Loop.shutdown_asyncgens из Lib/asyncio/base_events.py

Примечание

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

sys.set_coroutine_wrapper(wrapper)¶

Позволяет перехватывать создание объектов корутина (только тех, которые создаются функцией async def; генераторы, декорированные types.coroutine() или asyncio.coroutine(), не будут перехвачены).

Аргумент wrapper должен быть одним из следующих:

вызываемый объект, принимающий один аргумент (объект корутины);
None, чтобы сбросить обёртку.

При повторном вызове новая обёртка заменяет предыдущую. Эта функция привязана к потоку.

Вызываемый объект wrapper не может определять новые корутины прямо или косвенно:

def wrapper(coro):
    async def wrap(coro):
        return await coro
    return wrap(coro)
sys.set_coroutine_wrapper(wrapper)

async def foo():
    pass

# Следующая строка вызовет ошибку RuntimeError, так как
# ``wrapper`` создаёт корутину ``wrap(coro)``:
foo()

См. также get_coroutine_wrapper().

Новое в версии 3.5: См. PEP 492 для получения дополнительной информации.

Примечание

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

sys._enablelegacywindowsfsencoding()¶

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

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

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

Новое в версии 3.6: Подробности см. в PEP 529.

sys.stdin¶

sys.stdout¶

sys.stderr¶

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

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

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

Кодировка символов зависит от платформы. В Windows, если поток интерактивный (то есть если его метод isatty() возвращает True), используется кодовая страница консоли, в противном случае – кодовая страница ANSI. На других платформах используется кодировка локали (см. locale.getpreferredencoding()).

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

Примечание

Для записи или чтения двоичных данных в/из стандартных потоков используйте базовый двоичный объект 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.thread_info¶

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

Атрибут	Пояснение
`name`	Имя реализации потоков `'nt'`: потоки Windows `'pthread'`: потоки POSIX `'solaris'`: потоки Solaris
`lock`	Имя реализации блокировки: `'semaphore'`: блокировка использует семафор `'mutex+cond'`: блокировка использует мьютекс и условную переменную `None`, если эта информация неизвестна
`version`	Название и версия библиотеки потоков. Это строка или `None`, если эти сведения неизвестны.

Атрибут

Пояснение

name

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

'nt': потоки Windows

'pthread': потоки POSIX

'solaris': потоки Solaris

lock

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

'semaphore': блокировка использует семафор

'mutex+cond': блокировка использует мьютекс и условную переменную

None, если эта информация неизвестна

version

Название и версия библиотеки потоков. Это строка или None, если эти сведения неизвестны.

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

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

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. Обычно это первые три символа version. Приведён в модуле sys в информационных целях; изменение этого значения не влияет на ключи реестра, используемые Python. Доступность: Windows.

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. «Языки программирования – C.» Публичный проект этого стандарта доступен по адресу http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf.

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

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