traceback.md
1> **Источник:** https://python-all.ru/3.9/library/traceback.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`traceback`](https://python-all.ru/3.9/library/traceback.html#module-traceback) – печать или получение трассировки стека89**Исходный код:** [Lib/traceback.py](https://python-all.ru/src/3.9/Lib/traceback.py)1011---1213Этот модуль предоставляет стандартный интерфейс для извлечения, форматирования и печати трассировок стека программ Python. Он в точности повторяет поведение интерпретатора Python при печати трассировки стека. Это полезно, когда требуется печатать трассировки стека программно, например, в «обёртке» вокруг интерпретатора.1415Модуль использует объекты traceback – это тип объекта, который хранится в переменной [`sys.last_traceback`](https://python-all.ru/3.9/library/sys.html#sys.last_traceback) и возвращается как третий элемент из [`sys.exc_info()`](https://python-all.ru/3.9/library/sys.html#sys.exc_info).1617Модуль определяет следующие функции:1819#### `traceback.print_tb(tb, limit=None, file=None)`2021Печатает до *limit* записей трассировки стека из объекта traceback *tb* (начиная с фрейма вызывающего), если *limit* положительный. В противном случае печатает последние `abs(limit)` записей. Если *limit* опущен или равен `None`, печатаются все записи. Если *file* опущен или равен `None`, вывод направляется в `sys.stderr`; в противном случае это должен быть открытый файл или файлоподобный объект для получения вывода.2223Изменено в версии 3.5: Добавлена поддержка отрицательного значения *limit*.2425#### `traceback.print_exception(etype, value, tb, limit=None, file=None, chain=True)`2627Печатает информацию об исключении и записи трассировки стека из объекта traceback *tb* в *file*. Отличается от [`print_tb()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_tb) следующим образом:2829- если *tb* не равен `None`, выводится заголовок `Traceback (most recent call last):`30- выводит исключение *etype* и *value* после трассировки стека3132- если *type(value)* равен [`SyntaxError`](https://python-all.ru/3.9/library/exceptions.html#SyntaxError) и *value* имеет соответствующий формат, выводится строка, в которой произошла синтаксическая ошибка, с символом «^», указывающим приблизительную позицию ошибки.3334Необязательный аргумент *limit* имеет то же значение, что и для [`print_tb()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_tb). Если *chain* истинно (по умолчанию), то цепочка исключений (атрибуты `__cause__` или `__context__` исключения) также будет выведена на печать, как это делает сам интерпретатор при печати необработанного исключения.3536Изменено в версии 3.5: Аргумент *etype* игнорируется и определяется по типу *value*.3738#### `traceback.print_exc(limit=None, file=None, chain=True)`3940Это сокращение для `print_exception(*sys.exc_info(), limit, file, chain)`.4142#### `traceback.print_last(limit=None, file=None, chain=True)`4344Это сокращение для `print_exception(sys.last_type, sys.last_value, sys.last_traceback, limit, file, chain)`. В общем случае оно будет работать только после того, как исключение достигнет интерактивного приглашения (см. [`sys.last_type`](https://python-all.ru/3.9/library/sys.html#sys.last_type)).4546#### `traceback.print_stack(f=None, limit=None, file=None)`4748Печатает до *limit* записей трассировки стека (начиная с точки вызова), если *limit* положительный. В противном случае печатает последние `abs(limit)` записей. Если *limit* опущен или равен `None`, печатаются все записи. Необязательный аргумент *f* можно использовать для указания альтернативного стекового фрейма для начала. Необязательный аргумент *file* имеет то же значение, что и для [`print_tb()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_tb).4950Изменено в версии 3.5: Добавлена поддержка отрицательного значения *limit*.5152#### `traceback.extract_tb(tb, limit=None)`5354Возвращает объект [`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary), представляющий список «предварительно обработанных» записей трассировки стека, извлечённых из объекта traceback *tb*. Полезно для альтернативного форматирования трассировок стека. Необязательный аргумент *limit* имеет то же значение, что и для [`print_tb()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_tb). «Предварительно обработанная» запись трассировки стека – это объект [`FrameSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.FrameSummary), содержащий атрибуты `filename`, `lineno`, `name` и `line`, представляющие информацию, которая обычно печатается для трассировки стека. `line` – это строка с удалёнными начальными и конечными пробелами; если исходный код недоступен, она равна `None`.5556#### `traceback.extract_stack(f=None, limit=None)`5758Извлекает необработанную трассировку из текущего стекового фрейма. Возвращаемое значение имеет тот же формат, что и для [`extract_tb()`](https://python-all.ru/3.9/library/traceback.html#traceback.extract_tb). Необязательные аргументы *f* и *limit* имеют то же значение, что и для [`print_stack()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_stack).5960#### `traceback.format_list(extracted_list)`6162Принимает список кортежей или объектов [`FrameSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.FrameSummary), возвращённых [`extract_tb()`](https://python-all.ru/3.9/library/traceback.html#traceback.extract_tb) или [`extract_stack()`](https://python-all.ru/3.9/library/traceback.html#traceback.extract_stack), и возвращает список строк, готовых к выводу. Каждая строка в результирующем списке соответствует элементу с тем же индексом в исходном списке. Каждая строка заканчивается символом новой строки; строки могут также содержать внутренние переводы строк для тех элементов, чья строка исходного текста не равна `None`.6364#### `traceback.format_exception_only(etype, value)`6566Форматирует часть трассировки стека, относящуюся к исключению. Аргументами являются тип и значение исключения, такие как возвращаются `sys.last_type` и `sys.last_value`. Возвращаемое значение – список строк, каждая из которых заканчивается символом новой строки. Обычно, список содержит одну строку; однако для исключений [`SyntaxError`](https://python-all.ru/3.9/library/exceptions.html#SyntaxError) он содержит несколько строк, которые (при печати) отображают подробную информацию о том, где произошла синтаксическая ошибка. Сообщение, указывающее, какое именно исключение произошло, всегда является последней строкой в списке.6768#### `traceback.format_exception(etype, value, tb, limit=None, chain=True)`6970Форматирует трассировку стека и информацию об исключении. Аргументы имеют тот же смысл, что и соответствующие аргументы [`print_exception()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_exception). Возвращаемое значение – список строк, каждая заканчивается символом новой строки, некоторые содержат внутренние переводы строк. При объединении и выводе этих строк печатается в точности тот же текст, что и при вызове [`print_exception()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_exception).7172Изменено в версии 3.5: Аргумент *etype* игнорируется и определяется по типу *value*.7374#### `traceback.format_exc(limit=None, chain=True)`7576Аналог `print_exc(limit)`, но возвращает строку вместо вывода в файл.7778#### `traceback.format_tb(tb, limit=None)`7980Сокращение для `format_list(extract_tb(tb, limit))`.8182#### `traceback.format_stack(f=None, limit=None)`8384Сокращение для `format_list(extract_stack(f, limit))`.8586#### `traceback.clear_frames(tb)`8788Очищает локальные переменные всех стековых фреймов в трассировке *tb*, вызывая метод `clear()` каждого объекта фрейма.8990Новое в версии 3.4.9192#### `traceback.walk_stack(f)`9394Обходит стек, следуя `f.f_back`, начиная с заданного фрейма, и порождает фрейм и номер строки для каждого фрейма. Если *f* равен `None`, используется текущий стек. Этот вспомогательный инструмент используется с [`StackSummary.extract()`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary.extract).9596Новое в версии 3.5.9798#### `traceback.walk_tb(tb)`99100Обходит трассировку, следуя `tb_next`, и порождает фрейм и номер строки для каждого фрейма. Этот вспомогательный инструмент используется с [`StackSummary.extract()`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary.extract).101102Новое в версии 3.5.103104Модуль также определяет следующие классы:105106## [`TracebackException`](https://python-all.ru/3.9/library/traceback.html#traceback.TracebackException) Объекты107108Новое в версии 3.5.109110Объекты [`TracebackException`](https://python-all.ru/3.9/library/traceback.html#traceback.TracebackException) создаются на основе реальных исключений для сохранения данных для последующей печати в облегчённом виде.111112#### `class traceback.TracebackException(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False)`113114Захватывает исключение для последующего отображения. Параметры *limit*, *lookup\_lines* и *capture\_locals* такие же, как для класса [`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary).115116Обратите внимание, что при захвате локальных переменных они также отображаются в трассировке.117118#### `__cause__`119120[`TracebackException`](https://python-all.ru/3.9/library/traceback.html#traceback.TracebackException) исходного `__cause__`.121122#### `__context__`123124[`TracebackException`](https://python-all.ru/3.9/library/traceback.html#traceback.TracebackException) исходного `__context__`.125126#### `__suppress_context__`127128Значение `__suppress_context__` из исходного исключения.129130#### `stack`131132[`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary), представляющий трассировку.133134#### `exc_type`135136Класс исходной обратной трассировки.137138#### `filename`139140Для синтаксических ошибок – имя файла, в котором произошла ошибка.141142#### `lineno`143144Для синтаксических ошибок – номер строки, в которой произошла ошибка.145146#### `text`147148Для синтаксических ошибок – текст, в котором произошла ошибка.149150#### `offset`151152Для синтаксических ошибок – смещение в тексте, где произошла ошибка.153154#### `msg`155156Для синтаксических ошибок – сообщение об ошибке компилятора.157158#### `classmethod from_exception(exc, *, limit=None, lookup_lines=True, capture_locals=False)`159160Захватывает исключение для последующего отображения. Параметры *limit*, *lookup\_lines* и *capture\_locals* такие же, как для класса [`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary).161162Обратите внимание, что при захвате локальных переменных они также отображаются в трассировке.163164#### `format(*, chain=True)`165166Форматирует исключение.167168Если *chain* не `True`, то `__cause__` и `__context__` не будут отформатированы.169170Возвращаемое значение – генератор строк, каждая из которых завершается символом новой строки, и некоторые содержат внутренние переводы строк. [`print_exception()`](https://python-all.ru/3.9/library/traceback.html#traceback.print_exception) является обёрткой вокруг этого метода, которая просто выводит строки в файл.171172Сообщение о произошедшем исключении всегда находится в последней строке вывода.173174#### `format_exception_only()`175176Форматирует часть трассировки, относящуюся к исключению.177178Возвращаемое значение – генератор строк, каждая из которых завершается символом новой строки.179180Обычно генератор выдает одну строку; однако для исключений [`SyntaxError`](https://python-all.ru/3.9/library/exceptions.html#SyntaxError) он выдает несколько строк, которые (при печати) отображают подробную информацию о том, где произошла синтаксическая ошибка.181182Сообщение о произошедшем исключении всегда находится в последней строке вывода.183184## [`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary) Объекты185186Новое в версии 3.5.187188Объекты [`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary) представляют стек вызовов, готовый к форматированию.189190#### `class traceback.StackSummary`191192#### `classmethod extract(frame_gen, *, limit=None, lookup_lines=True, capture_locals=False)`193194Создаёт объект [`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary) из генератора фреймов (такого, как возвращается [`walk_stack()`](https://python-all.ru/3.9/library/traceback.html#traceback.walk_stack) или [`walk_tb()`](https://python-all.ru/3.9/library/traceback.html#traceback.walk_tb)).195196Если указан параметр *limit*, из *frame\_gen* берётся только указанное количество фреймов. Если *lookup\_lines* равно `False`, возвращённые объекты [`FrameSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.FrameSummary) ещё не прочитают свои строки, что удешевляет создание [`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary) (это может быть полезно, если он, возможно, не будет фактически отформатирован). Если *capture\_locals* равно `True`, локальные переменные в каждом [`FrameSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.FrameSummary) захватываются в виде представления объектов.197198#### `classmethod from_list(a_list)`199200Создает объект [`StackSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.StackSummary) из предоставленного списка объектов [`FrameSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.FrameSummary) или списка кортежей старого стиля. Каждый кортеж должен быть кортежем из 4 элементов: filename, lineno, name, line.201202#### `format()`203204Возвращает список строк, готовых к печати. Каждая строка в результирующем списке соответствует одному фрейму из стека. Каждая строка заканчивается переводом строки; строки могут также содержать внутренние переводы строк для элементов с исходным текстом.205206Для длинных последовательностей одинаковых фреймов и строк сначала показываются первые несколько повторений, а затем сводная строка с указанием точного числа последующих повторений.207208Изменено в версии 3.6: Длинные последовательности повторяющихся фреймов теперь сокращаются.209210## [`FrameSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.FrameSummary) Объекты211212Новое в версии 3.5.213214Объекты [`FrameSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.FrameSummary) представляют один фрейм в traceback.215216#### `class traceback.FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None)`217218Представляет один фрейм в traceback или стеке, который форматируется или выводится на печать. При желании может содержать строковое представление локальных переменных фрейма. Если *lookup\_line* равен `False`, исходный код не ищется до тех пор, пока у [`FrameSummary`](https://python-all.ru/3.9/library/traceback.html#traceback.FrameSummary) не будет получен доступ к атрибуту `line` (что также происходит при преобразовании в кортеж). `line` может быть предоставлен напрямую, что полностью предотвратит поиск строк. *locals* – это необязательный словарь локальных переменных; если он указан, представления переменных сохраняются в сводке для последующего отображения.219220## Примеры traceback221222Этот простой пример реализует базовый цикл чтение-вычисление-печать, похожий на (но менее полезный, чем) стандартный цикл интерактивного интерпретатора Python. Для более полной реализации цикла интерпретатора обратитесь к модулю [`code`](https://python-all.ru/3.9/library/code.html#module-code).223224```python225import sys, traceback226227def run_user_code(envdir):228 source = input(">>> ")229 try:230 exec(source, envdir)231 except Exception:232 print("Exception in user code:")233 print("-"*60)234 traceback.print_exc(file=sys.stdout)235 print("-"*60)236237envdir = {}238while True:239 run_user_code(envdir)240```241242Следующий пример демонстрирует различные способы вывода и форматирования исключения и трассировки:243244```python245import sys, traceback246247def lumberjack():248 bright_side_of_death()249250def bright_side_of_death():251 return tuple()[0]252253try:254 lumberjack()255except IndexError:256 exc_type, exc_value, exc_traceback = sys.exc_info()257 print("*** print_tb:")258 traceback.print_tb(exc_traceback, limit=1, file=sys.stdout)259 print("*** print_exception:")260 # тип исключения ниже игнорируется начиная с Python 3.5261 traceback.print_exception(exc_type, exc_value, exc_traceback,262 limit=2, file=sys.stdout)263 print("*** print_exc:")264 traceback.print_exc(limit=2, file=sys.stdout)265 print("*** format_exc, first and last line:")266 formatted_lines = traceback.format_exc().splitlines()267 print(formatted_lines[0])268 print(formatted_lines[-1])269 print("*** format_exception:")270 # тип исключения ниже игнорируется начиная с Python 3.5271 print(repr(traceback.format_exception(exc_type, exc_value,272 exc_traceback)))273 print("*** extract_tb:")274 print(repr(traceback.extract_tb(exc_traceback)))275 print("*** format_tb:")276 print(repr(traceback.format_tb(exc_traceback)))277 print("*** tb_lineno:", exc_traceback.tb_lineno)278```279280Вывод для примера будет выглядеть примерно так:281282```text283*** print_tb:284 File "<doctest...>", line 10, in <module>285 lumberjack()286*** print_exception:287Traceback (most recent call last):288 File "<doctest...>", line 10, in <module>289 lumberjack()290 File "<doctest...>", line 4, in lumberjack291 bright_side_of_death()292IndexError: tuple index out of range293*** print_exc:294Traceback (most recent call last):295 File "<doctest...>", line 10, in <module>296 lumberjack()297 File "<doctest...>", line 4, in lumberjack298 bright_side_of_death()299IndexError: tuple index out of range300*** format_exc, first and last line:301Traceback (most recent call last):302IndexError: tuple index out of range303*** format_exception:304['Traceback (most recent call last):\n',305 ' File "<doctest...>", line 10, in <module>\n lumberjack()\n',306 ' File "<doctest...>", line 4, in lumberjack\n bright_side_of_death()\n',307 ' File "<doctest...>", line 7, in bright_side_of_death\n return tuple()[0]\n',308 'IndexError: tuple index out of range\n']309*** extract_tb:310[<FrameSummary file <doctest...>, line 10 in <module>>,311 <FrameSummary file <doctest...>, line 4 in lumberjack>,312 <FrameSummary file <doctest...>, line 7 in bright_side_of_death>]313*** format_tb:314[' File "<doctest...>", line 10, in <module>\n lumberjack()\n',315 ' File "<doctest...>", line 4, in lumberjack\n bright_side_of_death()\n',316 ' File "<doctest...>", line 7, in bright_side_of_death\n return tuple()[0]\n']317*** tb_lineno: 10318```319320Следующий пример показывает различные способы вывода и форматирования стека:321322```python323>>> import traceback324>>> def another_function():325... lumberstack()326...327>>> def lumberstack():328... traceback.print_stack()329... print(repr(traceback.extract_stack()))330... print(repr(traceback.format_stack()))331...332>>> another_function()333 File "<doctest>", line 10, in <module>334 another_function()335 File "<doctest>", line 3, in another_function336 lumberstack()337 File "<doctest>", line 6, in lumberstack338 traceback.print_stack()339[('<doctest>', 10, '<module>', 'another_function()'),340 ('<doctest>', 3, 'another_function', 'lumberstack()'),341 ('<doctest>', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')]342[' File "<doctest>", line 10, in <module>\n another_function()\n',343 ' File "<doctest>", line 3, in another_function\n lumberstack()\n',344 ' File "<doctest>", line 8, in lumberstack\n print(repr(traceback.format_stack()))\n']345```346347Этот последний пример демонстрирует несколько последних функций форматирования:348349```pycon350>>> import traceback351>>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),352... ('eggs.py', 42, 'eggs', 'return "bacon"')])353[' File "spam.py", line 3, in <module>\n spam.eggs()\n',354 ' File "eggs.py", line 42, in eggs\n return "bacon"\n']355>>> an_error = IndexError('tuple index out of range')356>>> traceback.format_exception_only(type(an_error), an_error)357['IndexError: tuple index out of range\n']358```359