Skip to main content

Human-readable HTML tracebacks for Python exceptions

Project description

Tracebacks for Humans (and Machines)

Fixing bugs is easier with well formatted error messages. Console, HTML and JSON.

PyPI version Tests Coverage

TraceRite in Notebook/HTML and terminal TraceRite formats Python errors in Jupyter notebooks, in plain HTML, and in the terminal: rich variable inspection (left), plus syntax-error highlighting and compact terminal tracebacks (right).

Installation

Python scripts or REPL

pip install tracerite
import tracerite; tracerite.load()

Any error message after that call will be prettified. Handles any syntax errors and uncaught exceptions, even captures logging.exception (optionally).

IPython or Jupyter Notebook

%pip install tracerite
%load_ext tracerite

This enables tracebacks in text or HTML format depending on where you are running. Add to ~/.ipython/profile_default/startup/tracerite.ipy to make it load automatically for all your ipython and notebook sessions. Alternatively, put the two lines at the top of your notebook.

If you are using UV, consider running with your other dependencies:

uvx --with tracerite --with numpy jupyter lab

FastAPI

Add the extension loader at the top of your app module:

from tracerite import patch_fastapi; patch_fastapi()

This monkeypatches Starlette error handling and FastAPI routing to work with HTML tracebacks. Note: this runs regardless of whether you are in production mode or debug mode, so you might want to call that function only conditionally in the latter.

Sanic

Comes with TraceRite built in. HTML reports are available in debug mode, and console messages are always formatted by Tracerite.

Clarity in complex situations

What you see is always in the order it was executed

Exception chain comparison TraceRite renders complex exception chains in chronological order (left). The Python 3.15 built in traceback needs illustrative arrows to follow execution (right).

Context manager enter/exit

When a with or async with fails, the built in handling of Python 3.11 marks the whole block, and 3.12.9+ marks the initializing expression like it was the culprit (e.g. function call marked incorrectly). We bypass that logic and differentiate between (1) the expression failing, (2) entering and (3) exiting the block.

Context manager failure In cases 2 (left) and 3 (right) we mark the whole with statement but not the block, and emphasize the expression responsible (helpful when there are more than one). In case 3 we include the executed block body in context shown (up to 20 lines).

Features

  • Chronological order - Single timeline with the program entry point is at top, and the finally uncaught exception bottom.
  • Minimalistic output - Smart pruning to show only relevant pieces of information, excluding library internals where not relevant and avoiding any repetition.
  • ExceptionGroups - Full tracebacks of the subexceptions from exceptions that occurred in parallel execution.
  • Variable inspection - See the values of your variables in a pretty printed HTML format, Terminal or JSON-compatible machine-readable dict.
  • JSON output - Intermediady dict format is JSON-compatible, useful for machine processing and used by our HTML and TTY modules.
  • HTML output - Works in Jupyter, Colab, and web frameworks such as FastAPI and Sanic as the debug mode error handler.
  • TTY output - Colorful, formatted tracebacks for terminal applications and Python REPL.
  • Custom Styling - Theme with your colors by defining CSS variables or tty.COLORS.
  • Automatic dark mode - Saves your eyes.

ExceptionGroup in HTML and terminal Python 3.11+ concurrent execution errors with except* handling are shown clearly in both HTML and terminal output.

Documentation

For the public API — including HTML rendering, terminal output, and the machine-readable chain format returned by extract_chain — see the API documentation. For contributors, see the Development guide.

License

Public Domain or equivalent.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tracerite-2.6.3.tar.gz (106.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tracerite-2.6.3-py3-none-any.whl (112.4 kB view details)

Uploaded Python 3

File details

Details for the file tracerite-2.6.3.tar.gz.

File metadata

  • Download URL: tracerite-2.6.3.tar.gz
  • Upload date:
  • Size: 106.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tracerite-2.6.3.tar.gz
Algorithm Hash digest
SHA256 72a3658e09c71ef97c424a9a1772f0069c7aa7d1189e061075286605be27efc0
MD5 14c0631869515e72cbd3470c8765a73c
BLAKE2b-256 aee7b41d33fa65beb48074b564eec778106f5f453818423c5db1bdcf61145f97

See more details on using hashes here.

File details

Details for the file tracerite-2.6.3-py3-none-any.whl.

File metadata

  • Download URL: tracerite-2.6.3-py3-none-any.whl
  • Upload date:
  • Size: 112.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tracerite-2.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2b7dd797fad42fec4d590f2bc41b7331172fa0e4d959d6f04606eb0f76ae62e5
MD5 25ea1faa547e634a363cb9e16be307aa
BLAKE2b-256 fcae74457a0bfe83b45a951f5a4900cb4e5bb7cf201edc029fb5b2a2df9e4028

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page