traceback — Print or retrieve a stack traceback — Python 3.15.2 documentation
Навігація індекс модулі | наступний | попередній | Python » 3.15.2 documentation » The Python standard library » Служби виконання Python » traceback — Print or retrieve a stack traceback | Theme | traceback — Print or retrieve a stack traceback ¶ Вихідний код: Lib/traceback.py This module provides a standard interface to extract, format and print stack traces of Python programs.
It is more flexible than the interpreter’s default traceback display, and therefore makes it possible to configure certain aspects of the output. Finally, it contains a utility for capturing enough information about an exception to print it later, without the need to save a reference to the actual exception. Since exceptions can be the roots of large objects graph, this utility can significantly improve memory management.
The module uses traceback objects — these are objects of type types.TracebackType , which are assigned to the __traceback__ field of BaseException instances. Дивись також Module faulthandler Used to dump Python tracebacks explicitly, on a fault, after a timeout, or on a user signal. Module pdb Interactive source code debugger for Python programs. The module’s API can be divided into two parts: Module-level functions offering basic functionality, which are useful for interactive inspection of exceptions and tracebacks.
TracebackException class and its helper classes StackSummary and FrameSummary . These offer both more flexibility in the output generated and the ability to store the information necessary for later formatting without holding references to actual exception and traceback objects. Функції рівня модуля ¶ traceback. print_tb ( tb , limit = None , file = None ) ¶ Print up to limit stack trace entries from traceback object tb (starting from the caller’s frame) if limit is positive.
Otherwise, print the last abs(limit) entries. If limit is omitted or None , all entries are printed. If file is omitted or None , the output goes to sys.stderr ; otherwise it should be an open file or file-like object to receive the output. Примітка The meaning of the limit parameter is different than the meaning of sys.tracebacklimit . A negative limit value corresponds to a positive value of sys.tracebacklimit , whereas the behaviour of a positive limit value cannot be achieved with sys.tracebacklimit .
Змінено в версії 3.5: Додано підтримку негативного ліміту . traceback. print_exception ( exc , / , [ value , tb , ] limit = None , file = None , chain = True ) ¶ Print exception information and stack trace entries from traceback object tb to file . This differs from print_tb() in the following ways: якщо tb не є None , він друкує заголовок Traceback (останній останній виклик): він друкує тип винятку та значення після трасування стека якщо type(value) дорівнює SyntaxError і value має відповідний формат, він друкує рядок, у якому сталася синтаксична помилка, із кареткою, що вказує на приблизну позицію помилки.
Починаючи з Python 3.10, замість передачі value і tb об’єкт винятку можна передати як перший аргумент. Якщо надано value і tb , перший аргумент ігнорується, щоб забезпечити зворотну сумісність. The optional limit argument has the same meaning as for print_tb() . If 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.
Змінено в версії 3.5: Аргумент etype ігнорується та виводиться з типу value . Змінено в версії 3.10: Параметр etype було перейменовано на exc і тепер є лише позиційним. traceback. print_exc ( limit = None , file = None , chain = True ) ¶ This is a shorthand for print_exception(sys.exception(), limit=limit, file=file, chain=chain) . traceback. print_last ( limit = None , file = None , chain = True ) ¶ This is a shorthand for print_exception(sys.last_exc, limit=limit, file=file, chain=chain) .
In general it will work only after an exception has reached an interactive prompt (see sys.last_exc ). traceback. print_stack ( f = None , limit = None , file = None ) ¶ Print up to limit stack trace entries (starting from the invocation point) if limit is positive. Otherwise, print the last abs(limit) entries. If limit is omitted or None , all entries are printed. The optional f argument can be used to specify an alternate stack frame to start.
The optional file argument has the same meaning as for print_tb() . Змінено в версії 3.5: Додано підтримку негативного ліміту . traceback. extract_tb ( tb , limit = None ) ¶ Return a StackSummary object representing a list of «pre-processed» stack trace entries extracted from the traceback object tb . It is useful for alternate formatting of stack traces. The optional limit argument has the same meaning as for print_tb() .
A «pre-processed» stack trace entry is a FrameSummary object with attributes representing the information that is usually printed for a stack trace. traceback. extract_stack ( f = None , limit = None ) ¶ Extract the raw traceback from the current stack frame . The return value has the same format as for extract_tb() . The optional f and limit arguments have the same meaning as for print_stack() . traceback. print_list ( extracted_list , file = None ) ¶ Print a list of FrameSummary objects as returned by extract_tb() or extract_stack() , or a list of old-style tuples (see StackSummary.from_list() ), as a formatted stack trace to the given file.
If file is None , the output is written to sys.stderr . traceback. format_list ( extracted_list ) ¶ Given a list of FrameSummary objects as returned by extract_tb() or extract_stack() , or a list of old-style tuples (see StackSummary.from_list() ), return a list of strings ready for printing. Each string in the resulting list corresponds to the item with the same index in the argument list. Each string ends in a newline; the strings may contain internal newlines as well, for those items whose source text line is not None . traceback. format_exception_only ( exc , / , [ value , ] * , show_group = False ) ¶ Format the exception part of a traceback using an exception value such as given by sys.last_exc .
The return value is a list of strings, each ending in a newline. The list contains the exception’s message, which is normally a single string; however, for SyntaxError exceptions, it contains several lines that (when printed) display detailed information about where the syntax error occurred. Following the message, the list contains the exception’s notes . Починаючи з Python 3.10, замість передачі значення як перший аргумент можна передати об’єкт винятку.
Якщо вказано значення , перший аргумент ігнорується, щоб забезпечити зворотну сумісність. When show_group is True , and the exception is an instance of BaseExceptionGroup , the nested exceptions are included as well, recursively, with indentation relative to their nesting depth. Змінено в версії 3.10: Параметр etype було перейменовано на exc і тепер є лише позиційним.
Змінено в версії 3.11: The returned list now includes any notes attached to the exception. �
The rest of this page is on the live site.