[Feature] Improve plotting by using short names (#900)

* [Feature] Improve plotting by using short names

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add a test

* handle cases all on one level

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Always shorten name

* reduce classes

* fix tests

* Convert multi line entries to class string

* cover all lines of new function

* Catch multi line first

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: jan-janssen

src/executorlib/task_scheduler/interactive/dependency_plot.py

@@ -218,7 +218,11 @@ def plot_dependency_graph_function(
     graph = nx.DiGraph()
     for node in node_lst:
         if node["type"] == "input":
-            graph.add_node(node["id"], label=str(node["value"]), shape=node["shape"])
+            graph.add_node(
+                node["id"],
+                label=_short_object_name(node=node["value"]),
+                shape=node["shape"],
+            )
         else:
             graph.add_node(node["id"], label=str(node["name"]), shape=node["shape"])
     for edge in edge_lst:
@@ -306,3 +310,31 @@ def export_dependency_graph_function(
     }
     with open(file_name, "w") as f:
         json.dump(pwd_dict, f, indent=4)
+
+
+def _short_object_name(node):
+    node_value_str = str(node)
+    if isinstance(node, tuple):
+        short_name = str(tuple(_short_object_name(node=el) for el in node))
+    elif isinstance(node, list):
+        short_name = str([_short_object_name(node=el) for el in node])
+    elif isinstance(node, dict):
+        short_name = str(
+            {
+                _short_object_name(node=key): _short_object_name(node=value)
+                for key, value in node.items()
+            }
+        )
+    elif "object at" in node_value_str:
+        short_name = node_value_str[1:-1].split()[0].split(".")[-1] + "()"
+    elif "<function" in node_value_str:
+        short_name = node_value_str.split()[1] + "()"
+    elif "\n" in node_value_str:
+        short_name = str(type(node)).split("'")[1].split(".")[-1] + "()"
+    elif "(" in node_value_str and ")" in node_value_str:
+        short_name = node_value_str.split("(")[0] + "()"
+    elif len(node_value_str) > 20:
+        short_name = node_value_str[:21] + "..."
+    else:
+        short_name = node_value_str
+    return short_name

tests/unit/task_scheduler/interactive/test_dependency_plot.py

@@ -0,0 +1,34 @@
+import unittest
+import numpy as np
+from executorlib.task_scheduler.interactive.dependency_plot import _short_object_name
+
+
+class MyClass:
+    def __init__(self, i):
+        self._i = i
+
+
+class MyClassStr:
+    def __init__(self, i):
+        self._i = i
+
+    def __str__(self):
+        return "MyClassStr(i=" + str(self._i) + ")"
+
+
+def my_function(i):
+    return i
+
+
+class TestShortObjectName(unittest.TestCase):
+    def test_short_object_name(self):
+        result = _short_object_name(node=[MyClass("a"), MyClass("b")])
+        self.assertEqual("['MyClass()', 'MyClass()']", result)
+        result = _short_object_name(node=(MyClass("a"), MyClass("b")))
+        self.assertEqual("('MyClass()', 'MyClass()')", result)
+        result = _short_object_name(node=[MyClassStr("a"), MyClassStr("b")])
+        self.assertEqual("['MyClassStr()', 'MyClassStr()']", result)
+        result = _short_object_name(node=[np.array([[1,2], [4,3]]), np.array([[1,2], [4,3]])])
+        self.assertEqual("['ndarray()', 'ndarray()']", result)
+        result = _short_object_name(node={"this is a very long string far too long for a dictionary key": my_function})
+        self.assertEqual("{'this is a very long s...': 'my_function()'}", result)