cgitb — Менеджер отслеживания стека для CGI-скриптов

Исходный код: Lib/cgitb.py

Модуль cgitb предоставляет специальный обработчик исключений для Python-скриптов. (Его название немного вводит в заблуждение. Первоначально он был разработан для отображения подробной информации об отслеживании стека в формате HTML для CGI-скриптов. Позже он был обобщён для отображения этой информации также в простом текстовом формате.) После активации этого модуля, если возникнет неперехваченное исключение, будет отображён подробный отформатированный отчёт. Отчёт включает в себя отслеживание стека, показывающий фрагменты исходного кода для каждого уровня, а также значения аргументов и локальных переменных для текущих функций, чтобы помочь в отладке проблемы. По желанию, эту информацию можно сохранить в файл вместо отправки её в браузер.

Для активации этой функции просто добавьте следующее в начало вашего CGI-скрипта:

import cgitb
cgitb.enable()

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

cgitb.enable(display=1, logdir=None, context=5, format="html")

Эта функция заставляет модуль cgitb принять на себя обработку исключений по умолчанию в интерпретаторе, установив значение sys.excepthook.

Необязательный аргумент display по умолчанию равен 1 и может быть установлен в 0 для подавления отправки отслеживания стека в браузер. Если присутствует аргумент logdir, отчёты об отслеживании стека записываются в файлы. Значение logdir должно быть каталогом, в котором будут размещены эти файлы. Необязательный аргумент context — это количество строк контекста, отображаемых вокруг текущей строки исходного кода в отслеживании стека; по умолчанию он равен 5. Если необязательный аргумент format равен "html", вывод отформатирован как HTML. Любое другое значение принудительно устанавливает вывод в простой текст. Значение по умолчанию — "html".

cgitb.handler(info=None)

Эта функция обрабатывает исключение с использованием значений по умолчанию (то есть отображает отчёт в браузере, но не ведёт протоколирование в файл). Это может быть использовано, когда вы перехватили исключение и хотите сообщить о нём с помощью cgitb. Необязательный аргумент info должен быть кортежем из 3-х элементов, содержащим тип исключения, значение исключения и объект отслеживания стека, точно так же, как кортеж, возвращаемый sys.exc_info(). Если аргумент info не указан, текущее исключение извлекается из sys.exc_info().