foamlib 0.2.6__py3-none-any.whl → 0.2.7__py3-none-any.whl

foamlib/__init__.py

@@ -1,6 +1,6 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.2.6"
+__version__ = "0.2.7"
 
 from ._cases import AsyncFoamCase, FoamCase, FoamCaseBase
 from ._dictionaries import FoamDictionaryBase, FoamFieldFile, FoamFile

foamlib/_dictionaries/_base.py

@@ -4,9 +4,15 @@ from dataclasses import dataclass
 from typing import Dict, NamedTuple, Optional, Union
 
 if sys.version_info >= (3, 9):
-    from collections.abc import Sequence
+    from collections.abc import Mapping, Sequence
 else:
-    from typing import Sequence
+    from typing import Mapping, Sequence
+
+try:
+    import numpy as np
+    from numpy.typing import NDArray
+except ModuleNotFoundError:
+    pass
 
 
 class FoamDictionaryBase:
@@ -39,9 +45,13 @@ class FoamDictionaryBase:
     A value that can be stored in an OpenFOAM dictionary.
     """
 
-    _Dict = Dict[str, Union["FoamDictionaryBase.Value", "_Dict"]]
+    _Dict = Dict[str, Union["Value", "_Dict"]]
 
     @abstractmethod
     def as_dict(self) -> _Dict:
         """Return a nested dict representation of the dictionary."""
         raise NotImplementedError
+
+    _SetValue = Union[Value, "NDArray[np.generic]"]
+
+    _SetMapping = Mapping[str, Union["_SetValue", "_SetMapping"]]

foamlib/_dictionaries/_files.py

@@ -1,9 +1,11 @@
 import sys
 from pathlib import Path
+from types import TracebackType
 from typing import (
     Any,
     Optional,
     Tuple,
+    Type,
     Union,
     cast,
 )
@@ -48,7 +50,12 @@ class _FoamFileBase:
         self.__defer_io += 1
         return self
 
-    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
+    def __exit__(
+        self,
+        exc_type: Optional[Type[BaseException]],
+        exc_val: Optional[BaseException],
+        exc_tb: Optional[TracebackType],
+    ) -> None:
         self.__defer_io -= 1
         if self.__defer_io == 0 and self.__dirty:
             assert self.__contents is not None
@@ -124,7 +131,11 @@ class FoamFile(
                 assume_dimensions=assume_dimensions,
             )
 
-        def __setitem__(self, keyword: str, value: Any) -> None:
+        def __setitem__(
+            self,
+            keyword: str,
+            value: Union["FoamFile._SetValue", "FoamFile._SetMapping"],
+        ) -> None:
             self._setitem(keyword, value)
 
         def __delitem__(self, keyword: str) -> None:
@@ -180,7 +191,7 @@ class FoamFile(
     def _setitem(
         self,
         keywords: Union[str, Tuple[str, ...]],
-        value: Any,
+        value: Union["FoamFile._SetValue", "FoamFile._SetMapping"],
         *,
         assume_field: bool = False,
         assume_dimensions: bool = False,
@@ -210,7 +221,11 @@ class FoamFile(
                 f"{contents[:start]}\n{serialize_entry(keywords[-1], value, assume_field=assume_field, assume_dimensions=assume_dimensions)}\n{contents[end:]}"
             )
 
-    def __setitem__(self, keywords: Union[str, Tuple[str, ...]], value: Any) -> None:
+    def __setitem__(
+        self,
+        keywords: Union[str, Tuple[str, ...]],
+        value: Union["FoamFile._SetValue", "FoamFile._SetMapping"],
+    ) -> None:
         self._setitem(keywords, value)
 
     def __delitem__(self, keywords: Union[str, Tuple[str, ...]]) -> None:
@@ -274,7 +289,11 @@ class FoamFieldFile(FoamFile):
     class BoundaryDictionary(FoamFile.Dictionary):
         """An OpenFOAM dictionary representing a boundary condition as a mutable mapping."""
 
-        def __setitem__(self, key: str, value: Any) -> None:
+        def __setitem__(
+            self,
+            key: str,
+            value: Union[FoamFile._SetValue, FoamFile._SetMapping],
+        ) -> None:
             if key == "value":
                 self._setitem(key, value, assume_field=True)
             else:

foamlib/_dictionaries/_serialization.py

@@ -1,6 +1,6 @@
 import sys
 from contextlib import suppress
-from typing import Any
+from typing import Union
 
 if sys.version_info >= (3, 9):
     from collections.abc import Mapping
@@ -11,7 +11,9 @@ from .._util import is_sequence
 from ._base import FoamDictionaryBase
 
 
-def _serialize_switch(value: Any) -> str:
+def _serialize_switch(
+    value: Union[FoamDictionaryBase._SetValue, FoamDictionaryBase._SetMapping],
+) -> str:
     if value is True:
         return "yes"
     elif value is False:
@@ -20,14 +22,18 @@ def _serialize_switch(value: Any) -> str:
         raise TypeError(f"Not a bool: {type(value)}")
 
 
-def _serialize_list(value: Any) -> str:
+def _serialize_list(
+    value: Union[FoamDictionaryBase._SetValue, FoamDictionaryBase._SetMapping],
+) -> str:
     if is_sequence(value):
         return f"({' '.join(_serialize_value(v) for v in value)})"
     else:
         raise TypeError(f"Not a valid sequence: {type(value)}")
 
 
-def _serialize_field(value: Any) -> str:
+def _serialize_field(
+    value: Union[FoamDictionaryBase._SetValue, FoamDictionaryBase._SetMapping],
+) -> str:
     if is_sequence(value):
         try:
             s = _serialize_list(value)
@@ -54,14 +60,18 @@ def _serialize_field(value: Any) -> str:
         return f"uniform {value}"
 
 
-def _serialize_dimensions(value: Any) -> str:
+def _serialize_dimensions(
+    value: Union[FoamDictionaryBase._SetValue, FoamDictionaryBase._SetMapping],
+) -> str:
     if is_sequence(value) and len(value) == 7:
         return f"[{' '.join(str(v) for v in value)}]"
     else:
         raise TypeError(f"Not a valid dimension set: {type(value)}")
 
 
-def _serialize_dimensioned(value: Any) -> str:
+def _serialize_dimensioned(
+    value: Union[FoamDictionaryBase._SetValue, FoamDictionaryBase._SetMapping],
+) -> str:
     if isinstance(value, FoamDictionaryBase.Dimensioned):
         if value.name is not None:
             return f"{value.name} {_serialize_dimensions(value.dimensions)} {_serialize_value(value.value)}"
@@ -72,7 +82,10 @@ def _serialize_dimensioned(value: Any) -> str:
 
 
 def _serialize_value(
-    value: Any, *, assume_field: bool = False, assume_dimensions: bool = False
+    value: Union[FoamDictionaryBase._SetValue, FoamDictionaryBase._SetMapping],
+    *,
+    assume_field: bool = False,
+    assume_dimensions: bool = False,
 ) -> str:
     if isinstance(value, FoamDictionaryBase.DimensionSet) or assume_dimensions:
         with suppress(TypeError):
@@ -94,7 +107,9 @@ def _serialize_value(
     return str(value)
 
 
-def _serialize_dictionary(value: Any) -> str:
+def _serialize_dictionary(
+    value: Union[FoamDictionaryBase._SetValue, FoamDictionaryBase._SetMapping],
+) -> str:
     if isinstance(value, Mapping):
         return "\n".join(serialize_entry(k, v) for k, v in value.items())
     else:
@@ -103,7 +118,7 @@ def _serialize_dictionary(value: Any) -> str:
 
 def serialize_entry(
     keyword: str,
-    value: Any,
+    value: Union[FoamDictionaryBase._SetValue, FoamDictionaryBase._SetMapping],
     *,
     assume_field: bool = False,
     assume_dimensions: bool = False,

{foamlib-0.2.6.dist-info → foamlib-0.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.2.6
+Version: 0.2.7
 Summary: A Python interface for interacting with OpenFOAM
 Author-email: "Gabriel S. Gerlero" <ggerlero@cimec.unl.edu.ar>
 Project-URL: Homepage, https://github.com/gerlero/foamlib

foamlib-0.2.7.dist-info/RECORD

@@ -0,0 +1,14 @@
+foamlib/__init__.py,sha256=ZWFEP5x2m2c9zMrODOS9_vL4bf6FPnK7BY-DTLXu3JU,344
+foamlib/_cases.py,sha256=SjDTVauOlcrtyvnt5uxWGSu2RYZ0lhKRmvMnuRnRuzI,20973
+foamlib/_util.py,sha256=PBTpBwt_j1GXASncSDZUR8pH2u_h8UyJXm8GeFKebTY,2552
+foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foamlib/_dictionaries/__init__.py,sha256=vxGpA7uaEbJwKFGOYdLFR6R9jcUj_HW60YzZBMjNXRo,160
+foamlib/_dictionaries/_base.py,sha256=i_RRwJYP11fG-e9jAqH2lN5wz4BOPNWs_frqyLInSrc,1809
+foamlib/_dictionaries/_files.py,sha256=ZIIImssk9Xqgx8kYz_mr2e3IHGze1J96BvDQxQeNVaA,12912
+foamlib/_dictionaries/_parsing.py,sha256=s6t9JJxAjsSp3ypeQNeskgtYWsbb52iBjrVDTUv56jc,5008
+foamlib/_dictionaries/_serialization.py,sha256=kaec7AzGOERmPAeMP3Li1ZU7jyectsUS5WHgQbeT-2Y,4045
+foamlib-0.2.7.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
+foamlib-0.2.7.dist-info/METADATA,sha256=wwLtfgXWX2iXnqLI7jVNZHIpoVE52ZDpWvhibNc6wmA,4650
+foamlib-0.2.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+foamlib-0.2.7.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
+foamlib-0.2.7.dist-info/RECORD,,

foamlib-0.2.6.dist-info/RECORD

@@ -1,14 +0,0 @@
-foamlib/__init__.py,sha256=Y-_qOUsVNMpblI4RzK4j1yA1IsImanCa_v2miOUK_jQ,344
-foamlib/_cases.py,sha256=SjDTVauOlcrtyvnt5uxWGSu2RYZ0lhKRmvMnuRnRuzI,20973
-foamlib/_util.py,sha256=PBTpBwt_j1GXASncSDZUR8pH2u_h8UyJXm8GeFKebTY,2552
-foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foamlib/_dictionaries/__init__.py,sha256=vxGpA7uaEbJwKFGOYdLFR6R9jcUj_HW60YzZBMjNXRo,160
-foamlib/_dictionaries/_base.py,sha256=RRbuZT_wzbhVyhpP4RIw5_pY3AW62MZJQveLJ2bVD-4,1587
-foamlib/_dictionaries/_files.py,sha256=gYeimu-8ZXyUaHf5jXp8zLE-Kvnzb6x0TZlbjNTVA0I,12457
-foamlib/_dictionaries/_parsing.py,sha256=s6t9JJxAjsSp3ypeQNeskgtYWsbb52iBjrVDTUv56jc,5008
-foamlib/_dictionaries/_serialization.py,sha256=1QJMxK0zXilpQoWR0ZPW2OImF1WRhXfuVDy-iCuELJc,3476
-foamlib-0.2.6.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
-foamlib-0.2.6.dist-info/METADATA,sha256=Y10E-baTUs-CytAKybJIZtvslXkjnKxwPylTdXpEbD8,4650
-foamlib-0.2.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-foamlib-0.2.6.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
-foamlib-0.2.6.dist-info/RECORD,,