Merge pull request #16 from gerlero/typing

Update type hints

foamlib/_dictionaries.py

@@ -15,11 +15,14 @@
 
 from ._subprocesses import run_process, CalledProcessError
 
-np: Optional[Any]
 try:
     import numpy as np
+    from numpy.typing import NDArray
 except ModuleNotFoundError:
-    np = None
+    numpy = False
+else:
+    numpy = True
+
 
 FoamDimensionSet = namedtuple(
     "FoamDimensionSet",
@@ -177,7 +180,7 @@ def _serialize_sequence(sequence: Any) -> str:
     if (
         isinstance(sequence, Sequence)
         and not isinstance(sequence, str)
-        or np
+        or numpy
         and isinstance(sequence, np.ndarray)
     ):
         return f"({' '.join(_serialize(v) for v in sequence)})"
@@ -216,7 +219,7 @@ def _serialize_dimensions(value: Any) -> str:
     if (
         isinstance(value, Sequence)
         and not isinstance(value, str)
-        or np
+        or numpy
         and isinstance(value, np.ndarray)
     ) and len(value) == 7:
         return f"[{' '.join(str(v) for v in value)}]"
@@ -372,7 +375,12 @@ def type(self, value: str) -> None:
     @property
     def value(
         self,
-    ) -> Union[int, float, Sequence[Union[int, float, Sequence[Union[int, float]]]]]:
+    ) -> Union[
+        int,
+        float,
+        Sequence[Union[int, float, Sequence[Union[int, float]]]],
+        NDArray[np.generic],
+    ]:
         """
         Alias of `self["value"]`.
         """
@@ -457,7 +465,12 @@ def dimensions(
     @property
     def internal_field(
         self,
-    ) -> Union[int, float, Sequence[Union[int, float, Sequence[Union[int, float]]]]]:
+    ) -> Union[
+        int,
+        float,
+        Sequence[Union[int, float, Sequence[Union[int, float]]]],
+        NDArray[np.generic],
+    ]:
         """
         Alias of `self["internalField"]`.
         """

tests/test_dictionaries.py

@@ -140,7 +140,7 @@ def test_internal_field(pitz: FoamCase) -> None:
     p_arr = np.arange(size) * 1e-6
     U_arr = np.full((size, 3), [-1e-6, 1e-6, 0]) * np.arange(size)[:, np.newaxis]
 
-    pitz[0]["p"].internal_field = p_arr  # type: ignore
+    pitz[0]["p"].internal_field = p_arr
     pitz[0]["U"].internal_field = U_arr
 
     assert pitz[0]["p"].internal_field == pytest.approx(p_arr)