foamlib 0.1.6__tar.gz → 0.1.8__tar.gz

{foamlib-0.1.6 → foamlib-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.1.6
+Version: 0.1.8
 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
@@ -26,12 +26,15 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: aioshutil<2,>=1
+Requires-Dist: pyparsing<4,>=3
 Provides-Extra: lint
 Requires-Dist: mypy<2,>=1; extra == "lint"
 Requires-Dist: pytest<9,>=7; extra == "lint"
 Requires-Dist: pytest-asyncio<0.24,>=0.21; extra == "lint"
 Requires-Dist: numpy<2,>=1; extra == "lint"
 Requires-Dist: black; extra == "lint"
+Requires-Dist: flake8; extra == "lint"
+Requires-Dist: Flake8-pyproject; extra == "lint"
 Provides-Extra: test
 Requires-Dist: pytest<9,>=7; extra == "test"
 Requires-Dist: pytest-asyncio<0.24,>=0.21; extra == "test"

{foamlib-0.1.6 → foamlib-0.1.8}/foamlib/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.6"
+__version__ = "0.1.8"
 
 from ._cases import FoamCase, AsyncFoamCase, FoamTimeDirectory, FoamCaseBase
 from ._dictionaries import (

{foamlib-0.1.6 → foamlib-0.1.8}/foamlib/_cases.py

@@ -14,7 +14,6 @@ from typing import (
     Sequence,
     AsyncGenerator,
     Callable,
-    Mapping,
     Iterator,
     overload,
 )

{foamlib-0.1.6 → foamlib-0.1.8}/foamlib/_dictionaries.py

@@ -23,6 +23,7 @@ except ModuleNotFoundError:
 else:
     numpy = True
 
+from pyparsing import Group, Keyword, Opt, ZeroOrMore, Literal, Forward, common
 
 FoamDimensionSet = namedtuple(
     "FoamDimensionSet",
@@ -63,108 +64,46 @@ FoamValue = Union[
 A value that can be stored in an OpenFOAM dictionary.
 """
 
+_YES = Keyword("yes").set_parse_action(lambda s, loc, tks: True)
+_NO = Keyword("no").set_parse_action(lambda s, loc, tks: False)
+_VALUE = Forward()
+_LIST = Opt(
+    Literal("List") + Literal("<") + common.identifier + Literal(">")
+).suppress() + (
+    (
+        Opt(common.integer).suppress()
+        + Literal("(").suppress()
+        + Group(ZeroOrMore(_VALUE))
+        + Literal(")").suppress()
+    )
+    | (
+        common.integer + Literal("{").suppress() + _VALUE + Literal("}").suppress()
+    ).set_parse_action(lambda s, loc, tks: [tks[1]] * tks[0])
+)
+_FIELD = (Keyword("uniform").suppress() + _VALUE) | (
+    Keyword("nonuniform").suppress() + _LIST
+)
+_DIMENSIONS = (
+    Literal("[").suppress() + common.number * 7 + Literal("]").suppress()
+).set_parse_action(lambda s, loc, tks: FoamDimensionSet(*tks))
+_DIMENSIONED = (common.identifier + _DIMENSIONS + _VALUE).set_parse_action(
+    lambda s, loc, tks: FoamDimensioned(tks[0], tks[1], tks[2].as_list())
+)
 
-def _parse_bool(value: str) -> bool:
-    if value == "yes":
-        return True
-    elif value == "no":
-        return False
-    else:
-        raise ValueError(f"Cannot parse '{value}' as a boolean")
-
-
-def _parse_number(value: str) -> Union[int, float]:
-    with suppress(ValueError):
-        return int(value)
-    with suppress(ValueError):
-        return float(value)
-    raise ValueError(f"Cannot parse '{value}' as a number")
-
-
-def _parse_sequence(value: str) -> Sequence[FoamValue]:
-    start = value.find("(")
-    if start != -1:
-        assert value.endswith(")")
-        seq = []
-        nested = 0
-        start += 1
-        for i, c in enumerate(value[start:], start=start):
-            if c == "(":
-                nested += 1
-            elif c == ")":
-                nested -= 1
-            if c.isspace() and not nested:
-                v = value[start:i].strip()
-                if v:
-                    seq.append(_parse(v))
-                start = i + 1
-
-        v = value[start:-1].strip()
-        if v:
-            seq.append(_parse(v))
-
-        return seq
-
-    else:
-        raise ValueError(f"Cannot parse '{value}' as a sequence")
-
-
-def _parse_field(value: str) -> FoamValue:
-    if value.startswith("uniform "):
-        value = value[len("uniform ") :]
-        return _parse(value)
-    elif value.startswith("nonuniform "):
-        value = value[len("nonuniform ") :]
-        return _parse_sequence(value)
-    else:
-        raise ValueError(f"Cannot parse '{value}' as a field")
-
-
-def _parse_dimensions(value: str) -> FoamDimensionSet:
-    if value.startswith("["):
-        assert value.endswith("]")
-        return FoamDimensionSet(*(_parse_number(v) for v in value[1:-1].split()))
-    else:
-        raise ValueError(f"Cannot parse '{value}' as a dimension set")
-
-
-def _parse_dimensioned(value: str) -> FoamDimensioned:
-    start = value.find("[", 1)
-    if start != -1:
-        name = value[:start].strip()
-        end = value.find("]", start)
-        if end != -1:
-            dimensions = _parse_dimensions(value[start : end + 1])
-            value = value[end + 1 :].strip()
-            return FoamDimensioned(
-                name,
-                dimensions,
-                cast(Union[int, float, Sequence[Union[int, float]]], _parse(value)),
-            )
-
-    raise ValueError(f"Cannot parse '{value}' as a dimensioned value")
+_VALUE << (
+    _FIELD
+    | _LIST
+    | _DIMENSIONED
+    | _DIMENSIONS
+    | common.number
+    | _YES
+    | _NO
+    | common.identifier
+)
 
 
 def _parse(value: str) -> FoamValue:
-    with suppress(ValueError):
-        return _parse_bool(value)
-
-    with suppress(ValueError):
-        return _parse_field(value)
-
-    with suppress(ValueError):
-        return _parse_number(value)
-
-    with suppress(ValueError):
-        return _parse_dimensions(value)
-
-    with suppress(ValueError):
-        return _parse_dimensioned(value)
-
-    with suppress(ValueError):
-        return _parse_sequence(value)
-
-    return value
+    return cast(FoamValue, _VALUE.parse_string(value, parse_all=True).as_list()[0])
 
 
 def _serialize_bool(value: Any) -> str:
@@ -176,24 +115,26 @@ def _serialize_bool(value: Any) -> str:
         raise TypeError(f"Not a bool: {type(value)}")
 
 
-def _serialize_sequence(sequence: Any) -> str:
-    if (
-        isinstance(sequence, Sequence)
-        and not isinstance(sequence, str)
+def _is_sequence(value: Any) -> bool:
+    return (
+        isinstance(value, Sequence)
+        and not isinstance(value, str)
         or numpy
-        and isinstance(sequence, np.ndarray)
-    ):
-        return f"({' '.join(_serialize(v) for v in sequence)})"
+        and isinstance(value, np.ndarray)
+    )
+
+
+def _serialize_list(value: Any) -> str:
+    if _is_sequence(value):
+        return f"({' '.join(_serialize(v) for v in value)})"
     else:
-        raise TypeError(f"Not a valid sequence: {type(sequence)}")
+        raise TypeError(f"Not a valid sequence: {type(value)}")
 
 
 def _serialize_field(value: Any) -> str:
-    if isinstance(value, (int, float)):
-        return f"uniform {value}"
-    else:
+    if _is_sequence(value):
         try:
-            s = _serialize_sequence(value)
+            s = _serialize_list(value)
         except TypeError:
             raise TypeError(f"Not a valid field: {type(value)}") from None
         else:
@@ -213,15 +154,12 @@ def _serialize_field(value: Any) -> str:
                         f"Unsupported sequence length for field: {len(value[0])}"
                     )
                 return f"nonuniform List<{kind}> {len(value)}{s}"
+    else:
+        return f"uniform {value}"
 
 
 def _serialize_dimensions(value: Any) -> str:
-    if (
-        isinstance(value, Sequence)
-        and not isinstance(value, str)
-        or numpy
-        and isinstance(value, np.ndarray)
-    ) and len(value) == 7:
+    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)}")
@@ -249,7 +187,7 @@ def _serialize(
         return _serialize_dimensioned(value)
 
     with suppress(TypeError):
-        return _serialize_sequence(value)
+        return _serialize_list(value)
 
     with suppress(TypeError):
         return _serialize_bool(value)

{foamlib-0.1.6 → foamlib-0.1.8}/foamlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.1.6
+Version: 0.1.8
 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
@@ -26,12 +26,15 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: aioshutil<2,>=1
+Requires-Dist: pyparsing<4,>=3
 Provides-Extra: lint
 Requires-Dist: mypy<2,>=1; extra == "lint"
 Requires-Dist: pytest<9,>=7; extra == "lint"
 Requires-Dist: pytest-asyncio<0.24,>=0.21; extra == "lint"
 Requires-Dist: numpy<2,>=1; extra == "lint"
 Requires-Dist: black; extra == "lint"
+Requires-Dist: flake8; extra == "lint"
+Requires-Dist: Flake8-pyproject; extra == "lint"
 Provides-Extra: test
 Requires-Dist: pytest<9,>=7; extra == "test"
 Requires-Dist: pytest-asyncio<0.24,>=0.21; extra == "test"

{foamlib-0.1.6 → foamlib-0.1.8}/foamlib.egg-info/requires.txt

@@ -1,4 +1,5 @@
 aioshutil<2,>=1
+pyparsing<4,>=3
 
 [docs]
 sphinx<8,>=7
@@ -11,6 +12,8 @@ pytest<9,>=7
 pytest-asyncio<0.24,>=0.21
 numpy<2,>=1
 black
+flake8
+Flake8-pyproject
 
 [test]
 pytest<9,>=7

{foamlib-0.1.6 → foamlib-0.1.8}/pyproject.toml

@@ -27,7 +27,10 @@ classifiers = [
     "Typing :: Typed",
 ]
 
-dependencies = ["aioshutil>=1,<2"]
+dependencies = [
+    "aioshutil>=1,<2",
+    "pyparsing>=3,<4",
+]
 
 dynamic = ["version"]
 
@@ -38,6 +41,8 @@ lint = [
     "pytest-asyncio>=0.21,<0.24",
     "numpy>=1,<2",
     "black",
+    "flake8",
+    "Flake8-pyproject",
 ]
 test = [
     "pytest>=7,<9",
@@ -71,3 +76,22 @@ packages = [
     "tests",
 ]
 strict = true
+
+[tool.flake8]
+count = true
+ignore = [
+    "E203",  # whitespace before ':'
+    "E501",  # line too long
+    "E704",  # multiple statements on one line (def)
+    "F403",  # 'from foamlib import *' used; unable to detect undefined names
+    "F405",  # 'FoamDimensionSet' may be undefined, or defined from star imports: foamlib
+    "W503",  # line break before binary operator
+]
+exclude = [
+    ".git",
+    "__pycache__",
+    "docs/source/conf.py",
+    "build",
+    "dist",
+    "venv",
+]

{foamlib-0.1.6 → foamlib-0.1.8}/tests/test_dictionaries.py

@@ -14,8 +14,8 @@ def test_parse() -> None:
     assert _parse("1") == 1
     assert _parse("1.0") == 1.0
     assert _parse("1.0e-3") == 1.0e-3
-    assert _parse("yes") == True
-    assert _parse("no") == False
+    assert _parse("yes") is True
+    assert _parse("no") is False
     assert _parse("uniform 1") == 1
     assert _parse("uniform 1.0") == 1.0
     assert _parse("uniform 1.0e-3") == 1.0e-3
@@ -137,6 +137,18 @@ def test_internal_field(pitz: FoamCase) -> None:
 
     pitz.clean()
 
+    p_arr = np.zeros(size)
+    U_arr = np.zeros((size, 3))
+
+    pitz[0]["p"].internal_field = p_arr
+    pitz[0]["U"].internal_field = U_arr
+
+    assert pitz[0]["p"].internal_field == pytest.approx(p_arr)
+    U = pitz[0]["U"].internal_field
+    assert isinstance(U, Sequence)
+    for u, u_arr in zip(U, U_arr):
+        assert u == pytest.approx(u_arr)
+
     p_arr = np.arange(size) * 1e-6
     U_arr = np.full((size, 3), [-1e-6, 1e-6, 0]) * np.arange(size)[:, np.newaxis]
 
@@ -144,7 +156,7 @@ def test_internal_field(pitz: FoamCase) -> None:
     pitz[0]["U"].internal_field = U_arr
 
     assert pitz[0]["p"].internal_field == pytest.approx(p_arr)
-    U = pitz[-1]["U"].internal_field
+    U = pitz[0]["U"].internal_field
     assert isinstance(U, Sequence)
     for u, u_arr in zip(U, U_arr):
         assert u == pytest.approx(u_arr)