fix: rename WorkflowData to WorkflowTopology

Author: Matteo-Baussart-ANSYS

src/ansys/dpf/core/workflow.py

@@ -43,7 +43,7 @@
     server_meet_version_and_raise,
 )
 from ansys.dpf.core import server as server_module
-from ansys.dpf.core.workflow_data.workflow_data import WorkflowData
+from ansys.dpf.core.workflow_topology.workflow_topology import WorkflowTopology
 from ansys.dpf.gate import (
     workflow_abstract_api,
     workflow_grpcapi,
@@ -954,12 +954,12 @@ def to_graphviz(self, path: Union[os.PathLike, str]):
         """Saves the workflow to a GraphViz file."""
         return self._api.work_flow_export_graphviz(self, str(path))
 
-    def get_data(self):
-        workflow_to_workflow_data_op = dpf_operator.Operator("workflow_to_workflow_data")
-        workflow_to_workflow_data_op.inputs.workflow.connect(self)
-        workflow_data_container = workflow_to_workflow_data_op.outputs.workflow_data()
+    def get_topology(self):
+        workflow_to_workflow_topology_op = dpf_operator.Operator("workflow_to_workflow_topology")
+        workflow_to_workflow_topology_op.inputs.workflow.connect(self)
+        workflow_topology_container = workflow_to_workflow_topology_op.outputs.workflow_topology()
 
-        return WorkflowData(workflow_data_container)
+        return WorkflowTopology(workflow_topology_container)
 
     def __del__(self):
         try:

src/ansys/dpf/core/workflow_data/data_connection.py renamed to src/ansys/dpf/core/workflow_topology/data_connection.py

@@ -42,16 +42,14 @@ def target_operator(self):
         from ansys.dpf.core.dpf_operator import Operator
 
         if self._target_operator is None:
-            self._target_operator = self._container.get_property(
-                "target_operator", Operator)
+            self._target_operator = self._container.get_property("target_operator", Operator)
 
         return self._target_operator
 
     @property
     def target_pin_id(self):
         if self._target_pin_id is None:
-            self._target_pin_id = self._container.get_property(
-                "target_pin_id", int)
+            self._target_pin_id = self._container.get_property("target_pin_id", int)
 
         return self._target_pin_id
 
@@ -66,7 +64,7 @@ def __str__(self):
             " - target_operator:\n"
             f"{indent(self.target_operator.name, indents)}\n"
             " - target_pin_id:\n"
-            f"{indent(self.target_pin_id, indents)}\n"
+            f"{indent(self.target_pin_id, indents)}"
         )
 
 
@@ -88,4 +86,4 @@ def __str__(self):
         from ansys.dpf.core.helpers.utils import indent
 
         indents = ("   ", " - ")
-        return f"{"\n".join([indent(data_connection, *indents) for data_connection in self])}\n"
+        return "\n".join([indent(data_connection, *indents) for data_connection in self])

src/ansys/dpf/core/workflow_data/exposed_pin.py renamed to src/ansys/dpf/core/workflow_topology/exposed_pin.py

@@ -64,7 +64,7 @@ def __str__(self):
             " - operator:\n"
             f"{indent(self.operator.name, indents)}\n"
             " - pin_id:\n"
-            f"{indent(self.pin_id, indents)}\n"
+            f"{indent(self.pin_id, indents)}"
         )
 
     def __repr__(self) -> str:
@@ -89,4 +89,4 @@ def __str__(self):
         from ansys.dpf.core.helpers.utils import indent
 
         indents = ("   ", " - ")
-        return f"{"\n".join([indent(exposed_pin, *indents) for exposed_pin in self])}\n"
+        return "\n".join([indent(exposed_pin, *indents) for exposed_pin in self])

src/ansys/dpf/core/workflow_data/operator_connection.py renamed to src/ansys/dpf/core/workflow_topology/operator_connection.py

@@ -36,16 +36,14 @@ def source_operator(self):
         from ansys.dpf.core.dpf_operator import Operator
 
         if self._source_operator is None:
-            self._source_operator = self._container.get_property(
-                "source_operator", Operator)
+            self._source_operator = self._container.get_property("source_operator", Operator)
 
         return self._source_operator
 
     @property
     def source_pin_id(self):
         if self._source_pin_id is None:
-            self._source_pin_id = self._container.get_property(
-                "source_pin_id", int)
+            self._source_pin_id = self._container.get_property("source_pin_id", int)
 
         return self._source_pin_id
 
@@ -54,16 +52,14 @@ def target_operator(self):
         from ansys.dpf.core.dpf_operator import Operator
 
         if self._target_operator is None:
-            self._target_operator = self._container.get_property(
-                "target_operator", Operator)
+            self._target_operator = self._container.get_property("target_operator", Operator)
 
         return self._target_operator
 
     @property
     def target_pin_id(self):
         if self._target_pin_id is None:
-            self._target_pin_id = self._container.get_property(
-                "target_pin_id", int)
+            self._target_pin_id = self._container.get_property("target_pin_id", int)
 
         return self._target_pin_id
 
@@ -80,7 +76,7 @@ def __str__(self):
             " - target_operator:\n"
             f"{indent(self.target_operator.name, indents)}\n"
             " - target_pin_id:\n"
-            f"{indent(self.target_pin_id, indents)}\n"
+            f"{indent(self.target_pin_id, indents)}"
         )
 
 
@@ -102,4 +98,4 @@ def __str__(self):
         from ansys.dpf.core.helpers.utils import indent
 
         indents = ("   ", " - ")
-        return f"{"\n".join([indent(operator_connection, *indents) for operator_connection in self])}\n"
+        return "\n".join([indent(operator_connection, *indents) for operator_connection in self])

src/ansys/dpf/core/workflow_data/workflow_data.py renamed to src/ansys/dpf/core/workflow_topology/workflow_topology.py

@@ -23,7 +23,7 @@
 from ansys.dpf.core.custom_container_base import CustomContainerBase
 
 
-class WorkflowData(CustomContainerBase):
+class WorkflowTopology(CustomContainerBase):
     def __init__(self, *args) -> None:
         super().__init__(*args)
 
@@ -38,69 +38,80 @@ def operators(self):
         from ansys.dpf.core import OperatorsCollection
 
         if self._operators is None:
-            self._operators = self._container.get_property(
-                "operators", OperatorsCollection)
+            self._operators = self._container.get_property("operators", OperatorsCollection)
 
         return self._operators
 
     @property
     def operator_connections(self):
         from ansys.dpf.core import GenericDataContainersCollection
-        from ansys.dpf.core.workflow_data.operator_connection import OperatorConnectionsCollection
+        from ansys.dpf.core.workflow_topology.operator_connection import (
+            OperatorConnectionsCollection,
+        )
 
         if self._operator_connections is None:
             self._operator_connections = OperatorConnectionsCollection(
-                self._container.get_property("operator_connections", GenericDataContainersCollection))
+                self._container.get_property(
+                    "operator_connections", GenericDataContainersCollection
+                )
+            )
 
         return self._operator_connections
 
     @property
     def data_connections(self):
         from ansys.dpf.core import GenericDataContainersCollection
-        from ansys.dpf.core.workflow_data.data_connection import DataConnectionsCollection
+        from ansys.dpf.core.workflow_topology.data_connection import DataConnectionsCollection
 
         if self._data_connections is None:
             self._data_connections = DataConnectionsCollection(
-                self._container.get_property("data_connections", GenericDataContainersCollection))
+                self._container.get_property("data_connections", GenericDataContainersCollection)
+            )
 
         return self._data_connections
 
     @property
     def exposed_inputs(self):
         from ansys.dpf.core import GenericDataContainersCollection
-        from ansys.dpf.core.workflow_data.exposed_pin import ExposedPinsCollection
+        from ansys.dpf.core.workflow_topology.exposed_pin import ExposedPinsCollection
 
         if self._exposed_inputs is None:
-            self._exposed_inputs = ExposedPinsCollection(self._container.get_property(
-                "exposed_inputs", GenericDataContainersCollection))
+            self._exposed_inputs = ExposedPinsCollection(
+                self._container.get_property("exposed_inputs", GenericDataContainersCollection)
+            )
 
         return self._exposed_inputs
 
     @property
     def exposed_outputs(self):
         from ansys.dpf.core import GenericDataContainersCollection
-        from ansys.dpf.core.workflow_data.exposed_pin import ExposedPinsCollection
+        from ansys.dpf.core.workflow_topology.exposed_pin import ExposedPinsCollection
 
         if self._exposed_outputs is None:
-            self._exposed_outputs = ExposedPinsCollection(self._container.get_property(
-                "exposed_outputs", GenericDataContainersCollection))
+            self._exposed_outputs = ExposedPinsCollection(
+                self._container.get_property("exposed_outputs", GenericDataContainersCollection)
+            )
 
         return self._exposed_outputs
 
     def __str__(self):
         from ansys.dpf.core.helpers.utils import indent
 
-        indents = ("     ", "   - ")
+        def indent_operators(operators):
+            indents = ("     ", "   - ")
+            return "\n".join([indent(operator.name, *indents) for operator in operators])
+
+        indents = "  "
         return (
-            "WorkflowData with properties:\n"
+            "WorkflowTopology with properties:\n"
             f" - operators (len: {len(self.operators)}):\n"
-            f"{"\n".join([indent(operator.name, *indents) for operator in self.operators])}\n"
+            f"{indent_operators(self.operators)}\n"
             f" - operator_connections (len: {len(self.operator_connections)}):\n"
-            f"{indent(self.operator_connections, "  ")}\n"
+            f"{indent(self.operator_connections, indents)}\n"
             f" - data_connections (len: {len(self.data_connections)}):\n"
-            f"{indent(self.data_connections, "  ")}\n"
+            f"{indent(self.data_connections, indents)}\n"
             f" - exposed_inputs (len: {len(self.exposed_inputs)}):\n"
-            f"{indent(self.exposed_inputs, "  ")}\n"
+            f"{indent(self.exposed_inputs, indents)}\n"
             f" - exposed_outputs (len: {len(self.exposed_outputs)}):\n"
-            f"{indent(self.exposed_outputs, "  ")}\n"
+            f"{indent(self.exposed_outputs, indents)}"
         )