traceback — Вывод или получение стека отладки

Объекты TracebackException

TracebackException создаются из фактических исключений для захвата данных для последущего вывода в лёгком формате.

class traceback.TracebackException(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False)

Захват исключения для последующего рендеринга. limit, lookup_lines и capture_locals соответствуют классу StackSummary.

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

__cause__

A TracebackException исходного __cause__.

__context__

A TracebackException исходного __context__.

__suppress_context__

Значение __suppress_context__ из исходного исключения.

stack

StackSummary, представляющая трассировку.

exc_type

Класс исходной трассировки.

filename

Для синтаксических ошибок - имя файла, в котором произошла ошибка.

lineno

Для синтаксических ошибок - номер строки, в которой произошла ошибка.

text

Для синтаксических ошибок - текст, в котором произошла ошибка.

offset

Для синтаксических ошибок - смещение в тексте, где произошла ошибка.

msg

Для синтаксических ошибок - сообщение об ошибке компилятора.

classmethod from_exception(exc, *, limit=None, lookup_lines=True, capture_locals=False)

Захват исключения для последующего рендеринга. limit, lookup_lines и capture_locals соответствуют классу StackSummary.

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

format(*, chain=True)

Форматирование исключения.

Если chain не True, __cause__ и __context__ не будут отформатированы.

Результат - генератор строк, каждая из которых заканчивается новой строкой, а некоторые содержат внутренние новые строки. print_exception() — это обертка над этим методом, которая просто выводит строки в файл.

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

format_exception_only()

Форматирование части исключения в трассировке.

Результат - генератор строк, каждая из которых заканчивается новой строкой.

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

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

Объекты StackSummary

StackSummary представляют собой стек вызовов, готовый к форматированию.

class traceback.StackSummary

classmethod extract(frame_gen, *, limit=None, lookup_lines=True, capture_locals=False)

Создание объекта StackSummary из генератора фреймов (например, возвращаемого walk_stack() или walk_tb()).

Если limit задано, из frame_gen берутся только столько фреймов. Если lookup_lines False, возвращаемые объекты FrameSummary ещё не считывали свои строки, что делает создание StackSummary более дешёвым (что может быть полезно, если он может фактически не быть отформатирован). Если capture_locals True, локальные переменные в каждом FrameSummary захватываются как представления объектов.

classmethod from_list(a_list)

Создание объекта StackSummary из списка объектов FrameSummary или списка кортежей старого стиля. Каждый кортеж должен быть 4-кортежем с именем файла, номером строки, именем и строкой как элементами.

format()

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

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

Изменено в версии 3.6: Длинные последовательности повторяющихся фреймов теперь сокращены.

Объекты FrameSummary

FrameSummary представляют собой отдельный фрейм в трассировке.

class traceback.FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None)

Представляет собой один фрейм в трассировке или стеке, который форматируется или выводится. Он может необязательно содержать строковое представление локальных переменных фрейма. Если lookup_line False, исходный код не ищется, пока у FrameSummary не будет обращено внимание на атрибут line (что также происходит при приведении его к кортежу). line может быть предоставлен непосредственно и предотвратит поиск строк.

locals - необязательный словарь локальных переменных, и если он предоставлен, представления переменных сохраняются в резюме для последующего отображения.

Примеры Traceback

Этот простой пример реализует цикл read-eval-print, похожий на (но менее полезный, чем) стандартный цикл интерактивного интерпретатора Python. Для более полной реализации цикла интерпретатора обратитесь к модулю code.

import sys, traceback

def run_user_code(envdir):
    source = input(">>> ")
    try:
        exec(source, envdir)
    except Exception:
        print("Exception in user code:")
        print("-"*60)
        traceback.print_exc(file=sys.stdout)
        print("-"*60)

envdir = {}
while True:
    run_user_code(envdir)

Следующий пример демонстрирует различные способы вывода и форматирования исключения и трассировки:

import sys, traceback

def lumberjack():
    bright_side_of_death()

def bright_side_of_death():
    return tuple()[0]

try:
    lumberjack()
except IndexError:
    exc_type, exc_value, exc_traceback = sys.exc_info()
    print("*** print_tb:")
    traceback.print_tb(exc_traceback, limit=1, file=sys.stdout)
    print("*** print_exception:")
    # exc_type below is ignored on 3.5 and later
    traceback.print_exception(exc_type, exc_value, exc_traceback,
                              limit=2, file=sys.stdout)
    print("*** print_exc:")
    traceback.print_exc(limit=2, file=sys.stdout)
    print("*** format_exc, first and last line:")
    formatted_lines = traceback.format_exc().splitlines()
    print(formatted_lines[0])
    print(formatted_lines[-1])
    print("*** format_exception:")
    # exc_type below is ignored on 3.5 and later
    print(repr(traceback.format_exception(exc_type, exc_value,
                                          exc_traceback)))
    print("*** extract_tb:")
    print(repr(traceback.extract_tb(exc_traceback)))
    print("*** format_tb:")
    print(repr(traceback.format_tb(exc_traceback)))
    print("*** tb_lineno:", exc_traceback.tb_lineno)

Вывод для примера будет похож на этот:

*** print_tb:
  File "<doctest...>", line 10, in <module>
    lumberjack()
*** print_exception:
Traceback (most recent call last):
  File "<doctest...>", line 10, in <module>
    lumberjack()
  File "<doctest...>", line 4, in lumberjack
    bright_side_of_death()
IndexError: tuple index out of range
*** print_exc:
Traceback (most recent call last):
  File "<doctest...>", line 10, in <module>
    lumberjack()
  File "<doctest...>", line 4, in lumberjack
    bright_side_of_death()
IndexError: tuple index out of range
*** format_exc, first and last line:
Traceback (most recent call last):
IndexError: tuple index out of range
*** format_exception:
['Traceback (most recent call last):\n',
 '  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',
 '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',
 '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n',
 'IndexError: tuple index out of range\n']
*** extract_tb:
[<FrameSummary file <doctest...>, line 10 in <module>>,
 <FrameSummary file <doctest...>, line 4 in lumberjack>,
 <FrameSummary file <doctest...>, line 7 in bright_side_of_death>]
*** format_tb:
['  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',
 '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',
 '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n']
*** tb_lineno: 10

Следующий пример демонстрирует различные способы вывода и форматирования стека:

>>> import traceback
>>> def another_function():
...     lumberstack()
...
>>> def lumberstack():
...     traceback.print_stack()
...     print(repr(traceback.extract_stack()))
...     print(repr(traceback.format_stack()))
...
>>> another_function()
  File "<doctest>", line 10, in <module>
    another_function()
  File "<doctest>", line 3, in another_function
    lumberstack()
  File "<doctest>", line 6, in lumberstack
    traceback.print_stack()
[('<doctest>', 10, '<module>', 'another_function()'),
 ('<doctest>', 3, 'another_function', 'lumberstack()'),
 ('<doctest>', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')]
['  File "<doctest>", line 10, in <module>\n    another_function()\n',
 '  File "<doctest>", line 3, in another_function\n    lumberstack()\n',
 '  File "<doctest>", line 8, in lumberstack\n    print(repr(traceback.format_stack()))\n']

Этот последний пример демонстрирует последние несколько функций форматирования:

>>> import traceback
>>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),
...                        ('eggs.py', 42, 'eggs', 'return "bacon"')])
['  File "spam.py", line 3, in <module>\n    spam.eggs()\n',
 '  File "eggs.py", line 42, in eggs\n    return "bacon"\n']
>>> an_error = IndexError('tuple index out of range')
>>> traceback.format_exception_only(type(an_error), an_error)
['IndexError: tuple index out of range\n']