Expose aliases in Input, Output, and PinSpecification

Author: PProfizi

src/ansys/dpf/core/dpf_operator.py

@@ -681,7 +681,7 @@ def id(self) -> int:
         return self._id
 
     @property
-    def inputs(self):
+    def inputs(self) -> Inputs:
         """Inputs connected to the operator.
 
         Returns
@@ -703,7 +703,7 @@ def inputs(self):
         return self._inputs
 
     @property
-    def outputs(self):
+    def outputs(self) -> Outputs:
         """Outputs from the operator's evaluation.
 
         Returns

src/ansys/dpf/core/inputs.py

@@ -62,6 +62,7 @@ def __init__(self, spec, pin, operator, count_ellipsis=-1):
                 self._python_expected_types.append(map_types_to_python[cpp_type])
         if len(self._spec.type_names) == 0:
             self._python_expected_types.append("Any")
+        self.aliases = self._spec.aliases
         docstr = self.__str__()
         self.name = self._spec.name
         if self._count_ellipsis != -1:
@@ -184,6 +185,8 @@ def __str__(self):
             docstr += "\n".join(wrap(self._spec.document.capitalize())) + "\n"
         if self._count_ellipsis >= 0:
             docstr += "is ellipsis\n"
+        if self.aliases:
+            docstr += f"aliases: {self.aliases}\n"
         return docstr
 
     def __inc_if_ellipsis(self):
@@ -312,6 +315,9 @@ def _add_input(self, pin, spec, count_ellipsis=-1):
     def __call__(self, inpt):
         self.connect(inpt)
 
+    def __getitem__(self, item) -> Input:
+        return self._inputs[item]
+
 
 # Dynamic class Inputs
 class Inputs(_Inputs):

src/ansys/dpf/core/operator_specification.py

@@ -78,6 +78,7 @@ class PinSpecification:
     optional: bool
     ellipsis: bool
     name_derived_class = str
+    aliases: list[str]
 
     def __init__(
         self,
@@ -87,13 +88,15 @@ def __init__(
         optional=False,
         ellipsis=False,
         name_derived_class="",
+        aliases=[],
     ):
         self.name = name
         self.type_names = type_names
         self.optional = optional
         self.document = document
         self.ellipsis = ellipsis
         self.name_derived_class = name_derived_class
+        self.aliases = aliases
 
     @property
     def type_names(self) -> list[str]:
@@ -140,6 +143,7 @@ def _get_copy(other, changed_types) -> PinSpecification:
             other.optional,
             other.ellipsis,
             other.name_derived_class,
+            other.aliases,
         )
 
     def __repr__(self):
@@ -367,7 +371,7 @@ def description(self) -> str:
         return ""
 
     @property
-    def inputs(self) -> dict:
+    def inputs(self) -> dict[int, PinSpecification]:
         """Returns a dictionary mapping the input pin numbers to their ``PinSpecification``.
 
         Returns
@@ -390,7 +394,7 @@ def inputs(self) -> dict:
         return self._map_input_pin_spec
 
     @property
-    def outputs(self) -> dict:
+    def outputs(self) -> dict[int, PinSpecification]:
         """Returns a dictionary mapping the output pin numbers to their ``PinSpecification``.
 
         Returns
@@ -429,7 +433,13 @@ def _fill_pins(self, binput, to_fill):
                     self._api.operator_specification_get_pin_type_name(self, binput, i_pin, i_type)
                     for i_type in range(n_types)
                 ]
-
+                pin_aliases = []
+                for i_alias in range(
+                    self._api.operator_specification_get_pin_num_aliases(self, binput, i_pin)
+                ):
+                    pin_aliases.append(
+                        self._api.operator_specification_get_pin_alias(self, binput, i_pin, i_alias)
+                    )
                 pin_derived_class_type_name = ""
                 if server_meet_version("7.0", self._server) and hasattr(
                     self._api, "operator_specification_get_pin_derived_class_type_name"
@@ -448,6 +458,7 @@ def _fill_pins(self, binput, to_fill):
                     pin_opt,
                     pin_ell,
                     pin_derived_class_type_name,
+                    pin_aliases,
                 )
 
     @property

src/ansys/dpf/core/outputs.py

@@ -54,6 +54,7 @@ def __init__(self, spec, pin, operator):
         self._python_expected_types = []
         for cpp_type in self._spec.type_names:
             self._python_expected_types.append(map_types_to_python[cpp_type])
+        self.aliases = self._spec.aliases
 
     def get_data(self):
         """Retrieve the output of the operator."""
@@ -118,6 +119,8 @@ def __str__(self):
             docstr += "   -" + exp_types + "\n"
         if self._spec.document:
             docstr += "help: " + self._spec.document + "\n"
+        if self.aliases:
+            docstr += f"aliases: {self.aliases}\n"
         return docstr
 
 
@@ -148,7 +151,7 @@ def _get_given_output(self, input_type_name):
                         corresponding_pins.append(pin)
         return corresponding_pins
 
-    def __getitem__(self, index):
+    def __getitem__(self, index) -> Output:
         return self._outputs[index]
 
     def __str__(self):
@@ -157,8 +160,9 @@ def __str__(self):
             tot_string = str(output._spec.name)
             input_string = tot_string.split("\n")
             input_string1 = input_string[0]
-            line = ["   ", "- ", input_string1]
-            docstr += "{:<5}{:<4}{:<20}\n".format(*line)
+            aliases = tuple(output._spec.aliases) if output._spec.aliases else ""
+            line = ["   ", "- ", input_string1, aliases]
+            docstr += "{:<5}{:<4}{:<20}{}\n".format(*line)
             for inputstr in input_string:
                 if inputstr != input_string1:
                     line = ["   ", "  ", inputstr]