update generated code (#2049)

Co-authored-by: PProfizi <[email protected]>

Author: pyansys-ci-bot

doc/source/_static/dpf_operators.html

@@ -18,4 +18,5 @@
 from .vtk_export import vtk_export
 from .vtk_to_fields import vtk_to_fields
 from .vtu_export import vtu_export
+from .workflow_to_pydpf import workflow_to_pydpf
 from .workflow_to_workflow_topology import workflow_to_workflow_topology

src/ansys/dpf/core/operators/serialization/__init__.py

@@ -1,5 +1,5 @@
 """
-Workflow_to_PyDPF_Generator
+workflow_to_pydpf
 
 Autogenerated DPF operator classes.
 """
@@ -11,15 +11,15 @@
 from ansys.dpf.core.operators.specification import PinSpecification, Specification
 
 
-class Workflow_to_PyDPF_Generator(Operator):
-    """Generates .py python file that contains the PyDPF script of a Workflow
-    object.
+class workflow_to_pydpf(Operator):
+    """Generates a PyDPF script that can recreate the given workflow. The
+    script is returned as a string, and can optionally be saved to a
+    specified path.
 
     Parameters
     ----------
     workflow : Workflow
     output_path : str, optional
-    output_file_name : str, optional
 
     Returns
     -------
@@ -30,51 +30,38 @@ class Workflow_to_PyDPF_Generator(Operator):
     >>> from ansys.dpf import core as dpf
 
     >>> # Instantiate operator
-    >>> op = dpf.operators.utility.Workflow_to_PyDPF_Generator()
+    >>> op = dpf.operators.serialization.workflow_to_pydpf()
 
     >>> # Make input connections
     >>> my_workflow = dpf.Workflow()
     >>> op.inputs.workflow.connect(my_workflow)
     >>> my_output_path = str()
     >>> op.inputs.output_path.connect(my_output_path)
-    >>> my_output_file_name = str()
-    >>> op.inputs.output_file_name.connect(my_output_file_name)
 
     >>> # Instantiate operator and connect inputs in one line
-    >>> op = dpf.operators.utility.Workflow_to_PyDPF_Generator(
+    >>> op = dpf.operators.serialization.workflow_to_pydpf(
     ...     workflow=my_workflow,
     ...     output_path=my_output_path,
-    ...     output_file_name=my_output_file_name,
     ... )
 
     >>> # Get output data
     >>> result_pydpf_code = op.outputs.pydpf_code()
     """
 
-    def __init__(
-        self,
-        workflow=None,
-        output_path=None,
-        output_file_name=None,
-        config=None,
-        server=None,
-    ):
-        super().__init__(
-            name="Workflow_to_PyDPF_Generator", config=config, server=server
-        )
-        self._inputs = InputsWorkflowToPydpfGenerator(self)
-        self._outputs = OutputsWorkflowToPydpfGenerator(self)
+    def __init__(self, workflow=None, output_path=None, config=None, server=None):
+        super().__init__(name="workflow_to_pydpf", config=config, server=server)
+        self._inputs = InputsWorkflowToPydpf(self)
+        self._outputs = OutputsWorkflowToPydpf(self)
         if workflow is not None:
             self.inputs.workflow.connect(workflow)
         if output_path is not None:
             self.inputs.output_path.connect(output_path)
-        if output_file_name is not None:
-            self.inputs.output_file_name.connect(output_file_name)
 
     @staticmethod
     def _spec():
-        description = """Generates .py python file that contains the PyDPF script of a Workflow
-            object."""
+        description = """Generates a PyDPF script that can recreate the given workflow. The
+            script is returned as a string, and can optionally be
+            saved to a specified path."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
@@ -90,12 +77,6 @@ def _spec():
                     optional=True,
                     document="""""",
                 ),
-                2: PinSpecification(
-                    name="output_file_name",
-                    type_names=["string"],
-                    optional=True,
-                    document="""""",
-                ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
@@ -122,17 +103,15 @@ def default_config(server=None):
             Server with channel connected to the remote or local instance. When
             ``None``, attempts to use the global server.
         """
-        return Operator.default_config(
-            name="Workflow_to_PyDPF_Generator", server=server
-        )
+        return Operator.default_config(name="workflow_to_pydpf", server=server)
 
     @property
     def inputs(self):
         """Enables to connect inputs to the operator
 
         Returns
         --------
-        inputs : InputsWorkflowToPydpfGenerator
+        inputs : InputsWorkflowToPydpf
         """
         return super().inputs
 
@@ -142,41 +121,31 @@ def outputs(self):
 
         Returns
         --------
-        outputs : OutputsWorkflowToPydpfGenerator
+        outputs : OutputsWorkflowToPydpf
         """
         return super().outputs
 
 
-class InputsWorkflowToPydpfGenerator(_Inputs):
+class InputsWorkflowToPydpf(_Inputs):
     """Intermediate class used to connect user inputs to
-    Workflow_to_PyDPF_Generator operator.
+    workflow_to_pydpf operator.
 
     Examples
     --------
     >>> from ansys.dpf import core as dpf
-    >>> op = dpf.operators.utility.Workflow_to_PyDPF_Generator()
+    >>> op = dpf.operators.serialization.workflow_to_pydpf()
     >>> my_workflow = dpf.Workflow()
     >>> op.inputs.workflow.connect(my_workflow)
     >>> my_output_path = str()
     >>> op.inputs.output_path.connect(my_output_path)
-    >>> my_output_file_name = str()
-    >>> op.inputs.output_file_name.connect(my_output_file_name)
     """
 
     def __init__(self, op: Operator):
-        super().__init__(Workflow_to_PyDPF_Generator._spec().inputs, op)
-        self._workflow = Input(
-            Workflow_to_PyDPF_Generator._spec().input_pin(0), 0, op, -1
-        )
+        super().__init__(workflow_to_pydpf._spec().inputs, op)
+        self._workflow = Input(workflow_to_pydpf._spec().input_pin(0), 0, op, -1)
         self._inputs.append(self._workflow)
-        self._output_path = Input(
-            Workflow_to_PyDPF_Generator._spec().input_pin(1), 1, op, -1
-        )
+        self._output_path = Input(workflow_to_pydpf._spec().input_pin(1), 1, op, -1)
         self._inputs.append(self._output_path)
-        self._output_file_name = Input(
-            Workflow_to_PyDPF_Generator._spec().input_pin(2), 2, op, -1
-        )
-        self._inputs.append(self._output_file_name)
 
     @property
     def workflow(self):
@@ -189,7 +158,7 @@ def workflow(self):
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.utility.Workflow_to_PyDPF_Generator()
+        >>> op = dpf.operators.serialization.workflow_to_pydpf()
         >>> op.inputs.workflow.connect(my_workflow)
         >>> # or
         >>> op.inputs.workflow(my_workflow)
@@ -207,49 +176,29 @@ def output_path(self):
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.utility.Workflow_to_PyDPF_Generator()
+        >>> op = dpf.operators.serialization.workflow_to_pydpf()
         >>> op.inputs.output_path.connect(my_output_path)
         >>> # or
         >>> op.inputs.output_path(my_output_path)
         """
         return self._output_path
 
-    @property
-    def output_file_name(self):
-        """Allows to connect output_file_name input to the operator.
 
-        Parameters
-        ----------
-        my_output_file_name : str
-
-        Examples
-        --------
-        >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.utility.Workflow_to_PyDPF_Generator()
-        >>> op.inputs.output_file_name.connect(my_output_file_name)
-        >>> # or
-        >>> op.inputs.output_file_name(my_output_file_name)
-        """
-        return self._output_file_name
-
-
-class OutputsWorkflowToPydpfGenerator(_Outputs):
+class OutputsWorkflowToPydpf(_Outputs):
     """Intermediate class used to get outputs from
-    Workflow_to_PyDPF_Generator operator.
+    workflow_to_pydpf operator.
 
     Examples
     --------
     >>> from ansys.dpf import core as dpf
-    >>> op = dpf.operators.utility.Workflow_to_PyDPF_Generator()
+    >>> op = dpf.operators.serialization.workflow_to_pydpf()
     >>> # Connect inputs : op.inputs. ...
     >>> result_pydpf_code = op.outputs.pydpf_code()
     """
 
     def __init__(self, op: Operator):
-        super().__init__(Workflow_to_PyDPF_Generator._spec().outputs, op)
-        self._pydpf_code = Output(
-            Workflow_to_PyDPF_Generator._spec().output_pin(0), 0, op
-        )
+        super().__init__(workflow_to_pydpf._spec().outputs, op)
+        self._pydpf_code = Output(workflow_to_pydpf._spec().output_pin(0), 0, op)
         self._outputs.append(self._pydpf_code)
 
     @property
@@ -263,7 +212,7 @@ def pydpf_code(self):
         Examples
         --------
         >>> from ansys.dpf import core as dpf
-        >>> op = dpf.operators.utility.Workflow_to_PyDPF_Generator()
+        >>> op = dpf.operators.serialization.workflow_to_pydpf()
         >>> # Connect inputs : op.inputs. ...
         >>> result_pydpf_code = op.outputs.pydpf_code()
         """  # noqa: E501

src/ansys/dpf/core/operators/utility/Workflow_to_PyDPF_Generator.py renamed to src/ansys/dpf/core/operators/serialization/workflow_to_pydpf.py

@@ -76,4 +76,3 @@
 from .txt_file_to_dpf import txt_file_to_dpf
 from .unitary_field import unitary_field
 from .weighted_merge_fields_by_label import weighted_merge_fields_by_label
-from .Workflow_to_PyDPF_Generator import Workflow_to_PyDPF_Generator