REFACT(plot): Plotter-->Plottable

Author: ankostis

CHANGES.rst

@@ -272,7 +272,7 @@ v4.1.0 (13  Dec 2019, @ankostis): ChainMap Solution for Rewrites, stable TOPOLOG
 
   + drop(net): ``_PinInstruction`` class is not needed.
   + drop(netop): `overwrites_collector` parameter; now in :meth:`.Solution.overwrites()`.
-  + ENH(plot): ``Solution`` is also a :class:`.Plotter`;  e.g. use ``sol.plot(...)```.
+  + ENH(plot): ``Solution`` is also a :class:`.Plottable`;  e.g. use ``sol.plot(...)```.
 
 + DROP(plot): `executed` arg from plotting; now embedded in `solution`.
 

docs/source/plotting.rst

@@ -29,7 +29,7 @@ solution of the last computation, calling methods with arguments like this::
 
    The legend for all graphtik diagrams, generated by :func:`.legend()`.
 
-The same :meth:`.Plotter.plot()` method applies also for:
+The same :meth:`.Plottable.plot()` method applies also for:
 
 - :class:`.NetworkOperation`
 - :class:`.Network`
@@ -68,7 +68,7 @@ If you want all details, plot the solution::
 
 .. Tip::
    The `pydot.Dot <https://pypi.org/project/pydot/>`_ instances returned by
-   :meth:`.Plotter.plot()` are rendered directly in *Jupyter/IPython* notebooks
+   :meth:`.Plottable.plot()` are rendered directly in *Jupyter/IPython* notebooks
    as SVG images.
 
    You may increase the height of the SVG cell output with something like this::
@@ -136,7 +136,7 @@ directive from :mod:`.sphinxext` module to embed graph-plots into your generated
 
          the variable name containing what to render, which it can be:
 
-         - an instance of :class:`.Plotter` (such as :class:`.NetworkOperation`,
+         - an instance of :class:`.Plottable` (such as :class:`.NetworkOperation`,
            :class:`.Network`, :class:`.ExecutionPlan` or :class:`.Solution`);
 
          - an already plotted ``pydot.Dot`` instance, ie, the result of a :meth:`.plot()` call
@@ -231,7 +231,7 @@ which you may :graphtik:`reference <addmul-anchor>` with this syntax:
 .. hint::
    In this case, the ``:graphvar:`` parameter is not really needed, since
    the code contains just one variable assignment receiving a subclass
-   of :class:`.Plotter` or :class:`pydot.Dot` instance.
+   of :class:`.Plottable` or :class:`pydot.Dot` instance.
 
    Additionally, the doctest code producing the *plottable* does not have to be contained
    in the *graphtik* directive.

graphtik/base.py

@@ -201,7 +201,7 @@ def jetsam(ex, locs, *salvage_vars: str, annotation="jetsam", **salvage_mappings
 
 
 ## Defined here, to avoid subclasses importing `plot` module.
-class Plotter(abc.ABC):
+class Plottable(abc.ABC):
     """
     Classes wishing to plot their graphs should inherit this and ...
 
@@ -274,7 +274,7 @@ def plot(
 
                 Check :data:`.default_jupyter_render` for defaults.
 
-        Note that the `graph` argument is absent - Each Plotter provides
+        Note that the `graph` argument is absent - Each Plottable provides
         its own graph internally;  use directly :func:`.render_pydot()` to provide
         a different graph.
 

graphtik/netop.py

@@ -10,7 +10,7 @@
 import networkx as nx
 from boltons.setutils import IndexedSet as iset
 
-from .base import UNSET, Items, Plotter, aslist, astuple, jetsam
+from .base import UNSET, Items, Plottable, aslist, astuple, jetsam
 from .config import is_debug, reset_abort
 from .modifiers import optional, sideffect
 from .network import ExecutionPlan, Network, NodePredicate, Solution, yield_ops
@@ -89,7 +89,7 @@ def proc_op(op, parent=None):
     return net
 
 
-class NetworkOperation(Operation, Plotter):
+class NetworkOperation(Operation, Plottable):
     """
     An operation that can :term:`compute` a network-graph of operations.
 

graphtik/network.py

@@ -15,7 +15,7 @@
 import networkx as nx
 from boltons.setutils import IndexedSet as iset
 
-from .base import UNSET, Items, Plotter, aslist, astuple, jetsam
+from .base import UNSET, Items, Plottable, aslist, astuple, jetsam
 from .config import (
     get_execution_pool,
     is_abort,
@@ -126,7 +126,7 @@ def _unsatisfied_operations(dag, inputs: Collection) -> List:
     return unsatisfied
 
 
-class Solution(ChainMap, Plotter):
+class Solution(ChainMap, Plottable):
     """
     Collects outputs from operations, preserving :term:`overwrites`.
 
@@ -447,7 +447,7 @@ def _do_task(task):
 
 
 class ExecutionPlan(
-    namedtuple("ExecPlan", "net needs provides dag steps asked_outs"), Plotter
+    namedtuple("ExecPlan", "net needs provides dag steps asked_outs"), Plottable
 ):
     """
     A pre-compiled list of operation steps that can :term:`execute` for the given inputs/outputs.
@@ -854,7 +854,7 @@ def execute(self, named_inputs, outputs=None, *, name="") -> Solution:
             raise
 
 
-class Network(Plotter):
+class Network(Plottable):
     """
     A graph of operations that can :term:`compile` an execution plan.
 

graphtik/op.py

@@ -17,7 +17,7 @@
     UNSET,
     Items,
     MultiValueError,
-    Plotter,
+    Plottable,
     aslist,
     astuple,
     jetsam,

graphtik/plot.py

@@ -18,7 +18,7 @@
 
 #: A nested dictionary controlling the rendering of graph-plots in Jupyter cells,
 #:
-#: as those returned from :meth:`.Plotter.plot()` (currently as SVGs).
+#: as those returned from :meth:`.Plottable.plot()` (currently as SVGs).
 #: Either modify it in place, or pass another one in the respective methods.
 #:
 #: The following keys are supported.
@@ -207,7 +207,7 @@ def build_pydot(
     """
     Build a *Graphviz* out of a Network graph/steps/inputs/outputs and return it.
 
-    See :meth:`.Plotter.plot()` for the arguments, sample code, and
+    See :meth:`.Plottable.plot()` for the arguments, sample code, and
     the legend of the plots.
     """
     from .op import Operation
@@ -411,7 +411,7 @@ def render_pydot(dot: pydot.Dot, filename=None, show=False, jupyter_render: str
     :return:
         the matplotlib image if ``show=-1``, or the `dot`.
 
-    See :meth:`.Plotter.plot()` for sample code.
+    See :meth:`.Plottable.plot()` for sample code.
     """
     # Save plot
     #
@@ -454,7 +454,7 @@ def legend(
     arch_url="https://graphtik.readthedocs.io/en/latest/arch.html",
 ):
     """
-    Generate a legend for all plots (see :meth:`.Plotter.plot()` for args)
+    Generate a legend for all plots (see :meth:`.Plottable.plot()` for args)
 
     :param arch_url:
         the url to the architecture section explaining *graphtik* glossary.

graphtik/sphinxext/_graphtikbuilder.py

@@ -14,11 +14,11 @@
 from sphinx.locale import _, __
 from sphinx.util import logging
 
-from ..base import Plotter
+from ..base import Plottable
 from ..network import Solution
 from . import doctestglobs, dynaimage, graphtik_node
 
-Plottable = Union[None, Plotter, pydot.Dot]
+PlottableType = Union[None, Plottable, pydot.Dot]
 
 log = logging.getLogger(__name__)
 
@@ -72,12 +72,12 @@ def _globals_updated(self, code: extdoctest.TestCode, globs: dict):
                 )
 
     def _is_plottable(self, value):
-        return isinstance(value, (Plotter, pydot.Dot))
+        return isinstance(value, (Plottable, pydot.Dot))
 
     def _retrieve_graphvar_plottable(
         self, globs: dict, graphvar, location,
-    ) -> Plottable:
-        plottable: Plottable = None
+    ) -> PlottableType:
+        plottable: PlottableType = None
 
         if graphvar is None:
             ## Pick last plottable from globals.