Документация Python неофициальный перевод

traceback.md

210 строк · 14.4 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.3/library/traceback.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 28.9. [`traceback`](https://python-all.ru/3.3/library/traceback.html#module-traceback) – Вывод или получение трассировки стека89Этот модуль предоставляет стандартный интерфейс для извлечения, форматирования и печати трассировок стека программ Python. Он в точности повторяет поведение интерпретатора Python при печати трассировки стека. Это полезно, когда требуется печатать трассировки стека программно, например, в «обёртке» вокруг интерпретатора.1011Модуль использует объекты трассировки – это тип объектов, который хранится в переменной [`sys.last_traceback`](https://python-all.ru/3.3/library/sys.html#sys.last_traceback) и возвращается третьим элементом из [`sys.exc_info()`](https://python-all.ru/3.3/library/sys.html#sys.exc_info).1213Модуль определяет следующие функции:1415#### `traceback.print_tb(traceback, limit=None, file=None)`1617Выводит до *limit* записей стековой трассировки из *traceback*. Если *limit* опущен или равен `None`, выводятся все записи. Если *file* опущен или равен `None`, вывод направляется в `sys.stderr`; в противном случае это должен быть открытый файл или объект, подобный файлу, для получения вывода.1819#### `traceback.print_exception(type, value, traceback, limit=None, file=None, chain=True)`2021Выводит информацию об исключении и до *limit* записей стековой трассировки из *traceback* в *file*. Отличается от [`print_tb()`](https://python-all.ru/3.3/library/traceback.html#traceback.print_tb) следующим:2223- если *traceback* не равен `None`, выводится заголовок `Traceback (most recent call last):`24- выводит тип исключения *type* и *value* после стековой трассировки25- если *type* – [`SyntaxError`](https://python-all.ru/3.3/library/exceptions.html#SyntaxError), а *value* имеет соответствующий формат, то выводится строка с синтаксической ошибкой и символом «^», указывающим примерное положение ошибки.2627If *chain* is true (the default), then chained exceptions (the `__cause__` or `__context__` attributes of the exception) will be printed as well, like the interpreter itself does when printing an unhandled exception.2829#### `traceback.print_exc(limit=None, file=None, chain=True)`3031Это сокращение для `print_exception(*sys.exc_info())`.3233#### `traceback.print_last(limit=None, file=None, chain=True)`3435Это сокращение для `print_exception(sys.last_type, sys.last_value, sys.last_traceback, limit, file)`. Обычно работает только после того, как исключение достигло интерактивного приглашения (см. [`sys.last_type`](https://python-all.ru/3.3/library/sys.html#sys.last_type)).3637#### `traceback.print_stack(f=None, limit=None, file=None)`3839Эта функция выводит стековую трассировку начиная с точки вызова. Необязательный аргумент *f* позволяет указать альтернативный стековый кадр для начала. Необязательные аргументы *limit* и *file* имеют тот же смысл, что и для [`print_exception()`](https://python-all.ru/3.3/library/traceback.html#traceback.print_exception).4041#### `traceback.extract_tb(traceback, limit=None)`4243Возвращает список не более *limit* «предварительно обработанных» записей трассировки стека, извлеченных из объекта трассировки *traceback*. Полезно для альтернативного форматирования трассировок стека. Если *limit* опущен или `None`, извлекаются все записи. «Предварительно обработанная» запись трассировки стека – это четверка (*filename*, *номер строки*, *имя функции*, *text*), представляющая информацию, которая обычно выводится для трассировки стека. *text* – это строка с удаленными начальными и конечными пробелами; если исходный код недоступен, значением будет `None`.4445#### `traceback.extract_stack(f=None, limit=None)`4647Извлекает «сырую» трассировку из текущего стекового кадра. Возвращаемое значение имеет тот же формат, что и для [`extract_tb()`](https://python-all.ru/3.3/library/traceback.html#traceback.extract_tb). Необязательные аргументы *f* и *limit* имеют тот же смысл, что и для [`print_stack()`](https://python-all.ru/3.3/library/traceback.html#traceback.print_stack).4849#### `traceback.format_list(list)`5051По списку кортежей, возвращённому [`extract_tb()`](https://python-all.ru/3.3/library/traceback.html#traceback.extract_tb) или [`extract_stack()`](https://python-all.ru/3.3/library/traceback.html#traceback.extract_stack), возвращает список строк, готовых к печати. Каждая строка в результирующем списке соответствует элементу с тем же индексом в исходном списке. Каждая строка заканчивается символом новой строки; строки могут также содержать внутренние символы новой строки для тех элементов, у которых текст исходной строки не равен `None`.5253#### `traceback.format_exception_only(type, value)`5455Форматирует часть трассировки, относящуюся к исключению. Аргументы – это tип исключения и его значение, например, из `sys.last_type` и `sys.last_value`. Возвращаемое значение – список строк, каждая заканчивается символом новой строки. Обычно список содержит одну строку; однако для исключений [`SyntaxError`](https://python-all.ru/3.3/library/exceptions.html#SyntaxError) он содержит несколько строк, которые (при печати) отображают подробную информацию о том, где произошла синтаксическая ошибка. Сообщение, указывающее, какое именно исключение произошло, всегда является последней строкой в списке.5657#### `traceback.format_exception(type, value, tb, limit=None, chain=True)`5859Форматирует стековую трассировку и информацию об исключении. Аргументы имеют тот же смысл, что и соответствующие аргументы [`print_exception()`](https://python-all.ru/3.3/library/traceback.html#traceback.print_exception). Возвращаемое значение – список строк, каждая заканчивается символом новой строки, некоторые содержат внутренние символы новой строки. Если эти строки объединить и вывести на печать, будет напечатан в точности тот же текст, что и при вызове [`print_exception()`](https://python-all.ru/3.3/library/traceback.html#traceback.print_exception).6061#### `traceback.format_exc(limit=None, chain=True)`6263То же, что `print_exc(limit)`, но возвращает строку, а не выводит в файл.6465#### `traceback.format_tb(tb, limit=None)`6667Сокращение для `format_list(extract_tb(tb, limit))`.6869#### `traceback.format_stack(f=None, limit=None)`7071Сокращённая запись для `format_list(extract_stack(f, limit))`.7273## 28.9.1. Примеры traceback7475Этот простой пример реализует базовый цикл read-eval-print, похожий на стандартный интерактивный цикл интерпретатора Python (но менее полезный). Для более полной реализации цикла интерпретатора обратитесь к модулю [`code`](https://python-all.ru/3.3/library/code.html#module-code).7677```python78import sys, traceback7980def run_user_code(envdir):81    source = input(">>> ")82    try:83        exec(source, envdir)84    except:85        print("Exception in user code:")86        print("-"*60)87        traceback.print_exc(file=sys.stdout)88        print("-"*60)8990envdir = {}91while True:92    run_user_code(envdir)93```9495Следующий пример демонстрирует различные способы вывода и форматирования исключения и трассировки:9697```python98import sys, traceback99100def lumberjack():101    bright_side_of_death()102103def bright_side_of_death():104    return tuple()[0]105106try:107    lumberjack()108except IndexError:109    exc_type, exc_value, exc_traceback = sys.exc_info()110    print("*** print_tb:")111    traceback.print_tb(exc_traceback, limit=1, file=sys.stdout)112    print("*** print_exception:")113    traceback.print_exception(exc_type, exc_value, exc_traceback,114                              limit=2, file=sys.stdout)115    print("*** print_exc:")116    traceback.print_exc()117    print("*** format_exc, first and last line:")118    formatted_lines = traceback.format_exc().splitlines()119    print(formatted_lines[0])120    print(formatted_lines[-1])121    print("*** format_exception:")122    print(repr(traceback.format_exception(exc_type, exc_value,123                                          exc_traceback)))124    print("*** extract_tb:")125    print(repr(traceback.extract_tb(exc_traceback)))126    print("*** format_tb:")127    print(repr(traceback.format_tb(exc_traceback)))128    print("*** tb_lineno:", exc_traceback.tb_lineno)129```130131Вывод для примера будет выглядеть примерно так:132133```text134*** print_tb:135  File "<doctest...>", line 10, in <module>136    lumberjack()137*** print_exception:138Traceback (most recent call last):139  File "<doctest...>", line 10, in <module>140    lumberjack()141  File "<doctest...>", line 4, in lumberjack142    bright_side_of_death()143IndexError: tuple index out of range144*** print_exc:145Traceback (most recent call last):146  File "<doctest...>", line 10, in <module>147    lumberjack()148  File "<doctest...>", line 4, in lumberjack149    bright_side_of_death()150IndexError: tuple index out of range151*** format_exc, first and last line:152Traceback (most recent call last):153IndexError: tuple index out of range154*** format_exception:155['Traceback (most recent call last):\n',156 '  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',157 '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',158 '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n',159 'IndexError: tuple index out of range\n']160*** extract_tb:161[('<doctest...>', 10, '<module>', 'lumberjack()'),162 ('<doctest...>', 4, 'lumberjack', 'bright_side_of_death()'),163 ('<doctest...>', 7, 'bright_side_of_death', 'return tuple()[0]')]164*** format_tb:165['  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',166 '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',167 '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n']168*** tb_lineno: 10169```170171Следующий пример показывает различные способы вывода и форматирования стека:172173```python174>>> import traceback175>>> def another_function():176...     lumberstack()177...178>>> def lumberstack():179...     traceback.print_stack()180...     print(repr(traceback.extract_stack()))181...     print(repr(traceback.format_stack()))182...183>>> another_function()184  File "<doctest>", line 10, in <module>185    another_function()186  File "<doctest>", line 3, in another_function187    lumberstack()188  File "<doctest>", line 6, in lumberstack189    traceback.print_stack()190[('<doctest>', 10, '<module>', 'another_function()'),191 ('<doctest>', 3, 'another_function', 'lumberstack()'),192 ('<doctest>', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')]193['  File "<doctest>", line 10, in <module>\n    another_function()\n',194 '  File "<doctest>", line 3, in another_function\n    lumberstack()\n',195 '  File "<doctest>", line 8, in lumberstack\n    print(repr(traceback.format_stack()))\n']196```197198Этот последний пример демонстрирует несколько последних функций форматирования:199200```python201>>> import traceback202>>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),203...                        ('eggs.py', 42, 'eggs', 'return "bacon"')])204['  File "spam.py", line 3, in <module>\n    spam.eggs()\n',205 '  File "eggs.py", line 42, in eggs\n    return "bacon"\n']206>>> an_error = IndexError('tuple index out of range')207>>> traceback.format_exception_only(type(an_error), an_error)208['IndexError: tuple index out of range\n']209```210