GitHub - retracesoftware/retracesoftware: Top-level entry point for Retrace — configures and installs the record/replay runtime from environment variables.

Record production Python. Debug it backwards.

Retrace is the first reverse debugger designed for production CPython applications. Record a failing execution once, replay it locally and deterministically in VS Code, and step backwards from the crash to the cause.

Retrace records the boundary between your Python code and nondeterministic outside behavior (network, database, filesystem, time, randomness, model output, subprocess behavior), then replays the execution locally. Your Python code runs again, but recorded external calls return the values from the trace instead of touching the live world.

Retrace is useful when a bug depends on timing, network responses, filesystem state, model output, subprocess behavior, random values, clocks, or anything else that is painful to reproduce from logs alone.

This is an open-source preview. We have tested a broad range of libraries: see Compatibility. Threading support is currently experimental, with full support being released in the next version. Under certain scenarios threading diverges. See issues. Join us in GitHub Discussions to ask questions, share feedback, describe your use case, and talk with the team as the project evolves.

What Retrace Is Not

Retrace is not an APM tool. It does not sample traces or aggregate metrics across requests.

It is not a logging library. You do not decide in advance which variables might matter.

It is not rr for Python. Retrace does not record an entire machine process at the syscall level. It records the boundary between your Python code and the outside world, at Python semantics.

Performance

Retrace records at the Python/external boundary, not at the instruction level. For I/O-bound workloads such as Flask and Django services handling external API calls and database queries, recording overhead on our reference benchmarks is below 0.1% of request latency. CPU-bound workloads see higher overhead because crossing the boundary more frequently increases the number of recorded events; pure-Python computation between boundary calls runs at full speed.

Full benchmark methodology and reproducible results: docs/performance.md.

Compatibility

See COMPATIBILITY.md for the full matrix, what "tested" means, and current caveats around threading, Redis/fakeredis, Datasette/Uvicorn, and model-boundary replay.

Python versions: [TODO] Operating systems: [TODO]

Quick Start

The fastest way to try Retrace is the included Flask demo. It takes about 5 minutes.

Before you start, make sure you have:

Python 3.12 (python3.12 --version)
Go 1.25 or newer (go version)
Git
VS Code for replay debugging

See COMPATIBILITY.md for current platform details. For the full walkthrough, see quickstart/README.md.

By the end you will have a .retrace recording of a small Flask app and a VS Code session that can step backward from a breakpoint inside that recording.

git clone https://github.com/retracesoftware/retracesoftware.git
cd retracesoftware/quickstart

python3.12 -m venv .venv
source .venv/bin/activate

python -m pip install --upgrade pip
python -m pip install retracesoftware
python -m pip show retracesoftware
python -m retracesoftware install  # one-time: enables auto-recording for this venv
python -m pip install -r requirements.txt

python -m pip show retracesoftware should print package details that include Name: retracesoftware and Version: ....

Now record the demo:

RETRACE_RECORDING=recordings/flask.retrace python examples/flask_demo.py

The demo should print:

=== Retrace Flask demo ===
GET /health: status=200 body=...
POST /users Ada: status=201 body=...
POST /users Grace: status=201 body=...
GET /users/1: status=200 body=...
GET /summary: status=200 body=...
Flask demo complete.

A file is now written at recordings/flask.retrace. That is your recording. Check it before opening VS Code:

ls -lh recordings/flask.retrace
code .

In VS Code:

Install the Retrace Debug Extension from the Marketplace. The publisher is RetraceSoftware.
Open the Retrace sidebar.
Choose Open Recording....
Select recordings/flask.retrace.
Open examples/flask_demo.py.
Set a breakpoint inside a route handler or inside main().
Start replay from the Retrace view.

You are done when VS Code stops at your breakpoint, the Retrace sidebar shows the recorded process tree, and the Step Back button moves backward through the recording. From there you can inspect variables, continue, step backward and forward, reverse, and restart without rerunning the Flask demo live.

Requirements

See Compatibility for Python and OS support.
pip
Go 1.25 or newer on PATH (Retrace installs with pip, but replay extraction and VS Code replay/debugging use Retrace's Go replay tool).

On macOS with Homebrew:

brew install go

On Linux, install Go 1.25 or newer from your distro packages or from go.dev/dl.

How Recording Works

Install the package:

python -m pip install retracesoftware

Enable the auto-recording hook in the active virtual environment:

python -m retracesoftware install

That installs a .pth file into the environment. Fresh Python processes in that environment import Retrace at startup, but they only record when you set a Retrace environment variable.

Record an ordinary Python file:

RETRACE_RECORDING=recordings/run.retrace python my_script.py

Retrace creates the parent directory if needed and writes an executable .retrace file. The recording stores the command, working directory, environment, Python version, Retrace checksums, and recorded boundary calls.

You can also record without the .pth hook:

python -m retracesoftware --recording recordings/run.retrace -- my_script.py

For module-based apps and tools, put RETRACE_RECORDING=... before the same Python command you would normally run:

RETRACE_RECORDING=recordings/cli.retrace python -m your_package.cli --input examples/input.json
RETRACE_RECORDING=recordings/tests.retrace python -m pytest tests/
RETRACE_RECORDING=recordings/debug.retrace python -c "import random; print(random.random())"

For more examples, see docs/getting-started/recording-python-commands.md.

Replay And Debug In VS Code

Open the same folder that contains your source and .retrace file:

code .

Then open the recording from the Retrace sidebar or right-click the .retrace file and choose Open as Retrace Recording.

The extension reads the replay binary path embedded in the .retrace shebang, indexes the recorded process tree, and launches replay debugging through the Go replay tool.

Set breakpoints in the recorded Python code and start replay. The debugger runs the recorded execution, not a live process.

See docs/getting-started/vscode-extension.md.

Terminal Replay

Extract the recording:

./recordings/run.retrace --extract

That creates:

recordings/run.d/index.json
recordings/run.d/<PID>.bin

Find the root process:

ROOT_PID=$(python -m retracesoftware --recording recordings/run.retrace --list_pids | head -1)

Replay it:

./recordings/run.d/${ROOT_PID}.bin

Documentation

Development From Source

Install from this checkout:

python -m pip install --upgrade pip wheel
python -m pip install "meson>=1.3" "meson-python>=0.18.0" "setuptools_scm>=8.0.4" ninja
python -m pip install --no-build-isolation -e .

The package includes Python code, native extensions built by Meson, module interception config, and the Go replay tooling used for extraction, terminal replay, and VS Code replay/debugging. Supported wheels include the replay binary; source/development installs can build it lazily if it is missing, which is why Go is required on PATH.

Run Python tests:

python -m pytest tests/ -v --tb=short

Run Go tests:

cd go
go test ./...

Repository Layout

quickstart/ first-run demo and public quickstart flow
src/retracesoftware/__main__.py CLI record/replay entrypoint
src/retracesoftware/autoenable.py .pth startup hook implementation
src/retracesoftware/tape.py recording file setup, checksums, and tape I/O
src/retracesoftware/install/ runtime patching and import hooks
src/retracesoftware/proxy/ record/replay boundary semantics
src/retracesoftware/modules/ stdlib and third-party interception config
src/retracesoftware/stream/ and cpp/stream/ trace serialization
src/retracesoftware/dap/ Python debugger protocol pieces
go/ replay extraction, indexing, and debug adapter tooling
vscode/ VS Code extension
tests/ and dockertests/ unit, replay, and scenario tests
docs/ user and maintainer documentation

Built By

Retrace is built by Retrace Software in London. Backed by Preston-Werner Ventures. Advised by Yury Selivanov, creator of asyncio and uvloop, PSF Fellow.

The patented value-level provenance engine that sits on top of record-replay (granted UK, US, EU patents) is being prepared for separate release.

License

Apache-2.0

推荐订阅源

Hacker News: Show HN