notebooks/PICS/ChangeCounter-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 12.2.1 (20241206.2353)
 -->
<!-- Pages: 1 -->
<svg width="414pt" height="329pt"
 viewBox="0.00 0.00 413.75 329.25" 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 325.25)">
<g id="a_graph0"><a xlink:title="FineChangeCounter class hierarchy">
<polygon fill="white" stroke="none" points="-4,4 -4,-325.25 409.75,-325.25 409.75,4 -4,4"/>
</a>
</g>
<!-- FineChangeCounter -->
<g id="node1" class="node">
<title>FineChangeCounter</title>
<g id="a_node1"><a xlink:href="#" xlink:title="class FineChangeCounter:&#10;Count the changes for files in the repository and their elements">
<polygon fill="none" stroke="black" points="0,-13.25 0,-59.25 144.25,-59.25 144.25,-13.25 0,-13.25"/>
<text text-anchor="start" x="8" y="-42.95" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">FineChangeCounter</text>
<polyline fill="none" stroke="black" points="0,-34 144.25,-34"/>
<g id="a_node1_0"><a xlink:href="#" xlink:title="FineChangeCounter">
<g id="a_node1_1"><a xlink:href="#" xlink:title="update_elems(self, node: Tuple, m: pydriller.domain.commit.ModifiedFile) &#45;&gt; None:&#10;Update counters for subelements of `node` with modification `m`.&#10;To be defined in subclasses.">
<text text-anchor="start" x="30.12" y="-21.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">update_elems()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- ChangeCounter -->
<g id="node2" class="node">
<title>ChangeCounter</title>
<g id="a_node2"><a xlink:href="#" xlink:title="class ChangeCounter:&#10;Count the number of changes for a repository.">
<polygon fill="none" stroke="black" points="84.88,-109 84.88,-320.75 201.38,-320.75 201.38,-109 84.88,-109"/>
<text text-anchor="start" x="92.88" y="-304.45" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">ChangeCounter</text>
<polyline fill="none" stroke="black" points="84.88,-295.5 201.38,-295.5"/>
<g id="a_node2_2"><a xlink:href="#" xlink:title="ChangeCounter">
<g id="a_node2_3"><a xlink:href="#" xlink:title="__init__(self, repo: str, *, filter: Optional[Callable[[pydriller.domain.commit.Commit], bool]] = None, log: bool = False, **kwargs: Any) &#45;&gt; None:&#10;Constructor.&#10;`repo` is a git repository (as URL or directory).&#10;`filter` is a predicate that takes a modification and returns True&#10;if it should be considered (default: consider all).&#10;`log` turns on logging if set.&#10;`kwargs` are passed to the `Repository()` constructor.">
<text text-anchor="start" x="95.12" y="-283" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">__init__()</text>
</a>
</g>
<g id="a_node2_4"><a xlink:href="#" xlink:title="map(self) &#45;&gt; plotly.graph_objs._figure.Figure:&#10;Produce an interactive tree map of the repository.">
<text text-anchor="start" x="95.12" y="-270.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00">map()</text>
</a>
</g>
<g id="a_node2_5"><a xlink:href="#" xlink:title="include(self, m: pydriller.domain.commit.ModifiedFile) &#45;&gt; bool:&#10;Return True if the modification `m` should be included&#10;(default: the `filter` predicate given to the constructor).&#10;To be overloaded in subclasses.">
<text text-anchor="start" x="95.12" y="-257.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">include()</text>
</a>
</g>
<g id="a_node2_6"><a xlink:href="#" xlink:title="map_colorscale(self) &#45;&gt; str:&#10;Return the colorscale for the map. To be overloaded in subclasses.">
<text text-anchor="start" x="95.12" y="-244.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">map_colorscale()</text>
</a>
</g>
<g id="a_node2_7"><a xlink:href="#" xlink:title="map_hoverinfo(self) &#45;&gt; str:&#10;Return the text to be shown when hovering over a node.&#10;To be overloaded in subclasses.">
<text text-anchor="start" x="95.12" y="-232" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">map_hoverinfo()</text>
</a>
</g>
<g id="a_node2_8"><a xlink:href="#" xlink:title="map_node_color(self, node: Tuple) &#45;&gt; Optional[int]:&#10;Return a color of the node, as a number.&#10;Can be overloaded in subclasses.">
<text text-anchor="start" x="95.12" y="-219.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">map_node_color()</text>
</a>
</g>
<g id="a_node2_9"><a xlink:href="#" xlink:title="map_node_sizes(self, scale: str = &#39;log&#39;) &#45;&gt; Dict[Tuple, Union[int, float]]:&#10;Return a mapping of nodes to sizes.&#10;Can be overloaded in subclasses.">
<text text-anchor="start" x="95.12" y="-206.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">map_node_sizes()</text>
</a>
</g>
<g id="a_node2_10"><a xlink:href="#" xlink:title="map_node_text(self, node: Tuple) &#45;&gt; Optional[str]:&#10;Return the text to be shown for the node (default: #changes).&#10;Can be overloaded in subclasses.">
<text text-anchor="start" x="95.12" y="-193.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">map_node_text()</text>
</a>
</g>
<g id="a_node2_11"><a xlink:href="#" xlink:title="mine(self, **kwargs: Any) &#45;&gt; None:&#10;Gather data from repository. To be extended in subclasses.">
<text text-anchor="start" x="95.12" y="-181" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">mine()</text>
</a>
</g>
<g id="a_node2_12"><a xlink:href="#" xlink:title="mine_commit(self, commit: pydriller.domain.commit.Commit) &#45;&gt; None">
<text text-anchor="start" x="95.12" y="-167.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="10.00">mine_commit()</text>
</a>
</g>
<g id="a_node2_13"><a xlink:href="#" xlink:title="update_changes(self, node: Tuple, commit_msg: str) &#45;&gt; None:&#10;Update stats for `node` changed with `commit_msg`.&#10;Can be extended in subclasses.">
<text text-anchor="start" x="95.12" y="-155.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">update_changes()</text>
</a>
</g>
<g id="a_node2_14"><a xlink:href="#" xlink:title="update_elems(self, node: Tuple, m: pydriller.domain.commit.ModifiedFile) &#45;&gt; None:&#10;Update counters for subelements of `node` with modification `m`.&#10;To be defined in subclasses.">
<text text-anchor="start" x="95.12" y="-142.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">update_elems()</text>
</a>
</g>
<g id="a_node2_15"><a xlink:href="#" xlink:title="update_size(self, node: Tuple, size: int) &#45;&gt; None:&#10;Update counters for `node` with `size`.&#10;Can be extended in subclasses.">
<text text-anchor="start" x="95.12" y="-130" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">update_size()</text>
</a>
</g>
<g id="a_node2_16"><a xlink:href="#" xlink:title="update_stats(self, m: pydriller.domain.commit.ModifiedFile) &#45;&gt; None:&#10;Update counters with modification `m`.&#10;Can be extended in subclasses.">
<text text-anchor="start" x="95.12" y="-117.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">update_stats()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- FineChangeCounter&#45;&gt;ChangeCounter -->
<g id="edge1" class="edge">
<title>FineChangeCounter&#45;&gt;ChangeCounter</title>
<path fill="none" stroke="black" d="M81.12,-59.62C85.39,-70.25 90.86,-83.85 96.77,-98.56"/>
<polygon fill="none" stroke="black" points="93.38,-99.51 100.36,-107.48 99.88,-96.9 93.38,-99.51"/>
</g>
<!-- FixCounter -->
<g id="node3" class="node">
<title>FixCounter</title>
<g id="a_node3"><a xlink:href="#" xlink:title="class FixCounter:&#10;Count the fixes for files in the repository.&#10;Fixes are all commits whose message starts with the word &#39;Fix: &#39;">
<polygon fill="none" stroke="black" points="162.12,-0.5 162.12,-72 268.12,-72 268.12,-0.5 162.12,-0.5"/>
<text text-anchor="start" x="181" y="-55.7" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">FixCounter</text>
<polyline fill="none" stroke="black" points="162.12,-46.75 268.12,-46.75"/>
<g id="a_node3_17"><a xlink:href="#" xlink:title="FixCounter">
<g id="a_node3_18"><a xlink:href="#" xlink:title="include(self, m: pydriller.domain.commit.ModifiedFile) &#45;&gt; bool:&#10;Include all modifications whose commit messages start with &#39;Fix:&#39;">
<text text-anchor="start" x="170.12" y="-34.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">include()</text>
</a>
</g>
<g id="a_node3_19"><a xlink:href="#" xlink:title="map_hoverinfo(self) &#45;&gt; str:&#10;Return the text to be shown when hovering over a node.&#10;To be overloaded in subclasses.">
<text text-anchor="start" x="170.12" y="-21.5" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">map_hoverinfo()</text>
</a>
</g>
<g id="a_node3_20"><a xlink:href="#" xlink:title="map_node_text(self, node: Tuple) &#45;&gt; str:&#10;Return the text to be shown for the node (default: #changes).&#10;Can be overloaded in subclasses.">
<text text-anchor="start" x="170.12" y="-8.75" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00">map_node_text()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- FixCounter&#45;&gt;ChangeCounter -->
<g id="edge2" class="edge">
<title>FixCounter&#45;&gt;ChangeCounter</title>
<path fill="none" stroke="black" d="M200.9,-72.15C197.68,-80.03 194.1,-88.83 190.33,-98.08"/>
<polygon fill="none" stroke="black" points="187.11,-96.7 186.58,-107.28 193.59,-99.34 187.11,-96.7"/>
</g>
<!-- Legend -->
<g id="node4" class="node">
<title>Legend</title>
<text text-anchor="start" x="286.5" y="-52.25" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="10.00" fill="#6a0dad">Legend</text>
<text text-anchor="start" x="286.5" y="-42.25" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="292.5" y="-42.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="8.00">public_method()</text>
<text text-anchor="start" x="286.5" y="-32.25" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="292.5" y="-32.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="8.00">private_method()</text>
<text text-anchor="start" x="286.5" y="-22.25" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00">• </text>
<text text-anchor="start" x="292.5" y="-22.25" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="8.00">overloaded_method()</text>
<text text-anchor="start" x="286.5" y="-13.2" font-family="Helvetica,sans-Serif" font-size="9.00">Hover over names to see doc</text>
</g>
</g>
</svg>