mirror of https://github.com/Textualize/rich.git
30 lines
998 B
ReStructuredText
30 lines
998 B
ReStructuredText
Traceback
|
|
=========
|
|
|
|
Rich can render Python tracebacks with syntax highlighting and formatting. Rich tracebacks are easier to read, and show more code, than standard Python tracebacks.
|
|
|
|
|
|
Printing tracebacks
|
|
-------------------
|
|
|
|
The :meth:`~rich.console.Console.print_exception` method will print a traceback for the current exception being handled. Here's an example::
|
|
|
|
import rich
|
|
try:
|
|
do_something()
|
|
except:
|
|
console = rich.console.Console()
|
|
console.print_exception(show_locals=True)
|
|
|
|
The ``show_locals=True`` parameter causes Rich to display the value of local variables for each section of the traceback.
|
|
|
|
Traceback handler
|
|
-----------------
|
|
|
|
Rich can be installed as the default traceback handler so that all uncaught exceptions will be rendered with highlighting. Here's how::
|
|
|
|
from rich.traceback import install
|
|
install(show_locals=True)
|
|
|
|
There are a few options to configure the traceback handler, see :func:`~rich.traceback.install` for details.
|