FEAT(plot,.TC): +_no_plot node/edge attribute

Author: ankostis

graphtik/base.py

@@ -362,7 +362,7 @@ class PlotArgs(NamedTuple):
 
     #: who is the caller
     plottable: "Plottable" = None
-    #: what to plot
+    #: what to plot (or the "overlay" when calling :meth:`Plottable.plot()`)
     graph: "nx.Graph" = None
     #: The name of the graph in the dot-file (important for cmaps).
     name: str = None
@@ -390,26 +390,14 @@ def clone_or_merge_graph(self, base_graph) -> "PlotArgs":
         :return:
             the updated plot_args
         """
-        import networkx as nx
 
         if self.graph:
+            import networkx as nx
+
             graph = nx.compose(base_graph, self.graph)
         else:
             graph = base_graph.copy()  # cloned, to freely annotate downstream
 
-        ## Drop any nodes & edges with "_no_plot" attribute
-        #
-        graph.remove_nodes_from(
-            [n for n, no_plot in graph.nodes.data("_no_plot") if no_plot]
-        )
-        graph.remove_edges_from(
-            [
-                (src, dst)
-                for src, dst, no_plot in graph.edges.data("_no_plot")
-                if no_plot
-            ]
-        )
-
         return self._replace(graph=graph)
 
     def with_defaults(self, *args, **kw) -> "PlotArgs":
@@ -501,6 +489,7 @@ def plot(
                 override those derrived from :meth:`_make_op_tooltip()` &
                 :meth:`_make_op_tooltip()`.
               - ``_no_plot``: nodes and/or edges skipped from plotting
+                (see *"Examples:"* section, below)
 
             - "public" attributes: reaching `Graphviz`_ as-is.
 
@@ -593,7 +582,7 @@ def plot(
 
         To generate the **legend**, see :func:`.legend()`.
 
-        **Sample code:**
+        **Examples:**
 
         >>> from graphtik import compose, operation
         >>> from graphtik.modifiers import optional
@@ -619,6 +608,19 @@ def plot(
         <a> [fillcolor=wheat, shape=invhouse, style=filled, tooltip="(int) 1"];
         ...
 
+        You may use the :attr:`PlotArgs.graph` overlay to skip certain nodes (or edges)
+        from the plots:
+
+        >>> import networkx as nx
+
+        >>> g = nx.DiGraph()  # the overlay
+        >>> to_hide = netop.net.find_op_by_name("sub")
+        >>> g.add_node(to_hide, _no_plot=True)
+        >>> dot = netop.plot(graph=g)
+        >>> assert "<sub>" not in str(dot), str(dot)
+
+        .. graphtik::
+
         """
         kw = locals().copy()
 

graphtik/plot.py

@@ -18,7 +18,17 @@
 from contextlib import contextmanager
 from contextvars import ContextVar
 from functools import partial
-from typing import Any, Callable, List, Mapping, NamedTuple, Optional, Tuple, Union
+from typing import (
+    Any,
+    Callable,
+    Collection,
+    List,
+    Mapping,
+    NamedTuple,
+    Optional,
+    Tuple,
+    Union,
+)
 
 import jinja2
 import networkx as nx
@@ -574,6 +584,8 @@ def build_pydot(self, plot_args: PlotArgs) -> pydot.Dot:
         if graph is None:
             raise ValueError("At least `graph` to plot must be given!")
 
+        graph, steps = self._skip_nodes(graph, steps)
+
         kw = style.kw_graph.copy()
         kw.update(
             style.kw_pottable_type.get(
@@ -883,6 +895,25 @@ def _add_legend_icon(self, plot_args: PlotArgs, node_args: NodeArgs):
         if kw_legend and self.style.kw_legend.get("URL"):
             node_args.dot.add_node(pydot.Node(**kw_legend))
 
+    def _skip_nodes(
+        self, graph: nx.Graph, steps: Collection
+    ) -> Tuple[nx.Graph, Collection]:
+        ## Drop any nodes, steps & edges with "_no_plot" attribute.
+        #
+        nodes_to_del = {n for n, no_plot in graph.nodes.data("_no_plot") if no_plot}
+        graph.remove_nodes_from(nodes_to_del)
+        if steps:
+            steps = [s for s in steps if s not in nodes_to_del]
+        graph.remove_edges_from(
+            [
+                (src, dst)
+                for src, dst, no_plot in graph.edges.data("_no_plot")
+                if no_plot
+            ]
+        )
+
+        return graph, steps
+
     def render_pydot(self, dot: pydot.Dot, filename=None, jupyter_render: str = None):
         """
         Render a |pydot.Dot|_ instance with `Graphviz`_ in a file and/or in a matplotlib window.

test/test_plot.py

@@ -14,7 +14,6 @@
 from graphtik import base, compose, network, operation, plot
 from graphtik.modifiers import optional
 from graphtik.netop import NetworkOperation
-from graphtik.network import yield_ops
 from graphtik.plot import (
     Plotter,
     Style,
@@ -407,7 +406,7 @@ def test_plotter_dill():
     dill.dumps(plotter)
 
 
-def func():
+def func(a, b):
     pass
 
 
@@ -452,7 +451,7 @@ def test_node_dot_str0(dot_str_pipeline):
                 <TD BORDER="1" SIDES="b" ALIGN="left" TOOLTIP="FunctionalOperation(name=&#x27;cu:sto:m&#x27;, needs=[&#x27;edge&#x27;, &#x27;digraph: strict&#x27;], provides=[&#x27;&lt;graph&gt;&#x27;], fn=&#x27;func&#x27;)" TARGET=""
                 ><B>OP:</B> <I>cu:sto:m</I></TD>
             </TR><TR>
-                <TD ALIGN="left" TOOLTIP="def func():&#10;    pass" TARGET=""
+                <TD ALIGN="left" TOOLTIP="def func(a, b):&#10;    pass" TARGET=""
                 ><B>FN:</B> test.test_plot.func</TD>
             </TR>
         </TABLE>>, shape=plain, tooltip=<cu:sto:m>];
@@ -483,29 +482,36 @@ def test_node_dot_str1(dot_str_pipeline, monkeypatch):
     overlay = nx.DiGraph()
     hidden_op = dot_str_pipeline.net.find_op_by_name("node")
     overlay.add_node(hidden_op, _no_plot=True)
-    dot_str = str(dot_str_pipeline.plot(graph=overlay))
+
+    sol = dot_str_pipeline.compute({"edge": 1, "digraph: strict": 2})
+    dot_str = str(sol.plot(graph=overlay))
+
     print(dot_str)
     exp = """
-        digraph graph_ {
+        digraph solution_x5_nodes {
         fontname=italic;
-        label=<graph>;
         splines=ortho;
-        <edge> [shape=invhouse];
-        <digraph&#58; strict> [shape=invhouse];
-        <&lt;graph&gt;> [shape=house];
-        <cu&#58;sto&#58;m> [label=<<TABLE CELLBORDER="0" CELLSPACING="0" STYLE="rounded">
+        subgraph "cluster_after pruning" {
+        label="after pruning";
+        <edge> [fillcolor=wheat, shape=invhouse, style=filled, tooltip="(int) 1"];
+        <digraph&#58; strict> [fillcolor=wheat, shape=invhouse, style=filled, tooltip="(int) 2"];
+        <&lt;graph&gt;> [fillcolor=SkyBlue, shape=house, style=filled, tooltip=None];
+        <cu&#58;sto&#58;m> [label=<<TABLE CELLBORDER="0" CELLSPACING="0" STYLE="rounded" BGCOLOR="wheat">
             <TR>
                 <TD BORDER="1" SIDES="b" ALIGN="left" TOOLTIP="FunctionalOperation(name=&#x27;cu:sto:m&#x27;, needs=[&#x27;edge&#x27;, &#x27;digraph: strict&#x27;], provides=[&#x27;&lt;graph&gt;&#x27;], fn=&#x27;func&#x27;)" HREF="abc#{&#x27;dot_path&#x27;: &#x27;test.test_plot.func&#x27;, &#x27;posix_path&#x27;: &#x27;test/test_plot/func&#x27;}" TARGET="bad"
                 ><B>OP:</B> <I>cu:sto:m</I></TD>
             </TR><TR>
-                <TD ALIGN="left" TOOLTIP="def func():&#10;    pass" HREF="abc#{&#x27;dot_path&#x27;: &#x27;test.test_plot.func&#x27;, &#x27;posix_path&#x27;: &#x27;test/test_plot/func&#x27;}" TARGET="bad"
+                <TD ALIGN="left" TOOLTIP="def func(a, b):&#10;    pass" HREF="abc#{&#x27;dot_path&#x27;: &#x27;test.test_plot.func&#x27;, &#x27;posix_path&#x27;: &#x27;test/test_plot/func&#x27;}" TARGET="bad"
                 ><B>FN:</B> test.test_plot.func</TD>
             </TR>
         </TABLE>>, shape=plain, tooltip=<cu:sto:m>];
+        }
+
         <edge> -> <cu&#58;sto&#58;m>;
         <digraph&#58; strict> -> <cu&#58;sto&#58;m>;
         <cu&#58;sto&#58;m> -> <&lt;graph&gt;>;
         legend [URL="https://graphtik.readthedocs.io/en/latest/_images/GraphtikLegend.svg", fillcolor=yellow, shape=component, style=filled, target=_top];
         }
         """
     assert _striplines(dot_str) == _striplines(exp)
+    assert "<node>" not in dot_str