feat: add WorkflowTopology class and workflow_to_workflow_topology operator #1902

Matteo-Baussart-ANSYS · 2024-11-15T15:03:36Z

This adds the PyDPF support of the WorkflowData class and workflow_to_workflow_topology operator,

codecov · 2024-11-18T15:24:36Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.40%. Comparing base (7b33c37) to head (1399247).
Report is 21 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1902      +/-   ##
==========================================
+ Coverage   86.62%   88.40%   +1.77%     
==========================================
  Files          83       89       +6     
  Lines        9973    10225     +252     
==========================================
+ Hits         8639     9039     +400     
+ Misses       1334     1186     -148

…erator

src/ansys/dpf/core/custom_container_base.py

PProfizi · 2024-11-29T10:24:27Z

src/ansys/dpf/core/dpf_operator.py

@@ -481,6 +482,11 @@ def _type_to_output_method(self):
                self._api.operator_getoutput_as_any,
                lambda obj, type: any.Any(server=self._server, any_dpf=obj).cast(type),
            ),
+            (


@Matteo-Baussart-ANSYS can a Workflow also potentially take in or output a WorkflowTopology object?
Can an operator take a WorkflowTopology as input?

WorkflowTopology can be the output for an Operator and from a Workflow. Following syntaxes are tested:

# For operator outputs workflow_to_workflow_topology_op.outputs.workflow_topology() workflow_to_workflow_topology_op.get_output(0, WorkflowTopology) # For workflow outputs workflow_topology = dpf_workflow_wrapper.get_output("output", WorkflowTopology)

As for inputs, there is currently no operator requiring a CustomContainerBase as input.

PProfizi · 2024-11-29T10:25:52Z

src/ansys/dpf/core/helpers/utils.py

@@ -48,3 +48,19 @@ def _sort_supported_kwargs(bound_method, **kwargs):
        warnings.warn(txt)
    # Return the accepted arguments
    return kwargs_in
+
+
+def indent(text, subsequent_indent="", initial_indent=None):


@Matteo-Baussart-ANSYS this will need a docstring with description and parameters. Also typehinting?

I added docstring and typehinting

PProfizi · 2024-11-29T10:26:21Z

src/ansys/dpf/core/workflow.py

@@ -953,6 +953,15 @@ 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_topology(self):


@Matteo-Baussart-ANSYS same, missing a docstring and typehinting

I added docstring and typehinting

PProfizi · 2024-11-29T10:27:45Z

src/ansys/dpf/core/workflow_topology/data_connection.py

+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+


This will need a title, reference tag and description. You can find examples of that being done in other modules.

I added titles and descriptions

PProfizi · 2024-11-29T10:28:07Z

src/ansys/dpf/core/workflow_topology/data_connection.py

+from ansys.dpf.core.custom_container_base import CustomContainerBase
+
+
+class DataConnection(CustomContainerBase):


@Matteo-Baussart-ANSYS again, missing docstrings and typehinting everywhere

I added docstrings and typehinting

PProfizi

Some specific questions, but a general request is to add docstrings, module headers, typehinting, and improve coverage.

cbellot000 · 2024-12-05T13:13:25Z

src/ansys/dpf/core/common.py

+_derived_class_name_to_type = None
+
+
+def derived_class_name_to_type():


could you please add a docstring here?

I added a docstring and typehints

cbellot000 · 2024-12-05T13:17:42Z

tests/test_workflow_topology.py

+    not conftest.SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_10_0,
+    reason="Operator `workflow_to_workflow_topology` does not exist below 10.0",
+)
+def test_workflow_get_topology(workflow):


for this test, could you please replace
@pytest.mark.skipif(
not conftest.SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_10_0, by the decorator defined in conftest that checks that the error message would be meaningful if a use with a lower version uses get_topology

I used the decorator @raises_for_servers_version_under("10.0"), and added a raise DpfVersionNotSupported("10.0") in Workflow.get_topology().

Out of office

Matteo-Baussart-ANSYS requested a review from cbellot000 November 15, 2024 15:03

Matteo-Baussart-ANSYS self-assigned this Nov 15, 2024

Matteo-Baussart-ANSYS changed the title ~~feat: add WorkflowData class and workflow_to_workflow_data operator~~ feat: add WorkflowTopology class and workflow_to_workflow_topology operator Nov 18, 2024

Matteo-Baussart-ANSYS added 2 commits November 25, 2024 10:14

feat: add WorkflowTopology class and workflow_to_workflow_topology op…

feded14

…erator

fix: updated Workflow.get_topology() to use derived classes

4ff8c4e

Matteo-Baussart-ANSYS force-pushed the mbaussar/feat/workflow_data branch from 849d50f to 4ff8c4e Compare November 25, 2024 09:17

Matteo-Baussart-ANSYS added 5 commits November 26, 2024 15:46

feat: add tests for WorkflowTopology

f8467b6

fix: add version conditions on new tests

2078cd0

fix: !! (I forgot one)

46c79f8

feat: add test for WorkflowTopology.__str__()

9880d99

fix: remove leftover code

87aacb8

PProfizi reviewed Nov 29, 2024

View reviewed changes

src/ansys/dpf/core/custom_container_base.py Show resolved Hide resolved

PProfizi reviewed Nov 29, 2024

View reviewed changes

PProfizi previously requested changes Nov 29, 2024

View reviewed changes

Matteo-Baussart-ANSYS added 11 commits November 29, 2024 15:02

fix: add docstrings and typehinting

4dfcee5

feat: add titles and descriptions

2bc8fcd

fix: add missing title and description for OperatorConnection

0e59baf

fix: fix circular dependence

09abcd7

feat: add get_output with CustomContainerBase and derived class

5962788

fix: simplify import of WorkflowTopology

f9ff71e

feat: add tests for derived class outputs

529909b

fix: fix broken derived classes (mesh_info)

0d8d7fc

fix: fix docstring

2ba8475

fix: fix docstring escaping

da60366

fix: remove extra import

0b7522d

Matteo-Baussart-ANSYS requested a review from MichaelNale December 3, 2024 15:07

cbellot000 reviewed Dec 5, 2024

View reviewed changes

fix: add docstring/typehints; add exception in Workflow.get_topology()

71f35ae

cbellot000 approved these changes Dec 6, 2024

View reviewed changes

Matteo-Baussart-ANSYS added 5 commits December 6, 2024 14:28

fix(test): revert some failing changes

6052034

fix(test): revert some failing changes (bis)

5a026b3

fix(test): revert some failing changes (ter)

c047105

fix: change version check

9e28ee6

feat: add ability to record derived types

1399247

cbellot000 requested a review from PProfizi December 11, 2024 07:02

Matteo-Baussart-ANSYS merged commit d2063fe into master Dec 11, 2024
46 checks passed

Matteo-Baussart-ANSYS deleted the mbaussar/feat/workflow_data branch December 11, 2024 09:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add WorkflowTopology class and workflow_to_workflow_topology operator #1902

feat: add WorkflowTopology class and workflow_to_workflow_topology operator #1902

Matteo-Baussart-ANSYS commented Nov 15, 2024 •

edited by PProfizi

Loading

codecov bot commented Nov 18, 2024 •

edited

Loading

PProfizi Nov 29, 2024

Matteo-Baussart-ANSYS Dec 2, 2024 •

edited

Loading

PProfizi Nov 29, 2024

Matteo-Baussart-ANSYS Nov 29, 2024

PProfizi Nov 29, 2024

Matteo-Baussart-ANSYS Nov 29, 2024

PProfizi Nov 29, 2024

Matteo-Baussart-ANSYS Nov 29, 2024

PProfizi Nov 29, 2024

Matteo-Baussart-ANSYS Nov 29, 2024

PProfizi left a comment

cbellot000 Dec 5, 2024

Matteo-Baussart-ANSYS Dec 6, 2024

cbellot000 Dec 5, 2024

Matteo-Baussart-ANSYS Dec 6, 2024

		from ansys.dpf.core.custom_container_base import CustomContainerBase


		class DataConnection(CustomContainerBase):

		_derived_class_name_to_type = None


		def derived_class_name_to_type():

feat: add WorkflowTopology class and workflow_to_workflow_topology operator #1902

feat: add WorkflowTopology class and workflow_to_workflow_topology operator #1902

Conversation

Matteo-Baussart-ANSYS commented Nov 15, 2024 • edited by PProfizi Loading

codecov bot commented Nov 18, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Matteo-Baussart-ANSYS Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PProfizi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Matteo-Baussart-ANSYS commented Nov 15, 2024 •

edited by PProfizi

Loading

codecov bot commented Nov 18, 2024 •

edited

Loading

Matteo-Baussart-ANSYS Dec 2, 2024 •

edited

Loading