foamlib 0.3.2__py3-none-any.whl → 0.3.4__py3-none-any.whl

foamlib/__init__.py

@@ -1,6 +1,6 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.3.2"
+__version__ = "0.3.4"
 
 from ._cases import AsyncFoamCase, FoamCase, FoamCaseBase
 from ._files import FoamDict, FoamFieldFile, FoamFile

foamlib/_cases.py

@@ -32,7 +32,7 @@ from ._util import is_sequence, run_process, run_process_async
 
 
 class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
-    def __init__(self, path: Union[Path, str]):
+    def __init__(self, path: Union[Path, str] = Path()):
         self.path = Path(path).absolute()
         if not self.path.is_dir():
             raise NotADirectoryError(f"{self.path} is not a directory")
@@ -87,7 +87,7 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
             return str(self.path)
 
         def __repr__(self) -> str:
-            return f"{type(self).__name__}({self.path})"
+            return f"{type(self).__name__}('{self.path}')"
 
         def __str__(self) -> str:
             return str(self.path)
@@ -298,7 +298,7 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
         return str(self.path)
 
     def __repr__(self) -> str:
-        return f"{type(self).__name__}({self.path})"
+        return f"{type(self).__name__}('{self.path}')"
 
     def __str__(self) -> str:
         return str(self.path)

foamlib/_files/_fields.py

@@ -65,7 +65,12 @@ class FoamFieldFile(FoamFile):
             ret = self["value"]
             if not isinstance(ret, (int, float, Sequence)):
                 raise TypeError("value is not a field")
-            return cast(Union[int, float, Sequence[Union[int, float]]], ret)
+            return cast(
+                Union[
+                    int, float, Sequence[Union[int, float, Sequence[Union[int, float]]]]
+                ],
+                ret,
+            )
 
         @value.setter
         def value(
@@ -111,7 +116,7 @@ class FoamFieldFile(FoamFile):
             self._setitem(keywords, value)
 
     @property
-    def dimensions(self) -> FoamFile.DimensionSet:
+    def dimensions(self) -> Union[FoamFile.DimensionSet, Sequence[Union[int, float]]]:
         """Alias of `self["dimensions"]`."""
         ret = self["dimensions"]
         if not isinstance(ret, FoamFile.DimensionSet):

foamlib/_files/_files.py

@@ -12,7 +12,7 @@ else:
 
 from ._base import FoamDict
 from ._io import FoamFileIO
-from ._serialization import dumps
+from ._serialization import dumpb
 
 
 class FoamFile(
@@ -84,7 +84,7 @@ class FoamFile(
                 super().clear()
 
         def __repr__(self) -> str:
-            return f"{type(self).__qualname__}({self._file}, {self._keywords})"
+            return f"{type(self).__qualname__}('{self._file}', {self._keywords})"
 
         def as_dict(self) -> FoamDict._Dict:
             """Return a nested dict representation of the dictionary."""
@@ -113,6 +113,10 @@ class FoamFile(
         else:
             return value  # type: ignore [return-value]
 
+    @property
+    def _binary(self) -> bool:
+        return self.get(("FoamFile", "format"), None) == "binary"
+
     def _setitem(
         self,
         keywords: Union[str, Tuple[str, ...]],
@@ -134,7 +138,11 @@ class FoamFile(
                 start, end = parsed.entry_location(keywords, missing_ok=True)
 
                 self._write(
-                    f"{contents[:start]}\n{dumps({keywords[-1]: {}})}\n{contents[end:]}"
+                    contents[:start]
+                    + b"\n"
+                    + dumpb({keywords[-1]: {}})
+                    + b"\n"
+                    + contents[end:]
                 )
 
                 for k, v in data.items():
@@ -143,7 +151,16 @@ class FoamFile(
             start, end = parsed.entry_location(keywords, missing_ok=True)
 
             self._write(
-                f"{contents[:start]}\n{dumps({keywords[-1]: data}, assume_field=assume_field, assume_dimensions=assume_dimensions)}\n{contents[end:]}"
+                contents[:start]
+                + b"\n"
+                + dumpb(
+                    {keywords[-1]: data},
+                    assume_field=assume_field,
+                    assume_dimensions=assume_dimensions,
+                    binary_fields=self._binary,
+                )
+                + b"\n"
+                + contents[end:]
             )
 
     def __setitem__(
@@ -194,9 +211,6 @@ class FoamFile(
     def __fspath__(self) -> str:
         return str(self.path)
 
-    def __repr__(self) -> str:
-        return f"{type(self).__name__}({self.path})"
-
     def as_dict(self) -> FoamDict._Dict:
         """Return a nested dict representation of the file."""
         _, parsed = self._read()

foamlib/_files/_io.py

@@ -25,7 +25,7 @@ class FoamFileIO:
         elif not self.path.is_file():
             raise FileNotFoundError(self.path)
 
-        self.__contents: Optional[str] = None
+        self.__contents: Optional[bytes] = None
         self.__parsed: Optional[Parsed] = None
         self.__defer_io = 0
         self.__dirty = False
@@ -48,9 +48,9 @@ class FoamFileIO:
             self._write(self.__contents)
         assert not self.__dirty
 
-    def _read(self) -> Tuple[str, Parsed]:
+    def _read(self) -> Tuple[bytes, Parsed]:
         if not self.__defer_io:
-            contents = self.path.read_text()
+            contents = self.path.read_bytes()
             if contents != self.__contents:
                 self.__contents = contents
                 self.__parsed = None
@@ -63,11 +63,14 @@ class FoamFileIO:
 
         return self.__contents, deepcopy(self.__parsed)
 
-    def _write(self, contents: str) -> None:
+    def _write(self, contents: bytes) -> None:
         self.__contents = contents
         self.__parsed = None
         if not self.__defer_io:
-            self.path.write_text(contents)
+            self.path.write_bytes(contents)
             self.__dirty = False
         else:
             self.__dirty = True
+
+    def __repr__(self) -> str:
+        return f"{type(self).__name__}('{self.path}')"

foamlib/_files/_parsing.py

@@ -1,3 +1,4 @@
+import array
 import sys
 from typing import Tuple, Union
 
@@ -12,6 +13,7 @@ else:
     from typing import Any as EllipsisType
 
 from pyparsing import (
+    CharsNotIn,
     Dict,
     Forward,
     Group,
@@ -27,7 +29,7 @@ from pyparsing import (
     c_style_comment,
     common,
     cpp_style_comment,
-    identbodychars,
+    identchars,
     printables,
 )
 
@@ -74,6 +76,56 @@ def _dictionary_of(
     return Dict(Group(keyword_entry)[len], asdict=not located)
 
 
+_binary_contents = Forward()
+
+
+def _binary_field_parse_action(tks: ParseResults) -> None:
+    global _binary_contents
+
+    kind, count = tks
+    if kind == "scalar":
+        elsize = 1
+    elif kind == "vector":
+        elsize = 3
+    elif kind == "symmTensor":
+        elsize = 6
+    elif kind == "tensor":
+        elsize = 9
+
+    def unpack(
+        tks: ParseResults,
+    ) -> Sequence[Union[Sequence[float], Sequence[Sequence[float]]]]:
+        bytes_ = tks[0].encode("latin-1")
+
+        arr = array.array("d", bytes_)
+
+        if elsize != 1:
+            all = [arr[i : i + elsize].tolist() for i in range(0, len(arr), elsize)]
+        else:
+            all = arr.tolist()
+
+        return [all]
+
+    _binary_contents <<= CharsNotIn(exact=count * elsize * 8).set_parse_action(unpack)
+
+    tks.clear()  # type: ignore [no-untyped-call]
+
+
+_BINARY_FIELD = (
+    (
+        Keyword("nonuniform").suppress()
+        + Literal("List").suppress()
+        + Literal("<").suppress()
+        + common.identifier
+        + Literal(">").suppress()
+        + common.integer
+        + Literal("(").suppress()
+    ).set_parse_action(_binary_field_parse_action, call_during_try=True)
+    + _binary_contents
+    + Literal(")").suppress()
+)
+
+
 _SWITCH = (
     Keyword("yes") | Keyword("true") | Keyword("on") | Keyword("y") | Keyword("t")
 ).set_parse_action(lambda: True) | (
@@ -83,12 +135,14 @@ _DIMENSIONS = (
     Literal("[").suppress() + common.number * 7 + Literal("]").suppress()
 ).set_parse_action(lambda tks: FoamDict.DimensionSet(*tks))
 _TENSOR = _list_of(common.number) | common.number
-_IDENTIFIER = Word(identbodychars + "$", printables.replace(";", ""))
+_IDENTIFIER = Word(identchars + "$", printables, exclude_chars=";")
 _DIMENSIONED = (Opt(_IDENTIFIER) + _DIMENSIONS + _TENSOR).set_parse_action(
     lambda tks: FoamDict.Dimensioned(*reversed(tks.as_list()))
 )
-_FIELD = (Keyword("uniform").suppress() + _TENSOR) | (
-    Keyword("nonuniform").suppress() + _list_of(_TENSOR)
+_FIELD = (
+    (Keyword("uniform").suppress() + _TENSOR)
+    | (Keyword("nonuniform").suppress() + _list_of(_TENSOR))
+    | _BINARY_FIELD
 )
 _TOKEN = QuotedString('"', unquote_results=False) | _IDENTIFIER
 _DATA = Forward()
@@ -109,16 +163,19 @@ _FILE = (
     .ignore(c_style_comment)
     .ignore(cpp_style_comment)
     .ignore(Literal("#include") + ... + LineEnd())  # type: ignore [no-untyped-call]
+    .parse_with_tabs()
 )
 
 
 class Parsed(Mapping[Tuple[str, ...], Union[FoamDict.Data, EllipsisType]]):
-    def __init__(self, contents: str) -> None:
+    def __init__(self, contents: bytes) -> None:
         self._parsed: MutableMapping[
             Tuple[str, ...],
             Tuple[int, Union[FoamDict.Data, EllipsisType], int],
         ] = {}
-        for parse_result in _FILE.parse_string(contents, parse_all=True):
+        for parse_result in _FILE.parse_string(
+            contents.decode("latin-1"), parse_all=True
+        ):
             self._parsed.update(self._flatten_result(parse_result))
 
     @staticmethod

foamlib/_files/_serialization.py

@@ -1,3 +1,5 @@
+import array
+import itertools
 import sys
 
 if sys.version_info >= (3, 9):
@@ -16,84 +18,121 @@ except ModuleNotFoundError:
     numpy = False
 
 
-def dumps(
+def dumpb(
     data: FoamDict._SetData,
     *,
     assume_field: bool = False,
     assume_dimensions: bool = False,
     assume_data_entries: bool = False,
-) -> str:
+    binary_fields: bool = False,
+) -> bytes:
     if numpy and isinstance(data, np.ndarray):
-        return dumps(
+        return dumpb(
             data.tolist(),
             assume_field=assume_field,
             assume_dimensions=assume_dimensions,
+            assume_data_entries=assume_data_entries,
+            binary_fields=binary_fields,
         )
 
     elif isinstance(data, Mapping):
         entries = []
         for k, v in data.items():
-            s = dumps(
+            b = dumpb(
                 v,
                 assume_field=assume_field,
                 assume_dimensions=assume_dimensions,
                 assume_data_entries=True,
+                binary_fields=binary_fields,
             )
             if isinstance(v, Mapping):
-                entries.append(f"{k}\n{{\n{s}\n}}")
-            elif s:
-                entries.append(f"{k} {s};")
+                entries.append(dumpb(k) + b"\n" + b"{\n" + b + b"\n}")
+            elif b:
+                entries.append(dumpb(k) + b" " + b + b";")
             else:
-                entries.append(f"{k};")
-        return "\n".join(entries)
+                entries.append(dumpb(k) + b";")
+
+        return b"\n".join(entries)
 
     elif isinstance(data, FoamDict.DimensionSet) or (
         assume_dimensions and is_sequence(data) and len(data) == 7
     ):
-        return f"[{' '.join(str(v) for v in data)}]"
+        return b"[" + b" ".join(dumpb(v) for v in data) + b"]"
 
-    elif assume_field and isinstance(data, (int, float)):
-        return f"uniform {data}"
+    elif assume_field and (
+        isinstance(data, (int, float))
+        or is_sequence(data)
+        and data
+        and isinstance(data[0], (int, float))
+        and len(data) in (3, 6, 9)
+    ):
+        return b"uniform " + dumpb(data)
 
     elif assume_field and is_sequence(data):
-        if isinstance(data[0], (int, float)) and len(data) in (3, 6, 9):
-            return f"uniform {dumps(data)}"
-        elif isinstance(data[0], (int, float)):
-            return f"nonuniform List<scalar> {len(data)}{dumps(data)}"
+        if isinstance(data[0], (int, float)):
+            kind = b"scalar"
         elif len(data[0]) == 3:
-            return f"nonuniform List<vector> {len(data)}{dumps(data)}"
+            kind = b"vector"
         elif len(data[0]) == 6:
-            return f"nonuniform List<symmTensor> {len(data)}{dumps(data)}"
+            kind = b"symmTensor"
         elif len(data[0]) == 9:
-            return f"nonuniform List<tensor> {len(data)}{dumps(data)}"
+            kind = b"tensor"
         else:
-            return dumps(
+            return dumpb(
                 data,
                 assume_dimensions=assume_dimensions,
                 assume_data_entries=assume_data_entries,
+                binary_fields=binary_fields,
             )
 
+        if binary_fields:
+            if kind == b"scalar":
+                contents = b"(" + array.array("d", data).tobytes() + b")"
+            else:
+                contents = (
+                    b"("
+                    + array.array("d", itertools.chain.from_iterable(data)).tobytes()
+                    + b")"
+                )
+        else:
+            contents = dumpb(data)
+
+        return b"nonuniform List<" + kind + b"> " + dumpb(len(data)) + contents
+
     elif assume_data_entries and isinstance(data, tuple):
-        return " ".join(
-            dumps(v, assume_field=assume_field, assume_dimensions=assume_dimensions)
+        return b" ".join(
+            dumpb(
+                v,
+                assume_field=assume_field,
+                assume_dimensions=assume_dimensions,
+                binary_fields=binary_fields,
+            )
             for v in data
         )
 
     elif isinstance(data, FoamDict.Dimensioned):
         if data.name is not None:
-            return f"{data.name} {dumps(data.dimensions, assume_dimensions=True)} {dumps(data.value)}"
+            return (
+                dumpb(data.name)
+                + b" "
+                + dumpb(data.dimensions, assume_dimensions=True)
+                + b" "
+                + dumpb(data.value)
+            )
         else:
             return (
-                f"{dumps(data.dimensions, assume_dimensions=True)} {dumps(data.value)}"
+                dumpb(data.dimensions, assume_dimensions=True)
+                + b" "
+                + dumpb(data.value)
             )
 
     elif is_sequence(data):
-        return f"({' '.join(dumps(v) for v in data)})"
+        return b"(" + b" ".join(dumpb(v) for v in data) + b")"
 
     elif data is True:
-        return "yes"
+        return b"yes"
     elif data is False:
-        return "no"
+        return b"no"
 
     else:
-        return str(data)
+        return str(data).encode("latin-1")

{foamlib-0.3.2.dist-info → foamlib-0.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.3.2
+Version: 0.3.4
 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.3.4.dist-info/RECORD

@@ -0,0 +1,16 @@
+foamlib/__init__.py,sha256=1kmwoS1I2xRIk3KC9kFbsnLNljDVG3TOtdq0l9bnKE4,431
+foamlib/_cases.py,sha256=xR_m_4-YJbYfbIwhw17F6ieHw6BLCRgneDa4-xOoEf8,20567
+foamlib/_util.py,sha256=0HJ9n8QG9K7jC_xUDzOJo_NA2DBCJKJRLpmd5Yu42kU,2901
+foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foamlib/_files/__init__.py,sha256=m4y_7wFV2Voly1aJrTYALjT3S1Aq7EbaijxdGFbJrmU,160
+foamlib/_files/_base.py,sha256=YA5a-i5HZuA3JslCD6r-DwZzpSA8r42dqSXef286Ako,2050
+foamlib/_files/_fields.py,sha256=kY8EKNYp89asDOQjr-U9UmCqC2_Tt11zMfTQSWTvoms,5782
+foamlib/_files/_files.py,sha256=0xQ7Y-TEOgnbCq0X781gtX2RMxw7Xu024RXbQshmt6I,6293
+foamlib/_files/_io.py,sha256=GaOrwJt_upUyNPgeRXXrooppto82dUwAK2C9jNFqSNc,2071
+foamlib/_files/_parsing.py,sha256=-zSpEDjuPxzOdsLWaeQl7j6FZHyw2-jXNgOCXkcGskU,7308
+foamlib/_files/_serialization.py,sha256=WBDGt_P0FJ6X2uzav2JGvUHDhhyoRQ40cSF4kOK9qhw,3879
+foamlib-0.3.4.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
+foamlib-0.3.4.dist-info/METADATA,sha256=IVi0yNXJRfXYBxNur8KU46Jg6EOOXvfZtEf8g4O_C3w,4650
+foamlib-0.3.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+foamlib-0.3.4.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
+foamlib-0.3.4.dist-info/RECORD,,

foamlib-0.3.2.dist-info/RECORD

@@ -1,16 +0,0 @@
-foamlib/__init__.py,sha256=RKXFmt6ZgoSEiW8H5loLPjL4VY_2oIla-Dd0C7pEUKY,431
-foamlib/_cases.py,sha256=SkUthKb98zXPMYACaGyfGC0Fo1jzD6cC4qEGesHfNfc,20554
-foamlib/_util.py,sha256=0HJ9n8QG9K7jC_xUDzOJo_NA2DBCJKJRLpmd5Yu42kU,2901
-foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foamlib/_files/__init__.py,sha256=m4y_7wFV2Voly1aJrTYALjT3S1Aq7EbaijxdGFbJrmU,160
-foamlib/_files/_base.py,sha256=YA5a-i5HZuA3JslCD6r-DwZzpSA8r42dqSXef286Ako,2050
-foamlib/_files/_fields.py,sha256=jVHOHEV70i6QrWzqhF_W5CywUZyJxN5Eh5S1MrNn1G0,5632
-foamlib/_files/_files.py,sha256=aS8VDGifnDSX40HdgT512fuhQ9iGlPls3p133d64Rak,5975
-foamlib/_files/_io.py,sha256=alxMyxQh0zb6BZYqomZwOo9dQujMpRuS5yfpIKBEnaM,1976
-foamlib/_files/_parsing.py,sha256=blyt1kpYruoW5I6DMDg8jhg6f5oz7gzedmAImuJ5b4k,5966
-foamlib/_files/_serialization.py,sha256=H9STIpUxEBRwXh5WnqtjicCkGTpTYSwfWUwbVJf9x9A,2961
-foamlib-0.3.2.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
-foamlib-0.3.2.dist-info/METADATA,sha256=DBX2JpB09uqjPowv_ShTp7BZ9ryRI_WqVmcpp7T2-DQ,4650
-foamlib-0.3.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-foamlib-0.3.2.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
-foamlib-0.3.2.dist-info/RECORD,,