notebooks/PICS/Tracer-synopsis-1.svg

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
 "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.0.2 (20221119.0110)
 -->
<!-- Pages: 1 -->
<svg width="287pt" height="420pt"
 viewBox="0.00 0.00 286.50 420.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 416)">
<g id="a_graph0"><a xlink:title="EventTracer class hierarchy">
<polygon fill="white" stroke="none" points="-4,4 -4,-416 282.5,-416 282.5,4 -4,4"/>
</a>
</g>
<!-- EventTracer -->
<g id="node1" class="node">
<title>EventTracer</title>
<g id="a_node1"><a xlink:href="#" xlink:title="class EventTracer:&#10;Log when a given event expression changes its value">
<polygon fill="none" stroke="black" points="27,-0.5 27,-64.5 140,-64.5 140,-0.5 27,-0.5"/>
<text text-anchor="start" x="47" y="-50.3" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">EventTracer</text>
<polyline fill="none" stroke="black" points="27,-41.5 140,-41.5"/>
<g id="a_node1_0"><a xlink:href="#" xlink:title="EventTracer">
<g id="a_node1_1"><a xlink:href="#" xlink:title="__init__(self, *, condition: Optional[str] = None, events: List[str] = [], file: &lt;class &#39;TextIO&#39;&gt; = &lt;ipykernel.iostream.OutStream object&gt;) &#45;&gt; None:&#10;Constructor. `events` is a list of expressions to watch.">
<text text-anchor="start" x="35.5" y="-30" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">__init__()</text>
</a>
</g>
<g id="a_node1_2"><a xlink:href="#" xlink:title="do_report(self, frame: frame, event: str, arg: Any) &#45;&gt; bool:&#10;Return True if a line should be shown">
<text text-anchor="start" x="35.5" y="-19" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">do_report()</text>
</a>
</g>
<g id="a_node1_3"><a xlink:href="#" xlink:title="events_changed(self, events: List[str], frame: frame) &#45;&gt; bool:&#10;Return True if any of the observed `events` has changed">
<text text-anchor="start" x="35.5" y="-7" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="10.00">events_changed()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- ConditionalTracer -->
<g id="node2" class="node">
<title>ConditionalTracer</title>
<g id="a_node2"><a xlink:href="#" xlink:title="class ConditionalTracer:&#10;A class for tracing a piece of code. Use as `with Tracer(): block()`">
<polygon fill="none" stroke="black" points="19.5,-101.5 19.5,-176.5 147.5,-176.5 147.5,-101.5 19.5,-101.5"/>
<text text-anchor="start" x="27.5" y="-162.3" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">ConditionalTracer</text>
<polyline fill="none" stroke="black" points="19.5,-153.5 147.5,-153.5"/>
<g id="a_node2_4"><a xlink:href="#" xlink:title="ConditionalTracer">
<g id="a_node2_5"><a xlink:href="#" xlink:title="__init__(self, *, condition: Optional[str] = None, file: &lt;class &#39;TextIO&#39;&gt; = &lt;ipykernel.iostream.OutStream object&gt;) &#45;&gt; None:&#10;Constructor. Trace all events for which `condition` (a Python expr) holds.">
<text text-anchor="start" x="32.5" y="-142.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">__init__()</text>
</a>
</g>
<g id="a_node2_6"><a xlink:href="#" xlink:title="do_report(self, frame: frame, event: str, arg: Any) &#45;&gt; Optional[bool]">
<text text-anchor="start" x="32.5" y="-131.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">do_report()</text>
</a>
</g>
<g id="a_node2_7"><a xlink:href="#" xlink:title="eval_in_context(self, expr: str, frame: frame) &#45;&gt; Any">
<text text-anchor="start" x="32.5" y="-119.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="10.00">eval_in_context()</text>
</a>
</g>
<g id="a_node2_8"><a xlink:href="#" xlink:title="traceit(self, frame: frame, event: str, arg: Any) &#45;&gt; None:&#10;Tracing function; called at every line. To be overloaded in subclasses.">
<text text-anchor="start" x="32.5" y="-109.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">traceit()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- EventTracer&#45;&gt;ConditionalTracer -->
<g id="edge1" class="edge">
<title>EventTracer&#45;&gt;ConditionalTracer</title>
<path fill="none" stroke="black" d="M83.5,-64.29C83.5,-72.41 83.5,-81.37 83.5,-90.16"/>
<polygon fill="none" stroke="black" points="80,-90.02 83.5,-100.02 87,-90.02 80,-90.02"/>
</g>
<!-- Tracer -->
<g id="node3" class="node">
<title>Tracer</title>
<g id="a_node3"><a xlink:href="#" xlink:title="class Tracer:&#10;A class for tracing a piece of code. Use as `with Tracer(): block()`">
<polygon fill="none" stroke="black" points="6,-213.5 6,-332.5 161,-332.5 161,-213.5 6,-213.5"/>
<text text-anchor="start" x="63.5" y="-318.3" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">Tracer</text>
<polyline fill="none" stroke="black" points="6,-309.5 161,-309.5"/>
<g id="a_node3_9"><a xlink:href="#" xlink:title="Tracer">
<g id="a_node3_10"><a xlink:href="#" xlink:title="__enter__(self) &#45;&gt; Any:&#10;Called at begin of `with` block. Turn tracing on.">
<text text-anchor="start" x="14.5" y="-298.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">__enter__()</text>
</a>
</g>
<g id="a_node3_11"><a xlink:href="#" xlink:title="__exit__(self, exc_tp: Type, exc_value: BaseException, exc_traceback: traceback) &#45;&gt; Optional[bool]:&#10;Called at end of `with` block. Turn tracing off.&#10;Return `None` if ok, not `None` if internal error.">
<text text-anchor="start" x="14.5" y="-287.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">__exit__()</text>
</a>
</g>
<g id="a_node3_12"><a xlink:href="#" xlink:title="__init__(self, file: &lt;class &#39;TextIO&#39;&gt; = &lt;ipykernel.iostream.OutStream object&gt;) &#45;&gt; None:&#10;Create a new tracer.&#10;If `file` is given, output to `file` instead of stdout.">
<text text-anchor="start" x="14.5" y="-276.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">__init__()</text>
</a>
</g>
<g id="a_node3_13"><a xlink:href="#" xlink:title="changed_vars(self, new_vars: Dict[str, Any]) &#45;&gt; Dict[str, Any]:&#10;Track changed variables, based on `new_vars` observed.">
<text text-anchor="start" x="14.5" y="-265.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">changed_vars()</text>
</a>
</g>
<g id="a_node3_14"><a xlink:href="#" xlink:title="print_debugger_status(self, frame: frame, event: str, arg: Any) &#45;&gt; None:&#10;Show current source line and changed vars">
<text text-anchor="start" x="14.5" y="-254.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">print_debugger_status()</text>
</a>
</g>
<g id="a_node3_15"><a xlink:href="#" xlink:title="_traceit(self, frame: frame, event: str, arg: Any) &#45;&gt; Optional[Callable]:&#10;Internal tracing function.">
<text text-anchor="start" x="14.5" y="-242.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="10.00">_traceit()</text>
</a>
</g>
<g id="a_node3_16"><a xlink:href="#" xlink:title="log(self, *objects: Any, sep: str = &#39; &#39;, end: str = &#39;\n&#39;, flush: bool = True) &#45;&gt; None:&#10;Like `print()`, but always sending to `file` given at initialization,&#10;and flushing by default.">
<text text-anchor="start" x="14.5" y="-231.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="10.00">log()</text>
</a>
</g>
<g id="a_node3_17"><a xlink:href="#" xlink:title="traceit(self, frame: frame, event: str, arg: Any) &#45;&gt; None:&#10;Tracing function; called at every line. To be overloaded in subclasses.">
<text text-anchor="start" x="14.5" y="-221.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">traceit()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- ConditionalTracer&#45;&gt;Tracer -->
<g id="edge2" class="edge">
<title>ConditionalTracer&#45;&gt;Tracer</title>
<path fill="none" stroke="black" d="M83.5,-176.42C83.5,-184.52 83.5,-193.37 83.5,-202.32"/>
<polygon fill="none" stroke="black" points="80,-202.13 83.5,-212.13 87,-202.13 80,-202.13"/>
</g>
<!-- StackInspector -->
<g id="node4" class="node">
<title>StackInspector</title>
<g id="a_node4"><a xlink:href="StackInspector.ipynb" xlink:title="class StackInspector:&#10;Provide functions to inspect the stack">
<polygon fill="none" stroke="black" points="0,-369.5 0,-411.5 167,-411.5 167,-369.5 0,-369.5"/>
<text text-anchor="start" x="36.5" y="-397.3" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">StackInspector</text>
<polyline fill="none" stroke="black" points="0,-388.5 167,-388.5"/>
<g id="a_node4_18"><a xlink:href="#" xlink:title="StackInspector">
<g id="a_node4_19"><a xlink:href="StackInspector.ipynb" xlink:title="_generated_function_cache = {}">
<text text-anchor="start" x="8.5" y="-376" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="10.00">_generated_function_cache</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- Tracer&#45;&gt;StackInspector -->
<g id="edge3" class="edge">
<title>Tracer&#45;&gt;StackInspector</title>
<path fill="none" stroke="black" d="M83.5,-332.43C83.5,-341.34 83.5,-350.24 83.5,-358.26"/>
<polygon fill="none" stroke="black" points="80,-358.15 83.5,-368.15 87,-358.15 80,-358.15"/>
</g>
<!-- Legend -->
<g id="node5" class="node">
<title>Legend</title>
<text text-anchor="start" x="158.5" y="-50" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="10.00" fill="#6a0dad">Legend</text>
<text text-anchor="start" x="158.5" y="-40" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="165.5" y="-40" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="8.00">public_method()</text>
<text text-anchor="start" x="158.5" y="-30" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="165.5" y="-30" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="8.00">private_method()</text>
<text text-anchor="start" x="158.5" y="-20" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="165.5" y="-20" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="8.00">overloaded_method()</text>
<text text-anchor="start" x="158.5" y="-10.8" font-family="Helvetica,sans-Serif" font-size="9.00">Hover over names to see doc</text>
</g>
</g>
</svg>