Add NodeCreator component for customizing nodes. Closes #149

chimerapy/orchestrator/models/pipeline_models.py

@@ -157,14 +157,17 @@ def clone(self, **kwargs) -> "WrappedNode":
             kwargs = {}
         if kwargs == {}:
             kwargs = self.kwargs
+
+        worker_id = kwargs.pop("worker_id", None) or self.worker_id
+
         return WrappedNode(
-            name=self.name,
+            name=kwargs.get("name", None) or self.name,
             NodeClass=self.NodeClass,
             node_type=self.node_type,
             registry_name=self.registry_name,
             kwargs=kwargs,
             package=self.package,
-            worker_id=self.worker_id,
+            worker_id=worker_id,
         )
 
     @classmethod

chimerapy/orchestrator/registry/utils.py

@@ -1,4 +1,5 @@
-from typing import Optional, Type
+import inspect
+from typing import Any, Dict, Optional, Type
 
 from chimerapy.engine import Node
 from chimerapy.orchestrator.models.pipeline_models import NodeType, WrappedNode
@@ -70,6 +71,7 @@ def __call__(self, node_class: Type[Node]):
             node_class,
             node_type=self.type,
             registry_name=name,
+            kwargs=self._parse_init_kwargs(node_class),
         )
 
         qualified_name = f"{node_class.__module__}:{node_class.__name__}"
@@ -82,3 +84,31 @@ def __call__(self, node_class: Type[Node]):
             )
 
         return node_class
+
+    def _parse_init_kwargs(self, node_class: Type[Node]) -> Dict[str, Any]:
+        """Parse the init kwargs of a node class."""
+        signature = inspect.signature(node_class.__init__)
+        kwargs = {}
+        super_classes = inspect.getmro(node_class)
+        for super_class in super_classes:
+            if super_class not in [object, node_class]:
+                kwargs.update(self._parse_init_kwargs(super_class))
+
+        for param in signature.parameters.values():
+            if param.name == "self":
+                continue
+            if param.name == "kwargs":
+                continue
+            if param.name == "args":
+                continue
+
+            kwargs[param.name] = (
+                param.default if param.default is not param.empty else None
+            )
+
+        # Remove the id, debug_port and logdir kwargs
+        kwargs.pop("id", None)
+        kwargs.pop("debug_port", None)
+        kwargs.pop("logdir", None)
+
+        return kwargs

chimerapy/orchestrator/routers/pipeline_router.py

@@ -160,7 +160,11 @@ async def add_node_to(self, pipeline_id: str, web_node: WebNode) -> WebNode:
         The response will return the newly added node. If the pipeline does not exist, a 404 error will be returned.
         """
         wrapped_node = self.pipelines.add_node_to(
-            pipeline_id, web_node.registry_name, web_node.package
+            pipeline_id,
+            web_node.registry_name,
+            web_node.package,
+            **web_node.kwargs,
+            worker_id=web_node.worker_id
         )
 
         return (

chimerapy/orchestrator/tests/routers/test_pipeline_router.py

@@ -104,12 +104,16 @@ def test_node_edge_operations(self, pipeline_client):
 
         show_window_node = pipeline_client.post(
             f"/pipeline/add-node/{pipeline_id}",
-            json={"name": "ShowWindow", "registry_name": "ShowWindow"},
+            json={
+                "name": "ShowWindow",
+                "registry_name": "ShowWindow",
+                "kwargs": {"name": "test"},
+            },
         )
 
         assert show_window_node.status_code == 200
         show_window_node_json = show_window_node.json()
-        assert show_window_node_json["name"] == "ShowWindow"
+        assert show_window_node_json["name"] == "test"
         assert show_window_node_json["registry_name"] == "ShowWindow"
         assert show_window_node_json["id"] is not None
         assert show_window_node_json["type"] == "SINK"

chimerapy/orchestrator/tests/services/pipeline_service/test_pipelines.py

@@ -149,7 +149,6 @@ def test_web_json(self, pipelines):
 
             nodes_created.append(nodes)
             pipelines_created.append(pipeline)
-        print(pipelines.web_json().unwrap())
 
         assert pipelines.web_json().unwrap() == [
             {
@@ -163,7 +162,9 @@ def test_web_json(self, pipelines):
                         "name": "WebcamNode",
                         "registry_name": "WebcamNode",
                         "id": nodes_created[0][0].id,
-                        "kwargs": {},
+                        "kwargs": {
+                            "name": "WebcamNode",
+                        },
                         "type": "SOURCE",
                         "package": "chimerapy-orchestrator",
                         "worker_id": None,
@@ -172,7 +173,9 @@ def test_web_json(self, pipelines):
                         "name": "ShowWindow",
                         "registry_name": "ShowWindow",
                         "id": nodes_created[0][1].id,
-                        "kwargs": {},
+                        "kwargs": {
+                            "name": "ShowWindow",
+                        },
                         "type": "SINK",
                         "package": "chimerapy-orchestrator",
                         "worker_id": None,
@@ -197,7 +200,9 @@ def test_web_json(self, pipelines):
                         "name": "WebcamNode",
                         "registry_name": "WebcamNode",
                         "id": nodes_created[1][0].id,
-                        "kwargs": {},
+                        "kwargs": {
+                            "name": "WebcamNode",
+                        },
                         "type": "SOURCE",
                         "package": "chimerapy-orchestrator",
                         "worker_id": None,
@@ -206,7 +211,9 @@ def test_web_json(self, pipelines):
                         "name": "ShowWindow",
                         "registry_name": "ShowWindow",
                         "id": nodes_created[1][1].id,
-                        "kwargs": {},
+                        "kwargs": {
+                            "name": "ShowWindow",
+                        },
                         "type": "SINK",
                         "package": "chimerapy-orchestrator",
                         "worker_id": None,