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

TracebackException Объекты

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

class traceback.TracebackException(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False, compact=False, max_group_width=15, max_group_depth=10)

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

Если compact имеет значение true, в атрибутах класса сохраняются только данные, необходимые методу TracebackException format(). В частности, поле __context__ вычисляется только в том случае, если __cause__ имеет значение None и __suppress_context__ имеет значение false.

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

max_group_width и max_group_depth управляют форматированием групп исключений (см. BaseExceptionGroup). Глубина относится к уровню вложенности группы, а ширина — к размеру массива исключений в одной группе. Отформатированный вывод обрезается, когда превышен любой из лимитов.

Изменено в версии 3.10: Добавлен параметр compact.

Изменено в версии 3.11: Добавлены параметры max_group_width и max_group_depth.

__cause__

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

__context__

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

exceptions

Если self представляет собой ExceptionGroup, это поле содержит список экземпляров TracebackException, представляющих вложенные исключения. В противном случае оно None.

В версии 3.11.

__suppress_context__

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

__notes__

Значение __notes__ из исходного исключения или None, если исключение не имеет заметок. Если оно не None, оно форматируется в трассировке после строки исключения.

В версии 3.11.

stack

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

exc_type

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

filename

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

lineno

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

end_lineno

Для синтаксических ошибок — конечный номер строки, в которой произошла ошибка. Может быть None, если отсутствует.

В версии 3.10.

text

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

offset

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

end_offset

Для синтаксических ошибок — конечное смещение в тексте, в котором произошла ошибка. Может быть None, если отсутствует.

В версии 3.10.

msg

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

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

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

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

print(*, file=None, chain=True)

Вывод информации об исключении, возвращенной методом format(), в file (по умолчанию sys.stderr).

В версии 3.11.

format(*, chain=True)

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

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

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

format_exception_only()

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

Возвращаемое значение — генератор строк, каждая из которых заканчивается новой строкой.

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

Изменено в версии 3.11: Теперь в выходные данные включаются notes исключения.

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-кортежем с элементами filename, lineno, name, line.

format()

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

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

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

format_frame_summary(frame_summary)

Возвращает строку для печати одного из кадров, участвующих в стеке. Этот метод вызывается для каждого объекта FrameSummary, который необходимо напечатать с помощью StackSummary.format(). Если он возвращает None, кадр опускается из вывода.

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

FrameSummary Объекты

Объект FrameSummary представляет собой один кадр в стеке вызовов.

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

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

В объектах FrameSummary доступны следующие атрибуты:

filename

Имя файла исходного кода для этого кадра. Эквивалентно обращению к f.f_code.co_filename в объекте кадра f.

lineno

Номер строки исходного кода для этого кадра.

name

Эквивалентно обращению к f.f_code.co_name в объекте кадра f.

line

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

Примеры отладки

Этот простой пример реализует цикл «чтение-вычисление-вывод», аналогичный (но менее полезный, чем) стандартному циклу интерпретатора 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_life()

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

try:
    lumberjack()
except IndexError:
    exc = sys.exception()
    print("*** print_tb:")
    traceback.print_tb(exc.__traceback__, limit=1, file=sys.stdout)
    print("*** print_exception:")
    traceback.print_exception(exc, 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:")
    print(repr(traceback.format_exception(exc)))
    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_life()
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_life()
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 default[0]>", line 10, in <module>\n    lumberjack()\n',
 '  File "<doctest default[0]>", line 4, in lumberjack\n    bright_side_of_life()\n',
 '  File "<doctest default[0]>", line 7, in bright_side_of_life\n    return tuple()[0]\n           ~~~~~~~^^^\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_life>]
*** format_tb:
['  File "<doctest default[0]>", line 10, in <module>\n    lumberjack()\n',
 '  File "<doctest default[0]>", line 4, in lumberjack\n    bright_side_of_life()\n',
 '  File "<doctest default[0]>", line 7, in bright_side_of_life\n    return tuple()[0]\n           ~~~~~~~^^^\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']