Add content property to resource

b_asic/architecture.py

@@ -8,6 +8,7 @@ from typing import Dict, Iterable, Iterator, List, Optional, Set, Tuple, Union,
 import matplotlib.pyplot as plt
 from graphviz import Digraph
 
+from b_asic.mpl_utils import FigureWrapper
 from b_asic.port import InputPort, OutputPort
 from b_asic.process import MemoryVariable, OperatorProcess, PlainMemoryVariable
 from b_asic.resources import ProcessCollection
@@ -174,19 +175,34 @@ class Resource(HardwareBlock):
         # doc-string inherited
         return self._collection.schedule_time
 
-    def show_content(self):
+    def plot_content(self, ax: plt.Axes) -> None:
         if not self.is_assigned:
-            self._collection.show()
+            self._collection.plot(ax)
         else:
-            fig, ax = plt.subplots()
             for i, pc in enumerate(self._assignment):  # type: ignore
                 pc.plot(ax=ax, row=i)
-            fig.show()  # type: ignore
+
+    def show_content(self):
+        fig, ax = plt.subplots()
+        self.plot_content(ax)
+        fig.show()  # type: ignore
 
     @property
     def is_assigned(self) -> bool:
         return self._assignment is not None
 
+    @property
+    def content(self) -> FigureWrapper:
+        """
+        Return a graphical representation of the content.
+
+        This is visible in enriched shells, but the object in itself has no further
+        meaning.
+        """
+        fig, ax = plt.subplots()
+        self.plot_content(ax)
+        return FigureWrapper(fig)
+
 
 class ProcessingElement(Resource):
     """

b_asic/mpl_utils.py

+"""
+B-ASIC utilities for Matplotlib integration.
+"""
+import io
+
+from matplotlib.figure import Figure
+
+
+class FigureWrapper:
+    """Simple wrapper to display a figure inline in enriched shells."""
+
+    def __init__(self, figure: Figure):
+        self._figure = figure
+
+    def _repr_svg_(self):
+        buffer = io.StringIO()
+        self._figure.savefig(buffer, format="svg")
+        return buffer.getvalue()

docs_sphinx/api/index.rst

@@ -8,6 +8,7 @@ API
     architecture.rst
     core_operations.rst
     graph_component.rst
+    mpl_utils.rst
     operation.rst
     port.rst
     process.rst

docs_sphinx/api/mpl_utils.rst

+********************
+``b_asic.mpl_utils``
+********************
+
+.. automodule:: b_asic.mpl_utils
+   :members:
+   :undoc-members: