Module: core.doctb

1 Class

class IPython.core.doctb.DocTB(theme_name: str = 'linux', call_pdb: bool = False, ostream: Any = None, tb_offset: int = 0, long_header: bool = False, include_vars: bool = True, check_cache: Callable[[], None] | None = None, debugger_cls: type | None = None)

Bases: TBTools

A stripped down version of Verbose TB, simplified to not have too much information when running doctests

__init__(theme_name: str = 'linux', call_pdb: bool = False, ostream: Any = None, tb_offset: int = 0, long_header: bool = False, include_vars: bool = True, check_cache: Callable[[], None] | None = None, debugger_cls: type | None = None)

Specify traceback offset, headers and color scheme.

Define how many frames to drop from the tracebacks. Calling it with tb_offset=1 allows use of this handler in interpreters which will have their own code at the top of the traceback (VerboseTB will first remove that frame before printing the traceback info).

format_exception_as_a_whole(etype: type, evalue: BaseException | None, etb: TracebackType | None, context: int, tb_offset: int | None) → list[list[str]]

Formats the header, traceback and exception message for a single exception.

This may be called multiple times by Python 3 exception chaining (PEP 3134).

format_record(frame_info: FrameInfo) → str

Format a single stack frame

structured_traceback(etype: type, evalue: BaseException | None, etb: TracebackType | None = None, tb_offset: int | None = None, context: int = 1) → list[str]

Return a nice text document describing the traceback.