foamlib 0.8.1__py3-none-any.whl → 0.8.3__py3-none-any.whl

foamlib/__init__.py

@@ -1,6 +1,6 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.8.1"
+__version__ = "0.8.3"
 
 from ._cases import (
     AsyncFoamCase,

foamlib/_cases/_async.py

@@ -106,7 +106,7 @@ class AsyncFoamCase(FoamCaseRunBase):
     async def _rmtree(
         path: os.PathLike[str] | str, *, ignore_errors: bool = False
     ) -> None:
-        await aioshutil.rmtree(path, ignore_errors=ignore_errors)
+        await aioshutil.rmtree(path, ignore_errors=ignore_errors)  # type: ignore [call-arg]
 
     @staticmethod
     async def _copytree(

foamlib/_files/_files.py

@@ -260,6 +260,11 @@ class FoamFile(
                         elif shape[1] == 9:
                             self.class_ = "volTensorField"
 
+            if kind == Kind.ASCII_FIELD and self.class_.endswith("scalarField"):
+                kind = Kind.SCALAR_ASCII_FIELD
+            elif kind == Kind.BINARY_FIELD and self.class_.endswith("scalarField"):
+                kind = Kind.SCALAR_BINARY_FIELD
+
             parsed = self._get_parsed(missing_ok=True)
 
             start, end = parsed.entry_location(keywords, missing_ok=True)

foamlib/_files/_parsing.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 import re
 import sys
-from enum import Enum, auto
 from typing import Tuple, Union, cast
 
 if sys.version_info >= (3, 9):
@@ -37,65 +36,31 @@ from pyparsing import (
     printables,
 )
 
-from ._types import Data, Dimensioned, DimensionSet, File
-
-
-class _Tensor(Enum):
-    SCALAR = auto()
-    VECTOR = auto()
-    SYMM_TENSOR = auto()
-    TENSOR = auto()
-
-    @property
-    def shape(self) -> tuple[()] | tuple[int]:
-        if self == _Tensor.SCALAR:
-            return ()
-        if self == _Tensor.VECTOR:
-            return (3,)
-        if self == _Tensor.SYMM_TENSOR:
-            return (6,)
-        if self == _Tensor.TENSOR:
-            return (9,)
-        raise NotImplementedError
-
-    @property
-    def size(self) -> int:
-        return {
-            _Tensor.SCALAR: 1,
-            _Tensor.VECTOR: 3,
-            _Tensor.SYMM_TENSOR: 6,
-            _Tensor.TENSOR: 9,
-        }[self]
-
-    def pattern(self, *, ignore: Regex | None = None) -> str:
-        float_pattern = r"(?i:[+-]?(?:(?:\d+\.?\d*(?:e[+-]?\d+)?)|nan|inf(?:inity)?))"
-
-        if self == _Tensor.SCALAR:
-            return float_pattern
-
-        ignore_pattern = (
-            rf"(?:\s|{ignore.re.pattern})+" if ignore is not None else r"\s+"
-        )
+from ._types import Data, Dimensioned, DimensionSet, File, TensorKind
 
-        return rf"\((?:{ignore_pattern})?(?:{float_pattern}{ignore_pattern}){{{self.size - 1}}}{float_pattern}(?:{ignore_pattern})?\)"
 
-    def parser(self) -> ParserElement:
-        if self == _Tensor.SCALAR:
-            return common.ieee_float
+def _tensor(tensor_kind: TensorKind, *, ignore: Regex | None = None) -> Regex:
+    float_pattern = r"(?i:[+-]?(?:(?:\d+\.?\d*(?:e[+-]?\d+)?)|nan|inf(?:inity)?))"
 
-        return (
-            Literal("(").suppress()
-            + Group(common.ieee_float[self.size], aslist=True)
-            + Literal(")").suppress()
-        ).add_parse_action(lambda tks: np.array(tks[0], dtype=float))
+    if tensor_kind == TensorKind.SCALAR:
+        ret = Regex(float_pattern)
+        ret.add_parse_action(lambda tks: [float(tks[0])])
+        return ret
+
+    ignore_pattern = rf"(?:\s|{ignore.re.pattern})+" if ignore is not None else r"\s+"
 
-    def __str__(self) -> str:
-        return {
-            _Tensor.SCALAR: "scalar",
-            _Tensor.VECTOR: "vector",
-            _Tensor.SYMM_TENSOR: "symmTensor",
-            _Tensor.TENSOR: "tensor",
-        }[self]
+    ret = Regex(
+        rf"\((?:{ignore_pattern})?(?:{float_pattern}{ignore_pattern}){{{tensor_kind.size - 1}}}{float_pattern}(?:{ignore_pattern})?\)"
+    )
+    ret.add_parse_action(
+        lambda tks: np.fromstring(
+            re.sub(ignore.re, " ", tks[0][1:-1])
+            if ignore is not None
+            else tks[0][1:-1],
+            sep=" ",
+        )
+    )
+    return ret
 
 
 def _list_of(entry: ParserElement) -> ParserElement:
@@ -118,43 +83,35 @@ def _list_of(entry: ParserElement) -> ParserElement:
 
 
 def _parse_ascii_field(
-    s: str, tensor_kind: _Tensor, *, ignore: Regex | None
+    s: str, tensor_kind: TensorKind, *, ignore: Regex | None
 ) -> np.ndarray[tuple[int] | tuple[int, int], np.dtype[np.float64]]:
     if ignore is not None:
         s = re.sub(ignore.re, " ", s)
     s = s.replace("(", " ").replace(")", " ")
 
-    return np.fromstring(s, dtype=float, sep=" ").reshape(-1, *tensor_kind.shape)
+    return np.fromstring(s, sep=" ").reshape(-1, *tensor_kind.shape)  # type: ignore [return-value]
 
 
 def _unpack_binary_field(
-    b: bytes, tensor_kind: _Tensor, *, length: int
+    b: bytes, tensor_kind: TensorKind, *, length: int
 ) -> np.ndarray[tuple[int] | tuple[int, int], np.dtype[np.float64 | np.float32]]:
     float_size = len(b) / tensor_kind.size / length
     assert float_size in (4, 8)
 
     dtype = np.float32 if float_size == 4 else float
-    return np.frombuffer(b, dtype=dtype).reshape(-1, *tensor_kind.shape)
+    return np.frombuffer(b, dtype=dtype).reshape(-1, *tensor_kind.shape)  # type: ignore [return-value]
 
 
 def _tensor_list(
-    tensor_kind: _Tensor | None = None, *, ignore: Regex | None = None
+    tensor_kind: TensorKind, *, ignore: Regex | None = None
 ) -> ParserElement:
-    if tensor_kind is None:
-        return (
-            _tensor_list(_Tensor.SCALAR, ignore=ignore)
-            | _tensor_list(_Tensor.VECTOR, ignore=ignore)
-            | _tensor_list(_Tensor.SYMM_TENSOR, ignore=ignore)
-            | _tensor_list(_Tensor.TENSOR, ignore=ignore)
-        )
-
-    tensor_pattern = tensor_kind.pattern(ignore=ignore)
+    tensor = _tensor(tensor_kind, ignore=ignore)
     ignore_pattern = rf"(?:\s|{ignore.re.pattern})+" if ignore is not None else r"\s+"
 
     list_ = Forward()
 
     list_ <<= Regex(
-        rf"\((?:{ignore_pattern})?(?:{tensor_pattern}{ignore_pattern})*{tensor_pattern}(?:{ignore_pattern})?\)"
+        rf"\((?:{ignore_pattern})?(?:{tensor.re.pattern}{ignore_pattern})*{tensor.re.pattern}(?:{ignore_pattern})?\)"
     ).add_parse_action(
         lambda tks: [_parse_ascii_field(tks[0], tensor_kind, ignore=ignore)]
     )
@@ -166,7 +123,7 @@ def _tensor_list(
 
         list_ <<= (
             Regex(
-                rf"\((?:{ignore_pattern})?(?:{tensor_pattern}{ignore_pattern}){{{length - 1}}}{tensor_pattern}(?:{ignore_pattern})?\)"
+                rf"\((?:{ignore_pattern})?(?:{tensor.re.pattern}{ignore_pattern}){{{length - 1}}}{tensor.re.pattern}(?:{ignore_pattern})?\)"
             ).add_parse_action(
                 lambda tks: [_parse_ascii_field(tks[0], tensor_kind, ignore=ignore)]
             )
@@ -180,7 +137,7 @@ def _tensor_list(
                 ]
             )
             | (
-                Literal("{").suppress() + tensor_kind.parser() + Literal("}").suppress()
+                Literal("{").suppress() + tensor + Literal("}").suppress()
             ).add_parse_action(
                 lambda tks: [np.full((length, *tensor_kind.shape), tks[0], dtype=float)]
             )
@@ -261,20 +218,27 @@ _DIMENSIONS = (
     Literal("[").suppress() + common.number[0, 7] + Literal("]").suppress()
 ).set_parse_action(lambda tks: DimensionSet(*tks))
 _TENSOR = (
-    _Tensor.SCALAR.parser()
-    | _Tensor.VECTOR.parser()
-    | _Tensor.SYMM_TENSOR.parser()
-    | _Tensor.TENSOR.parser()
+    _tensor(TensorKind.SCALAR)
+    | _tensor(TensorKind.VECTOR)
+    | _tensor(TensorKind.SYMM_TENSOR)
+    | _tensor(TensorKind.TENSOR)
 )
-_IDENTIFIER = Combine(
+_IDENTIFIER = Forward()
+_IDENTIFIER <<= Combine(
     Word(_IDENTCHARS, _IDENTBODYCHARS, exclude_chars="()")
-    + Opt(Literal("(") + Word(_IDENTBODYCHARS, exclude_chars="()") + Literal(")"))
+    + Opt(Literal("(") + _IDENTIFIER + Literal(")"))
 )
 _DIMENSIONED = (Opt(_IDENTIFIER) + _DIMENSIONS + _TENSOR).set_parse_action(
     lambda tks: Dimensioned(*reversed(tks.as_list()))
 )
 _FIELD = (Keyword("uniform", _IDENTBODYCHARS).suppress() + _TENSOR) | (
-    Keyword("nonuniform", _IDENTBODYCHARS).suppress() + _tensor_list(ignore=_COMMENT)
+    Keyword("nonuniform", _IDENTBODYCHARS).suppress()
+    + (
+        _tensor_list(TensorKind.SCALAR, ignore=_COMMENT)
+        | _tensor_list(TensorKind.VECTOR, ignore=_COMMENT)
+        | _tensor_list(TensorKind.SYMM_TENSOR, ignore=_COMMENT)
+        | _tensor_list(TensorKind.TENSOR, ignore=_COMMENT)
+    )
 )
 _TOKEN = dbl_quoted_string | _IDENTIFIER
 _DATA = Forward()

foamlib/_files/_serialization.py

@@ -19,7 +19,9 @@ class Kind(Enum):
     DEFAULT = auto()
     SINGLE_ENTRY = auto()
     ASCII_FIELD = auto()
+    SCALAR_ASCII_FIELD = auto()
     BINARY_FIELD = auto()
+    SCALAR_BINARY_FIELD = auto()
     DIMENSIONS = auto()
 
 
@@ -32,7 +34,12 @@ def normalize(data: Entry, *, kind: Kind = Kind.DEFAULT) -> Entry: ...
 
 
 def normalize(data: Entry, *, kind: Kind = Kind.DEFAULT) -> Entry:
-    if kind in (Kind.ASCII_FIELD, Kind.BINARY_FIELD):
+    if kind in (
+        Kind.ASCII_FIELD,
+        Kind.SCALAR_ASCII_FIELD,
+        Kind.BINARY_FIELD,
+        Kind.SCALAR_BINARY_FIELD,
+    ):
         if is_sequence(data):
             try:
                 arr = np.asarray(data)
@@ -43,7 +50,7 @@ def normalize(data: Entry, *, kind: Kind = Kind.DEFAULT) -> Entry:
                     arr = arr.astype(float)
 
                 if arr.ndim == 1 or (arr.ndim == 2 and arr.shape[1] in (3, 6, 9)):
-                    return arr
+                    return arr  # type: ignore [return-value]
 
             return data
 
@@ -112,11 +119,17 @@ def dumps(
     if isinstance(data, DimensionSet):
         return b"[" + b" ".join(dumps(v) for v in data) + b"]"
 
-    if kind in (Kind.ASCII_FIELD, Kind.BINARY_FIELD) and (
-        isinstance(data, (int, float, np.ndarray))
-    ):
+    if kind in (
+        Kind.ASCII_FIELD,
+        Kind.SCALAR_ASCII_FIELD,
+        Kind.BINARY_FIELD,
+        Kind.SCALAR_BINARY_FIELD,
+    ) and (isinstance(data, (int, float, np.ndarray))):
         shape = np.shape(data)
-        if shape in ((), (3,), (6,), (9,)):
+        if not shape or (
+            kind not in (Kind.SCALAR_ASCII_FIELD, Kind.SCALAR_BINARY_FIELD)
+            and shape in ((3,), (6,), (9,))
+        ):
             return b"uniform " + dumps(data, kind=Kind.SINGLE_ENTRY)
 
         assert isinstance(data, np.ndarray)
@@ -137,10 +150,10 @@ def dumps(
         else:
             return dumps(data)
 
-        if kind == Kind.BINARY_FIELD:
+        if kind in (Kind.BINARY_FIELD, Kind.SCALAR_BINARY_FIELD):
             contents = b"(" + data.tobytes() + b")"
         else:
-            assert kind == Kind.ASCII_FIELD
+            assert kind in (Kind.ASCII_FIELD, Kind.SCALAR_ASCII_FIELD)
             contents = dumps(data, kind=Kind.SINGLE_ENTRY)
 
         return b"nonuniform List<" + tensor_kind + b"> " + dumps(len(data)) + contents

foamlib/_files/_types.py

@@ -2,7 +2,8 @@ from __future__ import annotations
 
 import sys
 from dataclasses import dataclass
-from typing import Dict, NamedTuple, Optional, Tuple, Union
+from enum import Enum
+from typing import Dict, NamedTuple, Optional, Union
 
 import numpy as np
 
@@ -33,10 +34,43 @@ class DimensionSet(NamedTuple):
 Tensor = Union[
     float,
     Sequence[float],
-    "np.ndarray[tuple[()] | Tuple[int], np.dtype[np.float64]]",
+    "np.ndarray[tuple[()] | tuple[int], np.dtype[np.float64]]",
 ]
 
 
+class TensorKind(Enum):
+    SCALAR = ()
+    VECTOR = (3,)
+    SYMM_TENSOR = (6,)
+    TENSOR = (9,)
+
+    @property
+    def shape(self) -> tuple[()] | tuple[int]:
+        shape: tuple[()] | tuple[int] = self.value
+        return shape
+
+    @property
+    def size(self) -> int:
+        return int(np.prod(self.shape))
+
+    def __str__(self) -> str:
+        return {
+            TensorKind.SCALAR: "scalar",
+            TensorKind.VECTOR: "vector",
+            TensorKind.SYMM_TENSOR: "symmTensor",
+            TensorKind.TENSOR: "tensor",
+        }[self]
+
+    @staticmethod
+    def from_shape(shape: tuple[int, ...]) -> TensorKind:
+        for kind in TensorKind:
+            if kind.shape == shape:
+                return kind
+
+        msg = f"No tensor kind for shape {shape!r}"
+        raise ValueError(msg)
+
+
 @dataclass
 class Dimensioned:
     value: Tensor = 0
@@ -45,7 +79,7 @@ class Dimensioned:
 
     def __post_init__(self) -> None:
         if is_sequence(self.value):
-            self.value = np.asarray(self.value, dtype=float)
+            self.value = np.asarray(self.value, dtype=float)  # type: ignore [assignment]
         else:
             assert isinstance(self.value, (int, float, np.ndarray))
             self.value = float(self.value)

{foamlib-0.8.1.dist-info → foamlib-0.8.3.dist-info}/METADATA

@@ -1,11 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: foamlib
-Version: 0.8.1
+Version: 0.8.3
 Summary: A Python interface for interacting with OpenFOAM
 Project-URL: Homepage, https://github.com/gerlero/foamlib
 Project-URL: Repository, https://github.com/gerlero/foamlib
 Project-URL: Documentation, https://foamlib.readthedocs.io
 Author-email: "Gabriel S. Gerlero" <ggerlero@cimec.unl.edu.ar>
+License-File: LICENSE.txt
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: AsyncIO
 Classifier: Intended Audience :: Developers
@@ -27,11 +28,11 @@ Requires-Python: >=3.7
 Requires-Dist: aioshutil<2,>=1
 Requires-Dist: numpy<3,>=1
 Requires-Dist: numpy<3,>=1.25.0; python_version >= '3.10'
-Requires-Dist: pyparsing<4,>=3
+Requires-Dist: pyparsing<4,>=3.1.2
 Requires-Dist: typing-extensions<5,>=4; python_version < '3.11'
 Provides-Extra: dev
 Requires-Dist: mypy<2,>=1; extra == 'dev'
-Requires-Dist: pytest-asyncio<0.25,>=0.21; extra == 'dev'
+Requires-Dist: pytest-asyncio<0.26,>=0.21; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: pytest<9,>=7; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
@@ -43,12 +44,12 @@ Requires-Dist: sphinx<9,>=5; extra == 'docs'
 Provides-Extra: lint
 Requires-Dist: ruff; extra == 'lint'
 Provides-Extra: test
-Requires-Dist: pytest-asyncio<0.25,>=0.21; extra == 'test'
+Requires-Dist: pytest-asyncio<0.26,>=0.21; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'
 Requires-Dist: pytest<9,>=7; extra == 'test'
 Provides-Extra: typing
 Requires-Dist: mypy<2,>=1; extra == 'typing'
-Requires-Dist: pytest-asyncio<0.25,>=0.21; extra == 'typing'
+Requires-Dist: pytest-asyncio<0.26,>=0.21; extra == 'typing'
 Requires-Dist: pytest-cov; extra == 'typing'
 Requires-Dist: pytest<9,>=7; extra == 'typing'
 Description-Content-Type: text/markdown

{foamlib-0.8.1.dist-info → foamlib-0.8.3.dist-info}/RECORD

@@ -1,7 +1,7 @@
-foamlib/__init__.py,sha256=TATCOFe7Qz20bMXgF1iX2nZmLzME7Wtg3gIocDfQTZk,452
+foamlib/__init__.py,sha256=ZODAE7gaDlcc4N4EKtrB1AyZz5tuAbw9rgkfSM-WKew,452
 foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 foamlib/_cases/__init__.py,sha256=_A1TTHuQfS9FH2_33lSEyLtOJZGFHZBco1tWJCVOHks,358
-foamlib/_cases/_async.py,sha256=i6g4EBHqvI-1PkdrxsRto2ynW7sxsOga2bSYk1XVG1U,7795
+foamlib/_cases/_async.py,sha256=onECxRLQCF7Kd-GeuLqH_Xv3gbMMhKOSbFaUG5Ttgmk,7822
 foamlib/_cases/_base.py,sha256=37oBbM3NM-hpG7dKewZvyJNtqSAogMurcbmX-wLIgMU,6727
 foamlib/_cases/_run.py,sha256=lveqKZium_qK_eTxYE8jOjwx0eiIoolCBbi56-zLw1o,14420
 foamlib/_cases/_slurm.py,sha256=kj4wqgr3foMyAoUkoHOZODRBmVqH1B9KqAIEEjM8ZBg,2328
@@ -9,12 +9,12 @@ foamlib/_cases/_subprocess.py,sha256=6BlBRxknj2-BFcGkx7oVcuL63_utSaY1Axmsc1qV9j8
 foamlib/_cases/_sync.py,sha256=2BJXB7Nzldb4OgPukqupgYqdceUGkI2mYhhtGPWEBrc,5901
 foamlib/_cases/_util.py,sha256=tK4SM5WT3eEgGsFLnidIySbom1qowBAua9z13gipKJk,1518
 foamlib/_files/__init__.py,sha256=q1vkjXnjnSZvo45jPAICpWeF2LZv5V6xfzAR6S8fS5A,96
-foamlib/_files/_files.py,sha256=hVzsAhUFukF7sGLUNp1wFUkzIMpRfrpKCKObLj8MKhA,15070
+foamlib/_files/_files.py,sha256=5sxtHQuN25w1gszZBpSMOaF--KOJy2HLmM6CScLof9s,15331
 foamlib/_files/_io.py,sha256=BGbbm6HKxL2ka0YMCmHqZQZ1R4PPQlkvWWb4FHMAS8k,2217
-foamlib/_files/_parsing.py,sha256=iKtreUueJ3NrE8a2cIpUf4zF7z3o4pJtKLufx0mnb3A,13986
-foamlib/_files/_serialization.py,sha256=Vuq9Ityb55a7kheGCqeuMHyzddb4mXozglMsc90_3Cc,4746
-foamlib/_files/_types.py,sha256=3l6MCwyK1wAv3B5xJsyF9Q4Ndgt-BF8zCd1N7_ZBxPM,2554
-foamlib-0.8.1.dist-info/METADATA,sha256=izsNijMcEBsVrrgyWoLzx80Gi6LoJ5PAIM4zNVngxwk,7938
-foamlib-0.8.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-foamlib-0.8.1.dist-info/licenses/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
-foamlib-0.8.1.dist-info/RECORD,,
+foamlib/_files/_parsing.py,sha256=1lwXdcsYrHXONbNbLYkl9wvwFBCcBt3-eVJUVcL3pIM,13055
+foamlib/_files/_serialization.py,sha256=Tp3Sx5Kav4Bh1K98FAYiN0O7hBVizu8eP-sDC_ZDmfc,5176
+foamlib/_files/_types.py,sha256=m-fFjJnS4sFSavDsijlXpAfEhnbh10RBumSHAT0GOgQ,3408
+foamlib-0.8.3.dist-info/METADATA,sha256=wJxGTASnWb3zZmfB0UWPdytUbVs13sJ8TogpaQJ8Pik,7968
+foamlib-0.8.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+foamlib-0.8.3.dist-info/licenses/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
+foamlib-0.8.3.dist-info/RECORD,,

{foamlib-0.8.1.dist-info → foamlib-0.8.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any