Maint/typing

mypy.ini

@@ -0,0 +1,4 @@
+[mypy]
+mypy_path = $MYPY_CONFIG_FILE_DIR/src
+explicit_package_bases = True
+exclude = 00_run_script

src/ansys/optislang/core/__init__.py

@@ -38,8 +38,6 @@
 
 __version__ = importlib.metadata.version(__name__.replace(".", "-"))
 
-IRON_PYTHON = sys.platform == "cli"
-PY3 = sys.version_info[0] >= 3
 # First supported version of optiSLang: 2023R1
 FIRST_SUPPORTED_VERSION = 231
 

src/ansys/optislang/core/encoding.py

@@ -24,11 +24,11 @@
 
 import sys
 
-from ansys.optislang.core import IRON_PYTHON, PY3
+from ansys.optislang.core import utils
 
 defenc = sys.getdefaultencoding()
 
-if PY3:
+if sys.version_info[0] >= 3:
     text_type = str
     binary_type = bytes
 else:
@@ -85,8 +85,8 @@ def force_bytes(text: str, encoding="ascii") -> bytes:
     bytes
         An encoded version of the string as a bytes object.
     """
-    if IRON_PYTHON:
-        return binary_type(text.encode(encoding, "ignore"), encoding, "ignore")
+    if utils.is_iron_python():
+        return binary_type(text.encode(encoding, "ignore"), encoding, "ignore")  # type: ignore
     else:
         return text.encode(encoding, "ignore")
 
@@ -111,7 +111,7 @@ def force_text(data: bytes, encoding="utf-8") -> str:
     if isinstance(data, string_types):
         return data.decode(encoding, errors="ignore")
 
-    if PY3:
+    if sys.version_info[0] >= 3:
         return text_type(data, encoding)
     else:
         return text_type(data)

src/ansys/optislang/core/io.py

@@ -273,8 +273,8 @@ class RegisteredFileUsage(Enum):
     INPUT_FILE = 2
     OUTPUT_FILE = 3
 
-    @staticmethod
-    def from_str(string: str) -> RegisteredFileUsage:
+    @classmethod
+    def from_str(cls, string: str) -> RegisteredFileUsage:
         """Convert string to an instance of the ``RegisteredFileUsage`` class.
 
         Parameters
@@ -294,7 +294,7 @@ def from_str(string: str) -> RegisteredFileUsage:
         ValueError
             Raised when an invalid value of ``string`` is given.
         """
-        return enum_from_str(string=string, enum_class=__class__, replace=(" ", "_"))
+        return enum_from_str(string=string, enum_class=cls, replace=(" ", "_"))
 
     def to_str(self) -> str:
         """Convert usage type to string.

src/ansys/optislang/core/node_types.py

@@ -42,8 +42,8 @@ class AddinType(Enum):
     PYTHON_BASED_MOP_NODE_PLUGIN = 5
     PYTHON_BASED_NODE_PLUGIN = 6
 
-    @staticmethod
-    def from_str(string: str) -> AddinType:
+    @classmethod
+    def from_str(cls, string: str) -> AddinType:
         """Convert string to an instance of the ``AddinType`` class.
 
         Parameters
@@ -63,7 +63,7 @@ def from_str(string: str) -> AddinType:
         ValueError
             Raised when an invalid value of ``string`` is given.
         """
-        return enum_from_str(string=string, enum_class=__class__, replace=(" ", "_"))
+        return enum_from_str(string=string, enum_class=cls, replace=(" ", "_"))
 
 
 class NodeType:
@@ -89,26 +89,11 @@ def __str__(self):
         """Return formatted string."""
         return f"type: {self.id}, subtype: {self.subtype}"
 
-    def __eq__(self, other: NodeType) -> bool:
-        """Compare properties of two instances of the ``NodeType`` class.
-
-        Parameters
-        ----------
-        other: NodeType
-            Criterion for comparison.
-
-        Returns
-        -------
-        bool
-            ``True`` if all properties match; ``False`` otherwise.
-        """
-        if type(self) == type(other):
-            checks = {}
-            checks["id"] = self.id == other.id
-            checks["subtype"] = self.subtype == other.subtype
-            return False not in checks.values()
-        else:
-            return False
+    def __eq__(self, other: object) -> bool:
+        """Object comparison."""
+        if not isinstance(other, NodeType):
+            return NotImplemented
+        return self.id == other.id and self.subtype == other.subtype
 
     @property
     def id(self) -> str:
@@ -881,17 +866,17 @@ def get_node_type_from_str(node_id: str) -> NodeType:
     if module_constants.get(node_id, None) is not None:
         return module_constants[node_id]
     elif node_id in customs.keys():
-        id = node_id[:-1]
+        id_ = node_id[:-1]
         subtype = AddinType.BUILT_IN
     else:
         was_found = False
         for custom in customs.keys():
             if node_id.startswith(custom):
-                id = node_id.replace(custom, "")
-                subtype = customs[custom]
+                id_ = node_id.replace(custom, "")
+                subtype = customs[custom]  # type: ignore
                 was_found = True
                 break
         if not was_found:
-            id = node_id
+            id_ = node_id
             subtype = AddinType.BUILT_IN
-    return NodeType(id=id, subtype=subtype)
+    return NodeType(id=id_, subtype=subtype)

src/ansys/optislang/core/nodes.py

@@ -64,8 +64,8 @@ class DesignFlow(Enum):
     SEND = 2
     RECEIVE_SEND = 3
 
-    @staticmethod
-    def from_str(string: str) -> DesignFlow:
+    @classmethod
+    def from_str(cls, string: str) -> DesignFlow:
         """Convert string to an instance of the ``DesignFlow`` class.
 
         Parameters
@@ -85,7 +85,7 @@ def from_str(string: str) -> DesignFlow:
         ValueError
             Raised when an invalid value of ``string`` is given.
         """
-        return enum_from_str(string=string, enum_class=__class__, replace=(" ", "_"))
+        return enum_from_str(string=string, enum_class=cls, replace=(" ", "_"))
 
 
 class NodeClassType(Enum):
@@ -97,8 +97,8 @@ class NodeClassType(Enum):
     ROOT_SYSTEM = 3
     INTEGRATION_NODE = 4
 
-    @staticmethod
-    def from_str(string: str) -> NodeClassType:
+    @classmethod
+    def from_str(cls, string: str) -> NodeClassType:
         """Convert string to an instance of the ``NodeClassType`` class.
 
         Parameters
@@ -118,7 +118,7 @@ def from_str(string: str) -> NodeClassType:
         ValueError
             Raised when an invalid value of ``string`` is given.
         """
-        return enum_from_str(string=string, enum_class=__class__, replace=(" ", "_"))
+        return enum_from_str(string=string, enum_class=cls, replace=(" ", "_"))
 
 
 class SamplingType(Enum):
@@ -148,8 +148,8 @@ class SamplingType(Enum):
     FULLCOMBINATORIAL = 21
     ADVANCEDLATINHYPER = 22
 
-    @staticmethod
-    def from_str(string: str) -> SamplingType:
+    @classmethod
+    def from_str(cls, string: str) -> SamplingType:
         """Convert string to an instance of the ``SamplingType`` class.
 
         Parameters
@@ -167,7 +167,7 @@ def from_str(string: str) -> SamplingType:
         TypeError
             Raised when an invalid type of ``string`` is given.
         """
-        return enum_from_str(string=string, enum_class=__class__, replace=(" ", "_"))
+        return enum_from_str(string=string, enum_class=cls, replace=(" ", "_"))
 
 
 class SlotType(Enum):
@@ -178,8 +178,8 @@ class SlotType(Enum):
     INNER_INPUT = 2
     INNER_OUTPUT = 3
 
-    @staticmethod
-    def from_str(string: str) -> SlotType:
+    @classmethod
+    def from_str(cls, string: str) -> SlotType:
         """Convert string to an instance of the ``SlotType`` class.
 
         Parameters
@@ -197,7 +197,7 @@ def from_str(string: str) -> SlotType:
         TypeError
             Raised when an invalid type of ``string`` is given.
         """
-        return enum_from_str(string=string, enum_class=__class__, replace=(" ", "_"))
+        return enum_from_str(string=string, enum_class=cls, replace=(" ", "_"))
 
     @staticmethod
     def to_dir_str(type_: SlotType) -> str:
@@ -486,7 +486,7 @@ def get_parent_name(self) -> str:  # pragma: no cover
         pass
 
     @abstractmethod
-    def get_property(self) -> Any:  # pragma: no cover
+    def get_property(self, name: str) -> Any:  # pragma: no cover
         """Get property from properties dictionary.
 
         Parameters
@@ -663,13 +663,13 @@ def get_available_output_locations(self) -> Tuple:  # pragma: no cover
 
     @abstractmethod
     def get_internal_variables(
-        self, include_reference_values: Optional[bool] = True
+        self, include_reference_values: bool = True
     ) -> Tuple:  # pragma: no cover
         """Get internal variables.
 
         Parameters
         ----------
-        include_reference_values: Optional[bool], optional
+        include_reference_values: bool
             Whether reference values are to be included. By default ``True``.
 
         Returns
@@ -690,13 +690,13 @@ def get_internal_variables(
 
     @abstractmethod
     def get_registered_input_slots(
-        self, include_reference_values: Optional[bool] = True
+        self, include_reference_values: bool = True
     ) -> Tuple:  # pragma: no cover
         """Get registered input slots.
 
         Parameters
         ----------
-        include_reference_values: Optional[bool], optional
+        include_reference_values: bool
             Whether reference values are to be included. By default ``True``.
 
         Returns
@@ -717,13 +717,13 @@ def get_registered_input_slots(
 
     @abstractmethod
     def get_registered_output_slots(
-        self, include_reference_values: Optional[bool] = True
+        self, include_reference_values: bool = True
     ) -> Tuple:  # pragma: no cover
         """Get registered output slots.
 
         Parameters
         ----------
-        include_reference_values: Optional[bool], optional
+        include_reference_values: bool
             Whether reference values are to be included. By default ``True``.
 
         Returns
@@ -744,13 +744,13 @@ def get_registered_output_slots(
 
     @abstractmethod
     def get_registered_parameters(
-        self, include_reference_values: Optional[bool] = True
+        self, include_reference_values: bool = True
     ) -> Tuple:  # pragma: no cover
         """Get registered parameters.
 
         Parameters
         ----------
-        include_reference_values: Optional[bool], optional
+        include_reference_values: bool
             Whether reference values are to be included. By default ``True``.
 
         Returns
@@ -771,13 +771,13 @@ def get_registered_parameters(
 
     @abstractmethod
     def get_registered_responses(
-        self, include_reference_values: Optional[bool] = True
+        self, include_reference_values: bool = True
     ) -> Tuple:  # pragma: no cover
         """Get registered responses.
 
         Parameters
         ----------
-        include_reference_values: Optional[bool], optional
+        include_reference_values: bool
             Whether reference values are to be included. By default ``True``.
 
         Returns
@@ -1261,6 +1261,7 @@ def get_inner_input_slots(self, name: Optional[str] = None) -> Tuple[InnerInputS
         """
         pass
 
+    @abstractmethod
     def get_inner_output_slots(self, name: Optional[str] = None) -> Tuple[InnerOutputSlot, ...]:
         """Get current node's inner output slots.
 
@@ -1361,7 +1362,7 @@ def __init__(self):  # pragma: no cover
     def control(
         self,
         command: str,
-        hid: Optional[str],
+        hid: Optional[str] = None,
         wait_for_completion: bool = True,
         timeout: Union[float, int] = 100,
     ) -> Optional[bool]:  # pragma: no cover
@@ -1543,7 +1544,7 @@ def type_hint(self) -> Optional[str]:  # pragma: no cover
         pass
 
     @abstractmethod
-    def get_connections(self) -> Tuple[Edge]:  # pragma: no cover
+    def get_connections(self) -> Tuple[Edge, ...]:  # pragma: no cover
         """Get connections for the current slot.
 
         Returns