notebooks/PICS/StatisticalDebugger-synopsis-2.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 11.0.0 (20240428.1522)
 -->
<!-- Pages: 1 -->
<svg width="406pt" height="559pt"
 viewBox="0.00 0.00 405.75 559.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 555)">
<g id="a_graph0"><a xlink:title="CoverageCollector class hierarchy">
<polygon fill="white" stroke="none" points="-4,4 -4,-555 401.75,-555 401.75,4 -4,4"/>
</a>
</g>
<!-- CoverageCollector -->
<g id="node1" class="node">
<title>CoverageCollector</title>
<g id="a_node1"><a xlink:href="#" xlink:title="class CoverageCollector:&#10;A class to record covered locations during execution.">
<polygon fill="none" stroke="black" points="126.25,-0.5 126.25,-97.5 260,-97.5 260,-0.5 126.25,-0.5"/>
<text text-anchor="start" x="134.25" y="-81.2" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">CoverageCollector</text>
<polyline fill="none" stroke="black" points="126.25,-72.25 260,-72.25"/>
<g id="a_node1_0"><a xlink:href="#" xlink:title="CoverageCollector">
<g id="a_node1_1"><a xlink:href="#" xlink:title="coverage(self) &#45;&gt; Set[Tuple[Callable, int]]:&#10;Return a set (function, lineno) with all locations covered.">
<text text-anchor="start" x="136.12" y="-59.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">coverage()</text>
</a>
</g>
<g id="a_node1_2"><a xlink:href="#" xlink:title="covered_functions(self) &#45;&gt; Set[Callable]:&#10;Return a set with all functions covered.">
<text text-anchor="start" x="136.12" y="-47" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">covered_functions()</text>
</a>
</g>
<g id="a_node1_3"><a xlink:href="#" xlink:title="events(self) &#45;&gt; Set[Tuple[str, int]]:&#10;Return the set of locations covered.&#10;Each location comes as a pair (`function_name`, `lineno`).">
<text text-anchor="start" x="136.12" y="-34.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">events()</text>
</a>
</g>
<g id="a_node1_4"><a xlink:href="#" xlink:title="__init__(self) &#45;&gt; None:&#10;Constructor.">
<text text-anchor="start" x="136.12" y="-21.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">__init__()</text>
</a>
</g>
<g id="a_node1_5"><a xlink:href="#" xlink:title="collect(self, frame: frame, event: str, arg: Any) &#45;&gt; None:&#10;Save coverage for an observed event.">
<text text-anchor="start" x="136.12" y="-8.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">collect()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- Collector -->
<g id="node2" class="node">
<title>Collector</title>
<g id="a_node2"><a xlink:href="#" xlink:title="class Collector:&#10;A class to record events during execution.">
<polygon fill="none" stroke="black" points="23.12,-134.5 23.12,-346.25 165.12,-346.25 165.12,-134.5 23.12,-134.5"/>
<text text-anchor="start" x="66" y="-329.95" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">Collector</text>
<polyline fill="none" stroke="black" points="23.12,-321 165.12,-321"/>
<g id="a_node2_6"><a xlink:href="#" xlink:title="Collector">
<g id="a_node2_7"><a xlink:href="#" xlink:title="__init__(self) &#45;&gt; None:&#10;Constructor.">
<text text-anchor="start" x="31.12" y="-308.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_8"><a xlink:href="#" xlink:title="__repr__(self) &#45;&gt; str:&#10;Return a string representation of the collector">
<text text-anchor="start" x="31.12" y="-295.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">__repr__()</text>
</a>
</g>
<g id="a_node2_9"><a xlink:href="#" xlink:title="args(self) &#45;&gt; Dict[str, Any]:&#10;Return a dict of argument names and values from the first call">
<text text-anchor="start" x="31.12" y="-283" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">args()</text>
</a>
</g>
<g id="a_node2_10"><a xlink:href="#" xlink:title="argstring(self) &#45;&gt; str:&#10;Return the list of arguments from the first call,&#10;as a printable string">
<text text-anchor="start" x="31.12" y="-270.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">argstring()</text>
</a>
</g>
<g id="a_node2_11"><a xlink:href="#" xlink:title="collect(self, frame: frame, event: str, arg: Any) &#45;&gt; None:&#10;Collector function. To be overloaded in subclasses.">
<text text-anchor="start" x="31.12" y="-257.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">collect()</text>
</a>
</g>
<g id="a_node2_12"><a xlink:href="#" xlink:title="exception(self) &#45;&gt; Optional[Type]:&#10;Return the exception class from the first call,&#10;or None if no exception was raised.">
<text text-anchor="start" x="31.12" y="-244.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">exception()</text>
</a>
</g>
<g id="a_node2_13"><a xlink:href="#" xlink:title="function(self) &#45;&gt; Callable:&#10;Return the function from the first call, as a function object">
<text text-anchor="start" x="31.12" y="-232" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">function()</text>
</a>
</g>
<g id="a_node2_14"><a xlink:href="#" xlink:title="id(self) &#45;&gt; str:&#10;Return an identifier for the collector,&#10;created from the first call">
<text text-anchor="start" x="31.12" y="-219.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">id()</text>
</a>
</g>
<g id="a_node2_15"><a xlink:href="#" xlink:title="__exit__(self, exc_tp: Type, exc_value: BaseException, exc_traceback: traceback) &#45;&gt; Optional[bool]:&#10;Exit the `with` block.">
<text text-anchor="start" x="31.12" y="-206.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">__exit__()</text>
</a>
</g>
<g id="a_node2_16"><a xlink:href="#" xlink:title="add_items_to_ignore(self, items_to_ignore: List[Union[Type, Callable]]) &#45;&gt; None:&#10;Define additional classes and functions to ignore during collection&#10;(typically `Debugger` classes using these collectors).">
<text text-anchor="start" x="31.12" y="-192.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="10.00">add_items_to_ignore()</text>
</a>
</g>
<g id="a_node2_17"><a xlink:href="#" xlink:title="coverage(self) &#45;&gt; Set[Tuple[Callable, int]]:&#10;Return a set (function, lineno) with locations covered.&#10;To be overloaded in subclasses.">
<text text-anchor="start" x="31.12" y="-181" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">coverage()</text>
</a>
</g>
<g id="a_node2_18"><a xlink:href="#" xlink:title="covered_functions(self) &#45;&gt; Set[Callable]:&#10;Set of covered functions. To be overloaded in subclasses.">
<text text-anchor="start" x="31.12" y="-168.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">covered_functions()</text>
</a>
</g>
<g id="a_node2_19"><a xlink:href="#" xlink:title="events(self) &#45;&gt; Set:&#10;Return a collection of events. To be overridden in subclasses.">
<text text-anchor="start" x="31.12" y="-155.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">events()</text>
</a>
</g>
<g id="a_node2_20"><a xlink:href="#" xlink:title="traceit(self, frame: frame, event: str, arg: Any) &#45;&gt; None:&#10;Tracing function.&#10;Saves the first function and calls collect().">
<text text-anchor="start" x="31.12" y="-142.75" 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>
<!-- CoverageCollector&#45;&gt;Collector -->
<g id="edge1" class="edge">
<title>CoverageCollector&#45;&gt;Collector</title>
<path fill="none" stroke="black" d="M168.14,-97.79C163.81,-106.08 159.14,-115 154.33,-124.21"/>
<polygon fill="none" stroke="black" points="151.3,-122.45 149.77,-132.94 157.5,-125.7 151.3,-122.45"/>
</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="61.12,-504.5 61.12,-550.5 227.12,-550.5 227.12,-504.5 61.12,-504.5"/>
<text text-anchor="start" x="97.62" y="-534.2" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">StackInspector</text>
<polyline fill="none" stroke="black" points="61.12,-525.25 227.12,-525.25"/>
<g id="a_node4_21"><a xlink:href="#" xlink:title="StackInspector">
<g id="a_node4_22"><a xlink:href="StackInspector.ipynb" xlink:title="_generated_function_cache = {(&#39;remove_html_markup&#39;, 1): &lt;function remove_html_markup&gt;, (&#39;middle&#39;, 1): &lt;function middle&gt;}">
<text text-anchor="start" x="69.12" y="-511.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="10.00">_generated_function_cache</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- CoverageCollector&#45;&gt;StackInspector -->
<g id="edge4" class="edge">
<title>CoverageCollector&#45;&gt;StackInspector</title>
<path fill="none" stroke="black" d="M194.02,-97.91C194.54,-176.2 191.67,-336.09 164.12,-468 162.38,-476.38 159.77,-485.21 157.02,-493.41"/>
<polygon fill="none" stroke="black" points="153.79,-492.06 153.75,-502.66 160.39,-494.4 153.79,-492.06"/>
</g>
<!-- Tracer -->
<g id="node3" class="node">
<title>Tracer</title>
<g id="a_node3"><a xlink:href="Tracer.ipynb" xlink:title="class Tracer:&#10;A class for tracing a piece of code. Use as `with Tracer(): block()`">
<polygon fill="none" stroke="black" points="55.12,-383.25 55.12,-467.5 155.12,-467.5 155.12,-383.25 55.12,-383.25"/>
<text text-anchor="start" x="85.62" y="-451.2" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">Tracer</text>
<polyline fill="none" stroke="black" points="55.12,-442.25 155.12,-442.25"/>
<g id="a_node3_23"><a xlink:href="#" xlink:title="Tracer">
<g id="a_node3_24"><a xlink:href="Tracer.ipynb" xlink:title="__enter__(self) &#45;&gt; Any:&#10;Called at begin of `with` block. Turn tracing on.">
<text text-anchor="start" x="63.12" y="-429.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">__enter__()</text>
</a>
</g>
<g id="a_node3_25"><a xlink:href="Tracer.ipynb" 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="63.12" y="-417" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">__exit__()</text>
</a>
</g>
<g id="a_node3_26"><a xlink:href="Tracer.ipynb" 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="63.12" y="-404.25" 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_27"><a xlink:href="Tracer.ipynb" 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="63.12" y="-391.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">changed_vars()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- Collector&#45;&gt;Tracer -->
<g id="edge2" class="edge">
<title>Collector&#45;&gt;Tracer</title>
<path fill="none" stroke="black" d="M100.44,-346.5C100.97,-355.17 101.48,-363.67 101.96,-371.69"/>
<polygon fill="none" stroke="black" points="98.46,-371.76 102.55,-381.54 105.44,-371.34 98.46,-371.76"/>
</g>
<!-- Tracer&#45;&gt;StackInspector -->
<g id="edge3" class="edge">
<title>Tracer&#45;&gt;StackInspector</title>
<path fill="none" stroke="black" d="M121.33,-467.97C124.63,-476.46 128.07,-485.29 131.25,-493.44"/>
<polygon fill="none" stroke="black" points="127.94,-494.58 134.83,-502.63 134.46,-492.04 127.94,-494.58"/>
</g>
<!-- ValueCollector -->
<g id="node5" class="node">
<title>ValueCollector</title>
<g id="a_node5"><a xlink:href="#" xlink:title="class ValueCollector:&#10;&quot;A class to collect local variables and their values.">
<polygon fill="none" stroke="black" points="0,-13.25 0,-84.75 108.25,-84.75 108.25,-13.25 0,-13.25"/>
<text text-anchor="start" x="8" y="-68.45" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">ValueCollector</text>
<polyline fill="none" stroke="black" points="0,-59.5 108.25,-59.5"/>
<g id="a_node5_28"><a xlink:href="#" xlink:title="ValueCollector">
<g id="a_node5_29"><a xlink:href="#" xlink:title="__init__(self) &#45;&gt; None:&#10;Constructor.">
<text text-anchor="start" x="24.12" y="-47" 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_node5_30"><a xlink:href="#" xlink:title="events(self) &#45;&gt; Set[str]:&#10;A set of (variable, value) pairs observed">
<text text-anchor="start" x="24.12" y="-34.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-style="italic" font-size="10.00">events()</text>
</a>
</g>
<g id="a_node5_31"><a xlink:href="#" xlink:title="collect(self, frame: frame, event: str, arg: Any) &#45;&gt; None:&#10;Collector function. To be overloaded in subclasses.">
<text text-anchor="start" x="24.12" y="-21.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">collect()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- ValueCollector&#45;&gt;Collector -->
<g id="edge5" class="edge">
<title>ValueCollector&#45;&gt;Collector</title>
<path fill="none" stroke="black" d="M61.55,-85.18C63.93,-96.4 66.69,-109.5 69.6,-123.24"/>
<polygon fill="none" stroke="black" points="66.14,-123.83 71.63,-132.89 72.99,-122.38 66.14,-123.83"/>
</g>
<!-- Legend -->
<g id="node6" class="node">
<title>Legend</title>
<text text-anchor="start" x="278.5" y="-65" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="10.00" fill="#6a0dad">Legend</text>
<text text-anchor="start" x="278.5" y="-55" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="284.5" y="-55" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="8.00">public_method()</text>
<text text-anchor="start" x="278.5" y="-45" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="284.5" y="-45" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="8.00">private_method()</text>
<text text-anchor="start" x="278.5" y="-35" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="284.5" y="-35" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="8.00">overloaded_method()</text>
<text text-anchor="start" x="278.5" y="-25.95" font-family="Helvetica,sans-Serif" font-size="9.00">Hover over names to see doc</text>
</g>
</g>
</svg>