[ Россум, Дрейк, Откидач ] Язык программирования Python

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

14.2user — конфигурация пользователя

В целях безопасности интерпретатор не выполняет автоматически конфигурационный файл пользователя. Только в интерактивном режиме интерпретатор выполняет файл, указанный в переменной окружения PYTHONSTARTUP. Однако некоторые программы могут позволить загрузить стандартный конфигурационный файл пользователя. Программа, желающая использовать такой механизм, должна выполнить инструкцию ‘import user’.

Модуль user ищет файл с именем ‘.pythonrc.py’ в домашнем каталоге пользователя и выполняет его с помощью встроенной функции execfile() в своем собственном (модуля user) глобальном пространстве имен. Ошибки, возникающие при выполнении ‘.pythonrc.py’ модулем user не обрабатываются. Если домашний каталог не может быть определен, выполняется файл ‘.pythonrc.py’ в текущем каталоге.

Будьте сдержаны в том, что Вы помещаете в свой файл ‘.pythonrc.py’. Так как Вы не знаете, какие программы будут его использовать, изменение поведения стандартных модулей и функций вряд ли будет хорошей идеей.

Рекомендация для программистов, желающих использовать описанный здесь механизм: простейший способ устанавливать параметры — определить переменные в файле ‘.pythonrc.py’. Например, модуль spam может определить, насколько подробными пользователь хочет видеть его сообщения, с помощью следующих инструкций:

import user try:

# ЪОБЮЕОЙЕ, ХУФБОПЧМЕООПЕ РПМШЪПЧБФЕМЕН verbose = user.spam_verbose

except AttributeError:

# ЪОБЮЕОЙЕ РП ХНПМЮБОЙА verbose = 0

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

192

Глава 15

Служебные модули

Модули, описанные в этой главе, являются служебными по отношению к интерпретатору языка Python и его взаимодействию с окружением.

15.1sys — характерные для системы параметры и функции

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

argv

Список аргументов, переданных в командной строке программе на языке Python. argv[0] является именем программы (является имя полным или нет, зависит от используемой операционной системы). Если интерпретатор запущен с опцией - Ó, argv[0] является строкой ’-c’. При чтении команд со стандартного потока ввода (в том числе в интерактивном режиме) argv[0] является строкой ’-’ или ’’ в зависимости от того, использовалась опция ‘-’ или нет.

byteorder

Строка, указывающая характерный для платформы порядок следования байтов: ’big’ (big-endian) или ’little’ (little-endian). Переменная доступна, начиная с версии 2.0.

builtin_module_names

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

copyright

Строка, содержащая авторские права на интерпретатор языка Python.

dllhandle (Windows)

Целое число, дескриптор DLL интерпретатора Python.

exc_info()

Возвращает кортеж из трех значений, описывающих исключение, которое в данный момент обрабатывается (в текущем потоке). Под обработкой исключения здесь подразумевается выполнение ветви except (в том числе и вызванных из нее функций) инструкции try (см. раздел 10.4.4).

Если в настоящий момент обработка исключения не выполняется, возвращаемый кортеж содержит три объекта None. В противном случае, возвращается ‘(type, value, traceback)’, где type — тип исключения (класс или строка), value — значение исключения (экземпляр класса) или ассоциированное значение (строка) и traceback — объект traceback (см. раздел 11.9.3), представляющий пройденный путь от места возникновения исключительной ситуации.

Важное замечание: присваивание traceback локальной переменной в функции, обрабатывающей исключение, приведет к образованию циклических ссылок между объектами. Таким образом, удаление объекта будет возможным, только если интерпретатор собран со сборщиком мусора (см. описание модуля gc). Так как в большинстве случаев объект traceback не нужен, наилучшим решением будет использование функции в виде ‘type, value = sys.exc_info()[:2]’ для получения только типа и значения исключения. Если Вам необходим объект traceback, удостоверьтесь в том, что Вы удаляете его после использования (лучше всего это делать в ветви finally инструкции try) или используйте exc_info() в отдельной функции, вызванной из ветви except.

exc_type exc_value

exc_traceback

Присутствуют только для совместимости со старыми версиями — используйте функцию exc_info(). Так как они являются глобальными переменными, содержат значения для исключения, обработка которого была начата последней. Таким образом, их использование не безопасно в многопоточных программах. Если в данный момент исключение не обрабатывается, значение exc_type равно None и переменные exc_value и exc_traceback не определены.

exec_prefix

Строка, содержащая начало пути к зависимым от платформы файлам интерпретатора Python (зависит от параметров сборки и/или установки). Например, конфигурационные файлы на платформах UNIX располагаются в каталоге ‘sys.exec_prefix + ’/lib/python’ + sys.version[:3] + ’/config’’.

executable

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

exit([exit_code])

Прерывает выполнение программы. Реализуется путем генерации исключения SystemExit, то есть страховочный код (ветвь finally инструкции try) принимается во внимание и попытка выхода может быть прервана на внешнем уровне путем обработки исключения. Необязательный аргумент может быть целым числом (по умолчанию 0, что соответствует успешному завершению; многие системы требуют, чтобы это число было от 0 до 127), которое будет использовано в качестве кода завершения, или объект любого другого типа. В последнем случае использование None эквивалентно 0, для других объектов на стандартный поток ошибок выводится строковое представление (полученное аналогично тому, как это делает встроенная функция str()) и в качестве кода завершения используется 1. В частности инструкция ‘sys.exit(’уППВЭЕОЙЕ ПВ ПЫЙВЛЕ’)’ является быстрым способом прервать выполнение программы с выводом сообщения об ошибке.

exitfunc

Эта переменная на самом деле не определена самим модулем, но Вы можете присвоить ей объект-функцию, которая будет вызвана (без аргументов) при завершении работы интерпретатора. Функция exitfunc() не вызывается, если процесс прерван с помощью некоторых сигналов, при возникновении фатальной ошибки и при вызове функции os._exit(). Мы настоятельно не рекомендуем устанавливать переменную exitfunc напрямую (это может привести к некорректной работе других компонент программы) — воспользуйтесь модулем atexit, который предоставляет возможность регистрировать несколько функций.

getdefaultencoding()

Возвращает текущую кодировку, используемую по умолчанию при преобразовании обычных строк в строки Unicode и наоборот. Функция доступна, начиная с версии 2.0.

getrefcount(object)

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

getrecursionlimit()

Возвращает текущее ограничение рекурсии — максимальную глубину стека интерпретатора Python. Это ограничение предотвращает переполнение стека при бесконечных рекурсиях. Ограничение рекурсии может быть установлено с помощью функции setrecursionlimit(). Эта функция доступна, начиная с версии 2.0.

hexversion

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

if sys.hexversion >= 0x010502F0:

# йУРПМШЪХЕН ОПЧЩЕ ЧПЪНПЦОПУФЙ.

...

else:

#йУРПМШЪХЕН БМШФЕТОБФЙЧОХА ТЕБМЙЪБГЙА ЙМЙ

#ЧЩЧПДЙН РТЕДХРТЕЦДЕОЙЕ.

...

Функция названа ‘hexversion’ потому, что возвращаемое ей значение выглядит действительно осмысленным, только если смотреть на его шестнадцатеричное представление (например, полученное с помощью встроенной функции hex()). Информация о версии в более дружественном виде хранится в переменной version_info.

last_type

last_value

last_traceback

Эти три переменные не всегда определены. Им присваиваются значения в случае, если исключение не обрабатывается и интерпретатор выводит информацию об ошибке. Наличие этих переменных позволяет пользователю в интерактивном режиме импортировать модуль отладчика и сделать “вскрытие трупа” программы, исключив необходимость повторного запуска команд, приведших к возникновению ошибки. Для этого достаточно выполнить ‘import pdb; pdb.pm()’ (см. главу 25.1).

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

maxint

Наибольшее целое число, которое может быть представлено в рамках типа int. Это число не меньше, чем 231 1. Наименьшее представимое в рамках int целое число на большинстве платформ равно -maxint-1.

modules

Словарь, отображающий имена импортированных модулей в объекты-модули. Вы можете манипулировать им, например, для принудительной перезагрузки модулей или для того, чтобы сделать доступными для импортирования динамически созданные модули (см. описание модуля new). Заметим, что последовательное удаление модуля из modules и повторное его импортирование — это не совсем то, что делает встроенная функция reload().

path

Список строк — путей поиска модулей. Изначально эта переменная содержит каталог, в котором находится исполняемая в данный момент программа (или пустую строку, если команды считываются со стандартного потока ввода; пустая строка используется для обозначения текущего каталога), пути, указанные в переменной окружения PYTHONPATH и зависящие от платформы пути по умолчанию. Обратите внимание, что каталог, в котором находится программа, идет первым (path[0]).

platform

Строка, содержащая идентификатор платформы, например, ’sunos5’, ’linux1’ или ’win32’. Может использоваться, например, для добавления характерных для платформы путей в path.

prefix

Строка, содержащая начало пути к независимым от платформы файлам интерпретатора Python (зависит от параметров сборки и/или установки). Например, основная коллекция модулей на платформах UNIX устанавливается в каталог ‘sys.prefix + ’/lib/python’ + sys.version[:3]’, в то время как независимые от платформы заголовочные файлы (все, кроме ‘config.h’) располагаются в ‘sys.prefix + ’/include/python’ + sys.version[:3]’.

ps1

ps2

Обычно строки, определяющие, соответственно, первичное и вторичное приглашения интерпретатора. Определены и используются, только если интерпретатор находится в интерактивном режиме. В этом случае они имеют начальные значения ’>>> ’ и ’... ’. Если значения этих переменных не являются строковыми объектами, в качестве приглашений используются их строковые значения, полученные аналогично встроенной функции str(). Строковое значение каждый раз вычисляется заново — такое поведение может быть использовано для реализации динамических приглашений.

setcheckinterval(interval)

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

setdefaultencoding(encoding)

Устанавливает кодировку, которая будет использоваться по умолчанию при преобразовании обычных строк в строки Unicode и наоборот. Если строка encoding не соответствует доступной кодировке, генерирует исключение LookupError. Эта функция предназначена для использования в модуле site (или sitecustomize), после этого она обычно удаляется из пространства имен модуля sys. Функция доступна, начиная с версии 2.0.

setprofile(profilefunc)

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

setrecursionlimit(limit)

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

settrace(tracefunc)

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

stdin stdout

stderr

Файловые объекты, соответствующие стандартным потокам ввода, вывода и ошибок интерпретатора. stdin используется интерпретатором для операций ввода, таким как input() и raw_input(). stdout используется интерпретатором для операций вывода с помощью инструкции print, инструкций-выражений и для вывода приглашений функциями input() и raw_input(). Для вывода собственных приглашений интерпретатора в интерактивном режиме и вывода сообщений об ошибках (не перехваченных исключениях) используется stderr. Для корректной работы встроенных возможностей языка Python stdout и stderr должны быть объектами (произвольного типа), имеющими метод write(). Для корректной работы функций input() и raw_input() объект, на который ссылается stderr должен иметь метод readline(). Заметим, что изменение этих переменных не оказывает влияния на стандартные потоки ввода/вывода порождаемых (например, функциями os.popen() или os.system()) процессов.

__stdin__

__stdout__

__stderr__

Эти переменные хранят исходные значения для stdin, stderr и stdout при запуске программы и могут быть использованы для их восстановления.

tracebacklimit

Если этой переменной присвоено целое значение, она определяет максимальное число уровней информации, представляемой объектом traceback, которое будет выводиться при возникновении (необрабатываемой) исключительной ситуации. По умолчанию выводится не более 1000 уровней. Значение меньше или равное нулю запрещает вывод такой информации — выводится только тип исключения и его строковое представление.

version

Строка, содержащая информацию о версии, номере и времени сборки интерпретатора Python и компиляторе, который был использован, в виде ’version

(#build_number, build_date, build_time) [compiler]’. Первые три

collect()

Запускает полный “сбор мусора” и возвращает общее количество найденных недоступных объектов. Список объектов, которые не могут быть удалены “сборщиком мусора”, становится доступными через переменную garbage.

set_debug(flags)

Устанавливает параметры отладки. Вся отладочная информация будет выводиться на стандартный поток ошибок. Отладочные флаги (см. ниже) можно комбинировать с помощью оператора битового ИЛИ. Полностью отключить отладку можно с помощью инструкции set_debug(0).

get_debug()

Возвращает параметры отладки, которые в настоящий момент установлены.

set_threshold(threshold0 [, threshold1 [, threshold2]])

Устанавливает пороги запуска (частоту) автоматического “сбора мусора”. Значение threshold0 равное нулю отключает автоматический “сбор мусора”.

Различаются три поколения объектов в зависимости от того, сколько запусков сборщика они пережили. Новые объекты — самые молодые, относятся к поколению 0. После каждого запуска сборщика объект “взрослеет”, перемещается в поколение 1, затем в поколение 2. Так как поколение 2 самое старшее, объекты остаются в нем после последующих запусков сборщика. Для того, чтобы решить, когда производить запуск, сборщик подсчитывает количество созданных и удаленных объектов после последнего запуска. Когда разница между ними достигает threshold0, запускается “сборщик мусора”. Изначально анализируется только самое молодое поколение. Если поколение 0 анализировалось более threshold1 раз после последнего анализа поколения 1, также анализируется и поколение 1. Аналогично threshold2 контролирует количество запусков сборщика для поколения 1, перед тем как обрабатывать поколение 2.

get_threshold()

Возвращает кортеж текущих порогов запуска “сборщика мусора” в виде ‘(threshold0, threshold1, threshold2)’.

Следующая переменная доступна только для чтения:

garbage

Список недоступных объектов, найденных “сборщиком мусора”, которые не могут быть удалены. Экземпляры классов, имеющие специальный метод __del__() и входящие в цикл ссылающихся друг на друга объектов, делают весь цикл неудаляемым. Если установлена опция отладки DEBUG_SAVEALL, в этой переменной сохраняются все найденные недоступные объекты (“сборщик мусора” их при этом не удаляет).

Для установки параметров отладки модуль предоставляет следующие константыфлаги:

DEBUG_STATS

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

DEBUG_COLLECTABLE

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

DEBUG_UNCOLLECTABLE

Выводить информацию о найденных недоступных объектах, которые не могут быть удалены. Эти объекты будут добавлены в список garbage.

DEBUG_INSTANCES

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

DEBUG_OBJECTS

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

DEBUG_SAVEALL

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

DEBUG_LEAK

Флаги, необходимые для вывода информации, полезной при поиске утечек памяти (DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | DEBUG_INSTANCES | DEBUG_OBJECTS | DEBUG_SAVEALL).

15.3atexit — выполнение действий при окончании работы программы

Доступен, начиная с версии 2.0.

Модуль atexit определяет единственную функцию, предназначенную для регистрации. Зарегистрированные с помощью нее функции будут автоматически вызваны при нормальном окончании работы программы. Функции не будут вызваны, если процесс программы был прерван с помощью некоторых сигналов, возникла фатальная внутренняя ошибка интерпретатора, а также при вызове функции os._exit().

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