redroot 0.2.0__py3-none-any.whl

redroot/visualizer/graphviz.py

@@ -0,0 +1,44 @@
+"""Export traces to GraphViz (requires ``redroot[viz]``)."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from redroot.trace import Trace
+from redroot.visualizer.data import node_label
+
+_STYLES: dict[str, dict[str, str]] = {
+    "leaf": {"shape": "box", "style": "filled", "fillcolor": "#e1f5fe"},
+    "op": {"shape": "box", "style": "rounded"},
+    "guard": {"shape": "diamond", "style": "dashed", "color": "#ef6c00"},
+    "output": {"shape": "note", "style": "filled", "fillcolor": "#e8f5e9"},
+}
+
+
+def to_graphviz(
+    trace: Trace, output_file: str | None = None, *, view: bool = False, format: str = "svg"
+) -> Any:
+    """Build a ``graphviz.Digraph`` of ``trace``; render it if ``output_file`` is given.
+
+    Inputs are blue boxes, guards dashed diamonds and outputs green notes.
+    """
+    try:
+        from graphviz import Digraph
+    except ImportError as exc:
+        raise ImportError(
+            "graphviz is not installed. Install with 'pip install redroot[viz]'"
+        ) from exc
+
+    dot = Digraph(name=trace.name or "redroot", comment="RedRoot trace", format=format)
+    dot.attr(rankdir="LR")
+    for node in trace.nodes:
+        dot.node(str(node.id), node_label(node), **_STYLES.get(node.kind, {}))
+        for operand_id in dict.fromkeys(operand.id for operand in node.operands()):
+            dot.edge(str(operand_id), str(node.id))
+    for key, out in trace.outputs.items():
+        dot.node(key, key, **_STYLES["output"])
+        if out.node is not None:
+            dot.edge(str(out.node.id), key)
+    if output_file is not None:
+        dot.render(output_file, view=view, cleanup=True)
+    return dot

redroot/visualizer/networkx.py

@@ -0,0 +1,36 @@
+"""Export traces to NetworkX (requires ``redroot[viz]``)."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from redroot.trace import Trace
+
+
+def to_networkx(trace: Trace) -> Any:
+    """Convert ``trace`` to a ``networkx.MultiDiGraph``.
+
+    Nodes are keyed by node id, with ``op``, ``kind``, ``key`` and ``value``
+    attributes. Each operand becomes an edge carrying its argument
+    ``position``. Outputs are extra nodes keyed by their output key, with
+    ``kind="output"``.
+    """
+    try:
+        import networkx as nx
+    except ImportError as exc:
+        raise ImportError(
+            "networkx is not installed. Install with 'pip install redroot[viz]'"
+        ) from exc
+
+    graph = nx.MultiDiGraph(name=trace.name, trace_id=trace.id)
+    for node in trace.nodes:
+        graph.add_node(
+            node.id, op=node.op, kind=node.kind, key=node.key, value=node.value, meta=node.meta
+        )
+        for position, operand in enumerate(node.operands()):
+            graph.add_edge(operand.id, node.id, position=position)
+    for key, out in trace.outputs.items():
+        graph.add_node(key, kind="output", value=out.value)
+        if out.node is not None:
+            graph.add_edge(out.node.id, key)
+    return graph

redroot/visualizer/web/__init__.py

@@ -0,0 +1 @@
+"""The local web viewer for traces."""

redroot/visualizer/web/server.py

@@ -0,0 +1,52 @@
+"""A small local web viewer for traces (requires ``redroot[web]``)."""
+
+from __future__ import annotations
+
+import threading
+import webbrowser
+from pathlib import Path
+from typing import Any
+
+from redroot.trace import Trace
+from redroot.visualizer.data import graph_data
+
+STATIC_DIR = Path(__file__).resolve().parent / "static"
+
+
+def create_app(trace: Trace) -> Any:
+    """Create the Flask app serving the viewer for ``trace``."""
+    try:
+        from flask import Flask, jsonify, send_from_directory
+    except ImportError as exc:
+        raise ImportError(
+            "flask is not installed. Install with 'pip install redroot[web]'"
+        ) from exc
+
+    app = Flask(__name__, static_folder=None)
+    data = graph_data(trace)
+
+    @app.route("/")
+    def index() -> Any:
+        return send_from_directory(STATIC_DIR, "index.html")
+
+    @app.route("/api/graph")
+    def get_graph() -> Any:
+        return jsonify(data)
+
+    @app.route("/<path:path>")
+    def serve_static(path: str) -> Any:
+        return send_from_directory(STATIC_DIR, path)
+
+    return app
+
+
+def run_server(
+    trace: Trace, host: str = "127.0.0.1", port: int = 8050, open_browser: bool = True
+) -> None:
+    """Serve the viewer for ``trace`` until interrupted."""
+    app = create_app(trace)
+    url = f"http://{host}:{port}"
+    print(f"RedRoot viewer running at {url} (Ctrl+C to stop)")
+    if open_browser:
+        threading.Timer(1.0, lambda: webbrowser.open(url)).start()
+    app.run(host=host, port=port, debug=False)

redroot/visualizer/web/static/app.js

@@ -0,0 +1,125 @@
+// RedRoot trace viewer. All trace content is inserted with textContent:
+// values come from user data and must never be interpreted as HTML.
+
+const COLORS = { leaf: '#e1f5fe', op: '#ffffff', guard: '#fff3e0', output: '#e8f5e9' };
+
+document.addEventListener('DOMContentLoaded', () => {
+    fetch('/api/graph')
+        .then((response) => response.json())
+        .then(render)
+        .catch((err) => console.error('Error loading trace:', err));
+});
+
+function el(tag, text, className) {
+    const node = document.createElement(tag);
+    if (text !== undefined) node.textContent = text;
+    if (className) node.className = className;
+    return node;
+}
+
+function render(data) {
+    document.getElementById('trace-name').textContent = data.name || data.id;
+    document.getElementById('node-count').textContent = data.nodes.length;
+    document.getElementById('guard-count').textContent =
+        data.nodes.filter((n) => n.kind === 'guard').length;
+    document.getElementById('output-count').textContent = data.outputs.length;
+
+    const nodes = data.nodes.map((n) => ({ ...n, gid: `n${n.id}` }));
+    const links = data.edges.map((e) => ({ source: `n${e.source}`, target: `n${e.target}` }));
+    data.outputs.forEach((out) => {
+        nodes.push({ gid: `o:${out.key}`, kind: 'output', label: out.key, output: out });
+        if (out.node !== null) links.push({ source: `n${out.node}`, target: `o:${out.key}` });
+    });
+
+    const parents = new Map(nodes.map((n) => [n.gid, []]));
+    links.forEach((l) => parents.get(l.target).push(l.source));
+
+    const container = document.getElementById('graph');
+    const width = container.clientWidth;
+    const height = container.clientHeight;
+    const svg = d3.select(container).append('svg').attr('width', width).attr('height', height);
+    const g = svg.append('g');
+    svg.call(d3.zoom().on('zoom', (event) => g.attr('transform', event.transform)));
+
+    svg.append('defs').append('marker')
+        .attr('id', 'arrow').attr('viewBox', '0 -5 10 10').attr('refX', 22)
+        .attr('markerWidth', 6).attr('markerHeight', 6).attr('orient', 'auto')
+        .append('path').attr('d', 'M0,-5L10,0L0,5').attr('fill', '#999');
+
+    const simulation = d3.forceSimulation(nodes)
+        .force('link', d3.forceLink(links).id((d) => d.gid).distance(90))
+        .force('charge', d3.forceManyBody().strength(-250))
+        .force('center', d3.forceCenter(width / 2, height / 2))
+        .force('collide', d3.forceCollide(40));
+
+    const link = g.append('g').selectAll('line').data(links).enter().append('line')
+        .attr('class', 'link').attr('marker-end', 'url(#arrow)');
+
+    const node = g.append('g').selectAll('g').data(nodes).enter().append('g')
+        .attr('class', (d) => `node ${d.kind}`)
+        .call(d3.drag()
+            .on('start', (event, d) => {
+                if (!event.active) simulation.alphaTarget(0.3).restart();
+                d.fx = d.x; d.fy = d.y;
+            })
+            .on('drag', (event, d) => { d.fx = event.x; d.fy = event.y; })
+            .on('end', (event, d) => {
+                if (!event.active) simulation.alphaTarget(0);
+                d.fx = null; d.fy = null;
+            }));
+
+    node.append('circle').attr('r', 16).attr('fill', (d) => COLORS[d.kind] || '#fff');
+    node.append('text').attr('y', -22).attr('text-anchor', 'middle')
+        .text((d) => (d.label.length > 28 ? `${d.label.slice(0, 27)}…` : d.label));
+    node.on('click', (event, d) => select(d));
+
+    simulation.on('tick', () => {
+        link.attr('x1', (d) => d.source.x).attr('y1', (d) => d.source.y)
+            .attr('x2', (d) => d.target.x).attr('y2', (d) => d.target.y);
+        node.attr('transform', (d) => `translate(${d.x},${d.y})`);
+    });
+
+    function lineage(gid) {
+        const seen = new Set([gid]);
+        const stack = [gid];
+        while (stack.length) {
+            for (const p of parents.get(stack.pop())) {
+                if (!seen.has(p)) { seen.add(p); stack.push(p); }
+            }
+        }
+        return seen;
+    }
+
+    function select(d) {
+        const keep = lineage(d.gid);
+        node.classed('dimmed', (n) => !keep.has(n.gid));
+        link.classed('dimmed', (l) => !(keep.has(l.source.gid) && keep.has(l.target.gid)));
+        showDetails(d);
+    }
+
+    const list = document.getElementById('outputs');
+    data.outputs.forEach((out) => {
+        const item = el('li');
+        item.append(el('code', out.key), el('span', ` = ${out.value}`, out.node === null ? 'muted' : ''));
+        item.addEventListener('click', () => select(nodes.find((n) => n.gid === `o:${out.key}`)));
+        list.append(item);
+    });
+}
+
+function showDetails(d) {
+    document.getElementById('details').classList.remove('hidden');
+    document.getElementById('details-title').textContent = d.kind === 'output' ? d.output.key : d.label;
+    const rows = d.kind === 'output'
+        ? [
+            ['value', d.output.value],
+            ['computed as', d.output.expression ?? 'not linked to any traced input'],
+            ['from inputs', d.output.sources.join(', ') || '—'],
+        ]
+        : [['kind', d.kind], ['operation', d.op], ['value', d.value], ['node', `#${d.id}`]];
+    if (d.key) rows.push(['key', d.key]);
+    Object.entries(d.meta || {}).forEach(([k, v]) => rows.push([k, v]));
+
+    const dl = document.getElementById('details-list');
+    dl.replaceChildren();
+    rows.forEach(([term, value]) => dl.append(el('dt', term), el('dd', String(value))));
+}

redroot/visualizer/web/static/index.html

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>RedRoot Trace Viewer</title>
+    <link rel="stylesheet" href="style.css">
+    <script src="https://cdn.jsdelivr.net/npm/d3@7.9.0/dist/d3.min.js"></script>
+</head>
+<body>
+    <div id="container">
+        <aside id="sidebar">
+            <h1 class="logo">RedRoot</h1>
+            <p id="trace-name" class="muted"></p>
+            <div id="stats">
+                <span><b id="node-count">0</b> nodes</span>
+                <span><b id="guard-count">0</b> guards</span>
+                <span><b id="output-count">0</b> outputs</span>
+            </div>
+            <ul class="legend">
+                <li><span class="swatch leaf"></span>input</li>
+                <li><span class="swatch op"></span>operation</li>
+                <li><span class="swatch guard"></span>guard</li>
+                <li><span class="swatch output"></span>output</li>
+            </ul>
+            <section id="details" class="hidden">
+                <h2 id="details-title"></h2>
+                <dl id="details-list"></dl>
+            </section>
+            <h2>Outputs</h2>
+            <p class="muted">Click an output to highlight the inputs it was computed from.</p>
+            <ul id="outputs"></ul>
+        </aside>
+        <main id="graph"></main>
+    </div>
+    <script src="app.js"></script>
+</body>
+</html>

redroot/visualizer/web/static/style.css

@@ -0,0 +1,49 @@
+body, html {
+    margin: 0;
+    height: 100%;
+    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+    background: #fafafa;
+    color: #222;
+}
+
+#container { display: flex; height: 100%; }
+
+#sidebar {
+    width: 340px;
+    padding: 20px;
+    overflow-y: auto;
+    background: #fff;
+    border-right: 1px solid #ddd;
+    box-sizing: border-box;
+}
+
+#graph { flex: 1; overflow: hidden; }
+
+.logo { color: #e53935; margin: 0; }
+.muted { color: #777; font-size: 0.85em; }
+h2 { font-size: 1em; margin: 18px 0 6px; }
+
+#stats { display: flex; gap: 12px; font-size: 0.9em; color: #555; }
+
+.legend { list-style: none; padding: 0; display: flex; flex-wrap: wrap; gap: 10px; font-size: 0.8em; }
+.swatch { display: inline-block; width: 10px; height: 10px; border: 1px solid #555; border-radius: 50%; margin-right: 4px; }
+.swatch.leaf { background: #e1f5fe; }
+.swatch.op { background: #fff; }
+.swatch.guard { background: #fff3e0; border-style: dashed; border-color: #ef6c00; }
+.swatch.output { background: #e8f5e9; }
+
+#details { background: #f1f3f4; border-radius: 8px; padding: 10px 14px; }
+#details.hidden { display: none; }
+#details dl { margin: 0; }
+#details dt { font-weight: 600; font-size: 0.8em; color: #555; margin-top: 6px; }
+#details dd { margin: 0; font-family: monospace; word-break: break-word; }
+
+#outputs { list-style: none; padding: 0; font-size: 0.85em; }
+#outputs li { padding: 4px 6px; border-radius: 4px; cursor: pointer; word-break: break-word; }
+#outputs li:hover { background: #f1f3f4; }
+
+.link { stroke: #999; stroke-opacity: 0.6; stroke-width: 1.5; }
+.node circle { stroke: #333; stroke-width: 1.5; cursor: pointer; }
+.node.guard circle { stroke: #ef6c00; stroke-dasharray: 3 2; }
+.node text { font-size: 10px; fill: #444; pointer-events: none; }
+.dimmed { opacity: 0.15; }

redroot-0.2.0.dist-info/METADATA

@@ -0,0 +1,309 @@
+Metadata-Version: 2.5
+Name: redroot
+Version: 0.2.0
+Summary: Value-level lineage for Python: trace where every output came from, and propagate input edits to every output without re-running
+Project-URL: Homepage, https://github.com/gagan-gaurav/redthread
+Project-URL: Documentation, https://github.com/gagan-gaurav/redthread#readme
+Project-URL: Repository, https://github.com/gagan-gaurav/redthread
+Project-URL: Issues, https://github.com/gagan-gaurav/redthread/issues
+Project-URL: Changelog, https://github.com/gagan-gaurav/redthread/blob/main/CHANGELOG.md
+Author: Gagan Gaurav
+License-Expression: MIT
+License-File: LICENSE
+Keywords: audit,dag,data-engineering,data-provenance,incremental-computation,lineage,llm,provenance,pydantic,tracing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: all
+Requires-Dist: flask>=3.0; extra == 'all'
+Requires-Dist: graphviz>=0.20; extra == 'all'
+Requires-Dist: networkx>=3.0; extra == 'all'
+Requires-Dist: pydantic>=2.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: hypothesis>=6.100; extra == 'dev'
+Requires-Dist: mypy==2.3.1; extra == 'dev'
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff==0.16.10; extra == 'dev'
+Provides-Extra: pydantic
+Requires-Dist: pydantic>=2.0; extra == 'pydantic'
+Provides-Extra: viz
+Requires-Dist: graphviz>=0.20; extra == 'viz'
+Requires-Dist: networkx>=3.0; extra == 'viz'
+Provides-Extra: web
+Requires-Dist: flask>=3.0; extra == 'web'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# <img width="128" height="128" alt="RedRoot logo" src="https://github.com/user-attachments/assets/82d895e5-a7ba-447e-a3dc-dfeb36c4c1dd" /> RedRoot
+### Trace Every Value to Its Roots
+
+[![CI](https://github.com/gagan-gaurav/redthread/actions/workflows/ci.yml/badge.svg)](https://github.com/gagan-gaurav/redthread/actions/workflows/ci.yml)
+[![PyPI Version](https://img.shields.io/pypi/v/redroot?color=red)](https://pypi.org/project/redroot/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/redroot)](https://pypi.org/project/redroot/)
+[![License](https://img.shields.io/pypi/l/redroot)](https://opensource.org/licenses/MIT)
+
+**RedRoot** records how every value in a Python computation was produced, at the level of individual values, so you can ask, in both directions:
+
+**Where did this output come from?** &nbsp;·&nbsp; **What does every output become if this input changes?**
+
+</div>
+
+---
+
+Run a computation once under RedRoot and you get a graph from inputs to outputs. Click a number that looks wrong and see the exact inputs and arithmetic behind it. Correct one input and every output that used it is recomputed from the graph, instantly and together, without running your code again. When the graph cannot be sure (a branch would go the other way, an LLM call would need re-running), RedRoot says so instead of guessing.
+
+```python
+import redroot as rr
+
+
+def workflow(ext):
+    a, b = ext["A"], ext["B"]
+    return {
+        "form1": {"line_12": a + b},
+        "form2": {"line_7": a * b},
+        "table3": {"amount": a},
+        "table4": {"total": b},
+    }
+
+
+trace, _ = rr.run(workflow, {"A": 1200, "B": 300}, input_root="ext")
+
+print(trace.sources("out:form1.line_12"))  # [<Node #0 leaf ext:A=1200>, <Node #1 leaf ext:B=300>]
+print(trace.explain("out:form2.line_7"))  # ext:A * ext:B
+print(trace.dependents("ext:A"))  # ['out:form1.line_12', 'out:form2.line_7', 'out:table3.amount']
+
+result = trace.propagate({"ext:A": 1300})
+for key, change in result.outputs.items():
+    print(key, change.status.value, change.old, "->", change.new)
+# out:form1.line_12 updated 1500 -> 1600
+# out:form2.line_7 updated 360000 -> 390000
+# out:table3.amount updated 1200 -> 1300
+# out:table4.total unchanged 300 -> 300
+```
+
+## Features
+
+- **Drop-in traced values.** `TracedInt`, `TracedFloat`, `TracedDecimal` and `TracedStr` are real `int`/`float`/`Decimal`/`str` instances. Results, types and errors are exactly those of plain Python.
+- **Re-evaluable graph.** Every operand is recorded in order, constants included, so any node can be recomputed, not just read.
+- **Guards.** Comparisons, branches, conversions and lookups are recorded. If an edit would change one, every output is reported `stale` rather than shown with a value that may be wrong.
+- **Semantic keys.** Inputs and outputs are named by their path, e.g. `ext:bank.line_items[3].amount`.
+- **No cooperation needed from the code.** Tracing happens through operator overloading. For code you run from source, such as generated code, `redroot.instrument` closes the remaining gaps.
+- **Re-execution as the arbiter.** Built-in tools compare the graph's answers with a real re-run, and measure coverage on your workloads.
+- **Opaque steps.** `@traced` turns a function (a tax-table lookup, a geocoder) into one re-callable node. `@traced_llm` marks LLM calls as not replayable.
+- **Persistable.** Traces serialize to versioned JSON, ship with a CLI, and come with a web viewer plus GraphViz and NetworkX exports.
+- **Zero dependencies** in the core. Pydantic, visualization and the web viewer are optional extras.
+
+## Installation
+
+```bash
+pip install redroot                  # core, no dependencies
+pip install "redroot[pydantic]"      # traced types as Pydantic fields
+pip install "redroot[viz,web]"       # GraphViz/NetworkX exports and the web viewer
+```
+
+Python 3.10 or newer is required.
+
+## Guide
+
+### Recording a trace
+
+Operations on traced values are recorded while a `Trace` is active. Outside one, traced values behave exactly like plain values and nothing is recorded, so nothing accumulates in long-running processes.
+
+```python
+from decimal import Decimal
+import redroot as rr
+
+extracted = {"bank": {"balance": Decimal("12450.00"), "fee": Decimal("12.50")}, "married": True}
+
+with rr.Trace("run-42") as trace:
+    ext = trace.track(extracted, root="ext")  # traced copy; inputs keyed by path
+    net = ext["bank"]["balance"] - ext["bank"]["fee"] * 12
+    trace.collect({"summary": {"net": net, "year": 2025}}, root="out")
+
+print(list(trace.inputs))  # ['ext:bank.balance', 'ext:bank.fee']
+print(trace.explain("out:summary.net"))  # ext:bank.balance - (ext:bank.fee * 12)
+
+# bool and None cannot be traced; such inputs are listed instead:
+print(dict(trace.untracked_inputs))  # {'ext:married': True}
+
+# 2025 was not computed from any input:
+print(trace.outputs["out:summary.year"].linked)  # False
+```
+
+`rr.run(workflow, inputs, input_root=..., output_root=...)` does the `track`, call and `collect` steps for you.
+
+### Navigating backwards and forwards
+
+| Question | Call |
+|---|---|
+| Which inputs produced this output? | `trace.sources("out:form1.line_12")` |
+| Show me the computation. | `trace.explain("out:form1.line_12")` |
+| Which outputs use this input? | `trace.dependents("ext:A")` |
+| Every node involved | `trace.ancestors(...)`, `trace.descendants(...)` |
+
+### Propagating an edit
+
+`trace.propagate(edits)` re-evaluates only the nodes downstream of the edited inputs and reports, for every output:
+
+| Status | Meaning |
+|---|---|
+| `UPDATED` | New value, computed exactly from the graph. |
+| `UNCHANGED` | The edit does not affect this output. |
+| `STALE` | The graph cannot be sure. Re-execute to get the value. |
+| `UNLINKED` | The output is not linked to any traced input. |
+
+The graph is only trusted while execution would follow the same path. Branches are the case a pure graph gets wrong:
+
+```python
+def guarded(ext):
+    a, b = ext["A"], ext["B"]
+    line_12 = a + b if a > 1000 else 0
+    return {"line_12": line_12, "other": b * 2}
+
+
+trace, _ = rr.run(guarded, {"A": 1200, "B": 300}, input_root="ext")
+
+print(trace.propagate({"ext:A": 1100}).exact)  # True
+
+result = trace.propagate({"ext:A": 800})  # A > 1000 no longer holds
+print(result.exact)  # False
+print(result.reasons[0].message)  # ext:A > 1000 was True, now False
+print(result.outputs["out:other"].status.value)  # stale
+```
+
+When a guard flips, *every* output is reported stale, not just those computed under the branch. A trace only records the path that ran: writes on the other path are invisible to it, so no output can be vouched for. See [docs/design.md](docs/design.md#why-a-flipped-guard-makes-every-output-stale).
+
+Exceptions count as branches too: an operation that raised (and was caught) is recorded with its outcome, so an edit that makes it stop raising flips it. Other reasons for re-execution include an edit to an untracked input, a value that changes type, an operation that would now raise, and an input change reaching a non-replayable step. Each is reported in `result.reasons`.
+
+### Verifying with re-execution
+
+Re-execution on the edited inputs is the source of truth. The graph is the instant path.
+
+```python
+inputs = {"A": 1200, "B": 300}
+edits = {"ext:A": 1100}
+trace, _ = rr.run(guarded, inputs, input_root="ext")
+result = trace.propagate(edits)
+
+retrace, _ = rr.run(guarded, rr.apply_edits(inputs, edits, root="ext"), input_root="ext")
+assert result.verify(retrace.output_values()).ok
+```
+
+A mismatch on an output the graph claimed to know is a tracing gap. `redroot.validation.check_perturbation` runs this experiment in one call.
+
+### Lookups, external services and LLM calls
+
+Decorate a step to record each call as one node. Deterministic functions are re-called during propagation; the others keep their recorded result until their inputs change.
+
+```python
+@rr.traced(name="irs.national_standard")
+def national_standard(household_size: int) -> Decimal:
+    return {1: Decimal("785"), 2: Decimal("1410"), 3: Decimal("1617")}[household_size]
+
+
+@rr.traced(name="geo.county", deterministic=False)  # e.g. a web lookup
+def county_for_zip(zip_code: str) -> str:
+    return "Travis"
+
+
+@rr.traced_llm(model="gpt-4o", task="summarize")
+def summarize(text: str) -> str:
+    rr.annotate(prompt_tokens=len(text) // 4)  # stored on the node
+    return text[:40]
+
+
+with rr.Trace() as trace:
+    size = trace.leaf(3, "ext:household_size")
+    trace.output("out:allowance", national_standard(size) * 12)
+
+print(trace.propagate({"ext:household_size": 2}).outputs["out:allowance"].new)  # 16920
+```
+
+For results computed elsewhere, `rr.derive(value, inputs, "op-name")` records the link manually.
+
+### Running generated or untrusted-shape code: instrumentation
+
+Operator overloading cannot see everything. CPython computes `0.8 * income` (a plain `float` times a traced `int`), `float(text)`, `", ".join(parts)` and `sorted([income, 20000.5])` in C, without consulting the traced value, so those results would lose their lineage. For code you execute from source, `exec_source` rewrites the syntax tree first (as pytest does for `assert`) and closes these gaps. Calls into code it cannot see into (`date.fromisoformat`, `json.dumps`, third-party libraries) that consume traced values but return none are guarded, so editing their inputs requires re-execution rather than producing a stale value:
+
+```python
+from redroot.instrument import exec_source
+
+generated = """
+def main(ext):
+    gross = float(ext["gross"].replace(",", ""))
+    return {"net": 0.8 * gross, "label": f"{gross:,.2f} USD"}
+"""
+namespace = exec_source(generated)
+trace, _ = rr.run(namespace["main"], {"gross": "5,200.50"}, input_root="ext")
+print(trace.explain("out:net"))  # 0.8 * float(ext:gross.replace(',', ''))
+```
+
+Instrumented code behaves exactly like the original. `exec_source` executes the code it is given: only use it on code you would run anyway.
+
+### Saving, inspecting and viewing traces
+
+```python
+data = trace.to_json()  # versioned format; store it with the run
+restored = rr.Trace.from_json(data)
+print(restored.propagate({"ext:gross": "6,000"}).outputs["out:net"].new)  # 4800.0
+```
+
+```bash
+redroot explain trace.json out:summary.net   # expression and source inputs
+redroot coverage trace.json                  # coverage report + re-evaluation check
+redroot visualize trace.json                 # web viewer (needs redroot[web])
+```
+
+To re-evaluate a loaded trace, the modules defining its `@traced` functions must be imported, since they register those operations.
+
+### Measuring whether tracing covers your workload
+
+Before relying on propagation, measure it on real runs:
+
+```python
+from redroot.validation import check_identity, check_perturbation, coverage
+
+# Linked and replayable outputs, guards, and the inputs that feed guards:
+print(coverage(trace))
+assert check_identity(trace).ok  # every node re-evaluates to its recorded value
+report = check_perturbation(guarded, {"A": 1200, "B": 300}, {"ext:A": 1100}, input_root="ext")
+assert report.consistent  # graph agrees with re-execution wherever it claimed to know
+```
+
+### Pydantic
+
+With `redroot[pydantic]`, traced types work as model fields. Traced values pass through validation with their lineage, plain values become inputs, and models serialize to plain values.
+
+## How it works
+
+Traced types subclass the builtins and override their operators. Each operation computes its result with the same function the graph later uses to re-evaluate it, so recomputation reproduces execution exactly. Results that leave tracking (a `bool` from a comparison, an `int()` conversion, a hash) are recorded as *guards*. Propagation re-checks guards, and any change means execution could have diverged. Details, guarantees and limits are in [docs/design.md](docs/design.md). For an end-to-end review workflow (record, review, edit, verify), see [docs/integration.md](docs/integration.md).
+
+Overhead is about 0.7 µs per traced operation (0.9 µs for `Decimal`) and about 240 bytes per recorded node (`python benchmarks/overhead.py`).
+
+## Limitations
+
+- Only `int`, `float`, `Decimal` and `str` are traced. `bool` and `None` inputs are recorded as untracked: editing them requires re-execution.
+- Without instrumentation, a few C-level operations lose lineage (see above). `redroot.validation` finds them. [docs/design.md](docs/design.md#what-remains-invisible) lists what remains invisible even with it.
+- Lineage does not cross threads unless the context is propagated (`contextvars.copy_context()`), nor processes, nor `pickle`.
+- `type(x) is float` is `False` for traced values (instrumented code is unaffected).
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md), and [AGENTS.md](AGENTS.md) for the architecture's invariants.
+
+## License
+
+MIT. See [LICENSE](LICENSE).