From aa1983b22da7ce355e35715ecd751dbd0f5821e5 Mon Sep 17 00:00:00 2001
From: Frans Skarman <frans.skarman@liu.se>
Date: Wed, 15 Feb 2023 11:11:08 +0000
Subject: [PATCH] Method names
---
b_asic/signal_flow_graph.py | 21 ++++++++++-----------
test/test_sfg.py | 12 +++++++-----
2 files changed, 17 insertions(+), 16 deletions(-)
diff --git a/b_asic/signal_flow_graph.py b/b_asic/signal_flow_graph.py
index aa3c23f2..ddeb8db7 100644
--- a/b_asic/signal_flow_graph.py
+++ b/b_asic/signal_flow_graph.py
@@ -801,7 +801,7 @@ class SFG(AbstractOperation):
return self._precedence_list
- def show(self) -> None:
+ def show_precedence_graph(self) -> None:
self.precedence_graph().view()
def precedence_graph(self) -> Digraph:
@@ -1377,7 +1377,7 @@ class SFG(AbstractOperation):
results[key] = value
return value
- def sfg(self, show_id=False, engine=None) -> Digraph:
+ def sfg_digraph(self, show_id=False, engine=None) -> Digraph:
"""
Returns a Digraph of the SFG. Can be directly displayed in IPython.
@@ -1425,22 +1425,21 @@ class SFG(AbstractOperation):
return dg
def _repr_mimebundle_(self, include=None, exclude=None):
- return self.sfg()._repr_mimebundle_(include=include, exclude=exclude)
+ return self.sfg_digraph()._repr_mimebundle_(
+ include=include, exclude=exclude
+ )
def _repr_jpeg_(self):
- return self.sfg()._repr_mimebundle_(include=["image/jpeg"])[
+ return self.sfg_digraph()._repr_mimebundle_(include=["image/jpeg"])[
"image/jpeg"
]
def _repr_png_(self):
- return self.sfg()._repr_mimebundle_(include=["image/png"])["image/png"]
-
- def _repr_html_(self):
- return self.sfg()._repr_mimebundle_(include=["image/svg+xml"])[
- "image/svg+xlm"
+ return self.sfg_digraph()._repr_mimebundle_(include=["image/png"])[
+ "image/png"
]
- def show_sfg(self, format=None, show_id=False, engine=None) -> None:
+ def show(self, format=None, show_id=False, engine=None) -> None:
"""
Shows a visual representation of the SFG using the default system viewer.
@@ -1460,7 +1459,7 @@ class SFG(AbstractOperation):
Most common are "dot" and "neato". Default is None leading to dot.
"""
- dg = self.sfg(show_id=show_id)
+ dg = self.sfg_digraph(show_id=show_id)
if engine is not None:
dg.engine = engine
if format is not None:
diff --git a/test/test_sfg.py b/test/test_sfg.py
index 6f69f192..e31df451 100644
--- a/test/test_sfg.py
+++ b/test/test_sfg.py
@@ -1403,8 +1403,7 @@ class TestSFGGraph:
"add1\n\tcmul1\n\tadd1 -> t1\n\tt1 [shape=square]\n\tt1 "
"-> cmul1\n}"
)
- print(sfg_simple_filter.sfg().source)
- assert sfg_simple_filter.sfg().source in (res, res + "\n")
+ assert sfg_simple_filter.sfg_digraph().source in (res, res + "\n")
def test_sfg_show_id(self, sfg_simple_filter):
res = (
@@ -1414,15 +1413,18 @@ class TestSFGGraph:
"[label=s4]\n\tt1 [shape=square]\n\tt1 -> cmul1 [label=s5]\n}"
)
- assert sfg_simple_filter.sfg(show_id=True).source in (res, res + "\n")
+ assert sfg_simple_filter.sfg_digraph(show_id=True).source in (
+ res,
+ res + "\n",
+ )
def test_show_sfg_invalid_format(self, sfg_simple_filter):
with pytest.raises(ValueError):
- sfg_simple_filter.show_sfg(format="ppddff")
+ sfg_simple_filter.show(format="ppddff")
def test_show_sfg_invalid_engine(self, sfg_simple_filter):
with pytest.raises(ValueError):
- sfg_simple_filter.show_sfg(engine="ppddff")
+ sfg_simple_filter.show(engine="ppddff")
class TestSFGErrors:
--
GitLab