foamlib 0.8.2__tar.gz → 0.8.4__tar.gz

{foamlib-0.8.2 → foamlib-0.8.4}/.github/workflows/ci.yml

@@ -16,9 +16,9 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v4
     - name: Lint with Ruff
-      uses: astral-sh/ruff-action@v2
+      uses: astral-sh/ruff-action@v3
     - name: Format with Ruff
-      uses: astral-sh/ruff-action@v2
+      uses: astral-sh/ruff-action@v3
       with:
         args: 'format --check'
 
@@ -28,7 +28,7 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v4
     - name: Install uv
-      uses: astral-sh/setup-uv@v4
+      uses: astral-sh/setup-uv@v5
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
@@ -74,7 +74,7 @@ jobs:
       with:
         openfoam-version: ${{ matrix.openfoam-version }}
     - name: Install uv
-      uses: astral-sh/setup-uv@v4
+      uses: astral-sh/setup-uv@v5
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
@@ -103,7 +103,7 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v4
     - name: Install uv
-      uses: astral-sh/setup-uv@v4
+      uses: astral-sh/setup-uv@v5
     - name: Check package build
       run: |
         uv build

{foamlib-0.8.2 → foamlib-0.8.4}/.github/workflows/pypi-publish.yml

@@ -17,7 +17,7 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v4
     - name: Install uv
-      uses: astral-sh/setup-uv@v4
+      uses: astral-sh/setup-uv@v5
     - name: Build
       run: uv build
     - name: Publish to PyPI

{foamlib-0.8.2 → foamlib-0.8.4}/PKG-INFO

@@ -1,11 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: foamlib
-Version: 0.8.2
+Version: 0.8.4
 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
@@ -31,7 +32,7 @@ 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.2 → foamlib-0.8.4}/foamlib/__init__.py

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

{foamlib-0.8.2 → foamlib-0.8.4}/foamlib/_files/_files.py

@@ -308,15 +308,15 @@ class FoamFile(
                     self[(*keywords, k)] = v
 
             elif keywords:
+                val = dumps(data, kind=kind)
                 parsed.put(
                     keywords,
                     normalize(data, kind=kind),
                     before
                     + indentation
                     + dumps(keywords[-1])
-                    + b" "
-                    + dumps(data, kind=kind)
-                    + b";"
+                    + ((b" " + val) if val else b"")
+                    + (b";" if not keywords[-1].startswith("#") else b"")
                     + after,
                 )
 

{foamlib-0.8.2 → foamlib-0.8.4}/foamlib/_files/_parsing.py

@@ -89,7 +89,7 @@ def _parse_ascii_field(
         s = re.sub(ignore.re, " ", s)
     s = s.replace("(", " ").replace(")", " ")
 
-    return np.fromstring(s, sep=" ").reshape(-1, *tensor_kind.shape)
+    return np.fromstring(s, sep=" ").reshape(-1, *tensor_kind.shape)  # type: ignore [return-value]
 
 
 def _unpack_binary_field(
@@ -99,7 +99,7 @@ def _unpack_binary_field(
     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(
@@ -153,12 +153,19 @@ def _tensor_list(
 
 
 def _dict_of(
-    keyword: ParserElement, data: ParserElement, *, located: bool = False
+    keyword: ParserElement,
+    data: ParserElement,
+    *,
+    directive: ParserElement | None = None,
+    located: bool = False,
 ) -> ParserElement:
     dict_ = Forward()
 
     keyword_entry = keyword + (dict_ | (data + Literal(";").suppress()))
 
+    if directive is not None:
+        keyword_entry |= directive + data + LineEnd().suppress()  # type: ignore [no-untyped-call]
+
     if located:
         keyword_entry = Located(keyword_entry)
 
@@ -175,12 +182,17 @@ def _keyword_entry_of(
     keyword: ParserElement,
     data: ParserElement,
     *,
+    directive: ParserElement | None = None,
     located: bool = False,
 ) -> ParserElement:
     keyword_entry = keyword + (
-        _dict_of(keyword, data, located=located) | (data + Literal(";").suppress())
+        _dict_of(keyword, data, directive=directive, located=located)
+        | (data + Literal(";").suppress())
     )
 
+    if directive is not None:
+        keyword_entry |= directive + data + LineEnd().suppress()  # type: ignore [no-untyped-call]
+
     if located:
         keyword_entry = Located(keyword_entry)
     else:
@@ -223,9 +235,10 @@ _TENSOR = (
     | _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()))
@@ -239,7 +252,8 @@ _FIELD = (Keyword("uniform", _IDENTBODYCHARS).suppress() + _TENSOR) | (
         | _tensor_list(TensorKind.TENSOR, ignore=_COMMENT)
     )
 )
-_TOKEN = dbl_quoted_string | _IDENTIFIER
+_DIRECTIVE = Word("#", _IDENTBODYCHARS)
+_TOKEN = dbl_quoted_string | _IDENTIFIER | _DIRECTIVE
 _DATA = Forward()
 _KEYWORD_ENTRY = _keyword_entry_of(_TOKEN | _list_of(_IDENTIFIER), _DATA)
 _DICT = _dict_of(_TOKEN, _DATA)
@@ -258,18 +272,21 @@ _DATA <<= (
 
 
 def parse_data(s: str) -> Data:
+    if not s.strip():
+        return ""
     return cast(Data, _DATA.parse_string(s, parse_all=True)[0])
 
 
 _LOCATED_DICTIONARY = Group(
-    _keyword_entry_of(_TOKEN, Opt(_DATA, default=""), located=True)
+    _keyword_entry_of(
+        _TOKEN, Opt(_DATA, default=""), directive=_DIRECTIVE, located=True
+    )
 )[...]
 _LOCATED_DATA = Group(Located(_DATA.copy().add_parse_action(lambda tks: ["", tks[0]])))
 
 _FILE = (
     Dict(_LOCATED_DICTIONARY + Opt(_LOCATED_DATA) + _LOCATED_DICTIONARY)
     .ignore(_COMMENT)
-    .ignore(Literal("#include") + ... + LineEnd())  # type: ignore [no-untyped-call]
     .parse_with_tabs()
 )
 

{foamlib-0.8.2 → foamlib-0.8.4}/foamlib/_files/_serialization.py

@@ -50,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
 
@@ -111,7 +111,10 @@ def dumps(
 
     if isinstance(data, tuple) and kind == Kind.SINGLE_ENTRY and len(data) == 2:
         k, v = data
-        ret = dumps(k) + b" " + dumps(v)
+        ret = dumps(k)
+        val = dumps(v)
+        if val:
+            ret += b" " + val
         if not isinstance(v, Mapping):
             ret += b";"
         return ret

{foamlib-0.8.2 → foamlib-0.8.4}/foamlib/_files/_types.py

@@ -79,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.2 → foamlib-0.8.4}/pyproject.toml

@@ -42,7 +42,7 @@ dynamic = ["version"]
 lint = ["ruff"]
 test = [
     "pytest>=7,<9",
-    "pytest-asyncio>=0.21,<0.25",
+    "pytest-asyncio>=0.21,<0.26",
     "pytest-cov",
 ]
 typing = [

{foamlib-0.8.2 → foamlib-0.8.4}/tests/test_files/test_dumps.py

@@ -37,7 +37,7 @@ def test_serialize_data() -> None:
         == b"nonuniform List<vector> 2(\x00\x00\x00\x00\x00\x00\xf0?\x00\x00\x00\x00\x00\x00\x00@\x00\x00\x00\x00\x00\x00\x08@\x00\x00\x00\x00\x00\x00\x10@\x00\x00\x00\x00\x00\x00\x14@\x00\x00\x00\x00\x00\x00\x18@)"
     )
     assert (
-        dumps(np.array([1, 2], dtype=np.float32), kind=Kind.BINARY_FIELD)
+        dumps(np.array([1, 2], dtype=np.float32), kind=Kind.BINARY_FIELD)  # type: ignore [arg-type]
         == b"nonuniform List<scalar> 2(\x00\x00\x80?\x00\x00\x00@)"
     )
     assert (

{foamlib-0.8.2 → foamlib-0.8.4}/tests/test_files/test_files.py

@@ -163,19 +163,19 @@ def test_internal_field(cavity: FoamCase) -> None:
     p_arr = np.zeros(size)
     U_arr = np.zeros((size, 3))
 
-    cavity[0]["p"].internal_field = p_arr
-    cavity[0]["U"].internal_field = U_arr
+    cavity[0]["p"].internal_field = p_arr  # type: ignore [assignment]
+    cavity[0]["U"].internal_field = U_arr  # type: ignore [assignment]
 
     assert cavity[0]["p"].internal_field == pytest.approx(p_arr)
     U = cavity[0]["U"].internal_field
     assert isinstance(U, np.ndarray)
     assert U_arr == pytest.approx(U)
 
-    p_arr = np.arange(size) * 1e-6
+    p_arr = np.arange(size) * 1e-6  # type: ignore [assignment]
     U_arr = np.full((size, 3), [-1e-6, 1e-6, 0]) * np.arange(size)[:, np.newaxis]
 
-    cavity[0]["p"].internal_field = p_arr
-    cavity[0]["U"].internal_field = U_arr
+    cavity[0]["p"].internal_field = p_arr  # type: ignore [assignment]
+    cavity[0]["U"].internal_field = U_arr  # type: ignore [assignment]
 
     assert cavity[0]["p"].internal_field == pytest.approx(p_arr)
     U = cavity[0]["U"].internal_field
@@ -210,7 +210,7 @@ def test_binary_field(cavity: FoamCase) -> None:
     p_arr = np.arange(len(p_bin)) * 1e-6
     U_arr = np.full_like(U_bin, [-1e-6, 1e-6, 0]) * np.arange(len(U_bin))[:, np.newaxis]
 
-    cavity[0]["p"].internal_field = p_arr
+    cavity[0]["p"].internal_field = p_arr  # type: ignore [assignment]
     cavity[0]["U"].internal_field = U_arr
 
     assert cavity[0]["p"].internal_field == pytest.approx(p_arr)
@@ -237,7 +237,7 @@ def test_compressed_field(cavity: FoamCase) -> None:
     p_arr = np.arange(len(p_bin)) * 1e-6
     U_arr = np.full_like(U_bin, [-1e-6, 1e-6, 0]) * np.arange(len(U_bin))[:, np.newaxis]
 
-    cavity[0]["p"].internal_field = p_arr
+    cavity[0]["p"].internal_field = p_arr  # type: ignore [assignment]
     cavity[0]["U"].internal_field = U_arr
 
     assert cavity[0]["p"].internal_field == pytest.approx(p_arr)

{foamlib-0.8.2 → foamlib-0.8.4}/tests/test_files/test_parsing.py

@@ -92,8 +92,17 @@ def test_parse_value() -> None:
     assert Parsed(b"({a b; c d;} {e g;})")[()] == [{"a": "b", "c": "d"}, {"e": "g"}]
     assert Parsed(b"(water oil mercury air)")[()] == ["water", "oil", "mercury", "air"]
     assert Parsed(b"div(phi,U)")[()] == "div(phi,U)"
+    assert Parsed(b"div(nuEff*dev(T(grad(U))))")[()] == "div(nuEff*dev(T(grad(U))))"
     assert Parsed(b"((air and water) { type constant; sigma 0.07; })")[()] == [
         (["air", "and", "water"], {"type": "constant", "sigma": 0.07})
     ]
     assert Parsed(b"[]")[()] == FoamFile.DimensionSet()
     assert Parsed(b"object f.1;")[("object",)] == "f.1"
+
+
+def test_parse_directive() -> None:
+    assert Parsed(b'#include "filename"')[("#include",)] == '"filename"'
+    assert (
+        Parsed(b"functions\n{\n#includeFunc funcName\n}")[("functions", "#includeFunc")]
+        == "funcName"
+    )