foamlib 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

foamlib/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 
 from ._cases import FoamCase, AsyncFoamCase, FoamCaseBase
 from ._dictionaries import FoamFile, FoamFieldFile

foamlib/_cases.py

@@ -64,6 +64,14 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
             except FileNotFoundError as e:
                 raise KeyError(key) from e
 
+        def __contains__(self, obj: object) -> bool:
+            if isinstance(obj, FoamFieldFile):
+                return obj.path.parent == self.path
+            elif isinstance(obj, str):
+                return (self.path / obj).is_file()
+            else:
+                return False
+
         def __iter__(self) -> Iterator[FoamFieldFile]:
             for p in self.path.iterdir():
                 if p.is_file():

foamlib/_dictionaries.py

@@ -1,6 +1,5 @@
 from pathlib import Path
 from dataclasses import dataclass
-from collections import namedtuple
 from contextlib import suppress
 from typing import (
     Any,
@@ -10,6 +9,7 @@ from typing import (
     Optional,
     Mapping,
     MutableMapping,
+    NamedTuple,
     cast,
 )
 
@@ -20,16 +20,15 @@ from pyparsing import (
     Keyword,
     LineEnd,
     Literal,
-    Located,
     Opt,
+    ParserElement,
     QuotedString,
     Word,
     c_style_comment,
     common,
     cpp_style_comment,
-    printables,
-    identchars,
     identbodychars,
+    printables,
 )
 
 try:
@@ -76,8 +75,7 @@ class _FoamDictionary(MutableMapping[str, Union["FoamFile.Value", "_FoamDictiona
                 ) from None
 
     def __getitem__(self, key: str) -> Union["FoamFile.Value", "_FoamDictionary"]:
-        contents = self._file.path.read_text()
-        value = _DICTIONARY.parse_string(contents, parse_all=True).as_dict()
+        value = _DICTIONARY.parse_file(self._file.path, parse_all=True).as_dict()
 
         for key in [*self._keywords, key]:
             value = value[key]
@@ -85,8 +83,7 @@ class _FoamDictionary(MutableMapping[str, Union["FoamFile.Value", "_FoamDictiona
         if isinstance(value, dict):
             return _FoamDictionary(self._file, [*self._keywords, key])
         else:
-            start, end = value
-            return _VALUE.parse_string(contents[start:end], parse_all=True).as_list()[0]
+            return value
 
     def _setitem(
         self,
@@ -101,7 +98,6 @@ class _FoamDictionary(MutableMapping[str, Union["FoamFile.Value", "_FoamDictiona
         elif isinstance(value, Mapping):
             self._cmd(["-set", "{}"], key=key)
             subdict = self[key]
-            print(subdict)
             assert isinstance(subdict, _FoamDictionary)
             for k, v in value.items():
                 subdict[k] = v
@@ -139,7 +135,7 @@ class _FoamDictionary(MutableMapping[str, Union["FoamFile.Value", "_FoamDictiona
         return len(list(iter(self)))
 
     def __repr__(self) -> str:
-        return "FoamFile.Dictionary"
+        return f"FoamFile.Dictionary({self._file}, {self._keywords})"
 
 
 class FoamFile(_FoamDictionary):
@@ -147,19 +143,17 @@ class FoamFile(_FoamDictionary):
 
     Dictionary = _FoamDictionary
 
-    DimensionSet = namedtuple(
-        "DimensionSet",
-        [
-            "mass",
-            "length",
-            "time",
-            "temperature",
-            "moles",
-            "current",
-            "luminous_intensity",
-        ],
-        defaults=(0, 0, 0, 0, 0, 0, 0),
-    )
+    class DimensionSet(NamedTuple):
+        mass: Union[int, float] = 0
+        length: Union[int, float] = 0
+        time: Union[int, float] = 0
+        temperature: Union[int, float] = 0
+        moles: Union[int, float] = 0
+        current: Union[int, float] = 0
+        luminous_intensity: Union[int, float] = 0
+
+        def __repr__(self) -> str:
+            return f"{type(self).__qualname__}({', '.join(f'{n}={v}' for n, v in zip(self._fields, self) if v != 0)})"
 
     @dataclass
     class Dimensioned:
@@ -205,6 +199,9 @@ class FoamFieldFile(FoamFile):
                 )
             return ret
 
+        def __repr__(self) -> str:
+            return f"{type(self).__qualname__}({self._file}, {self._keywords})"
+
     class BoundaryDictionary(_FoamDictionary):
         """An OpenFOAM dictionary representing a boundary condition as a mutable mapping."""
 
@@ -262,7 +259,7 @@ class FoamFieldFile(FoamFile):
             del self["value"]
 
         def __repr__(self) -> str:
-            return "FoamFieldFile.BoundaryDictionary"
+            return f"{type(self).__qualname__}({self._file}, {self._keywords})"
 
     def __getitem__(self, key: str) -> Union[FoamFile.Value, _FoamDictionary]:
         ret = super().__getitem__(key)
@@ -278,9 +275,6 @@ class FoamFieldFile(FoamFile):
         else:
             self._setitem(key, value)
 
-    def __repr__(self) -> str:
-        return "FoamFieldFile.BoundariesDictionary"
-
     @property
     def dimensions(self) -> FoamFile.DimensionSet:
         """
@@ -343,62 +337,65 @@ _NO = Keyword("no").set_parse_action(lambda: False)
 _DIMENSIONS = (
     Literal("[").suppress() + common.number * 7 + Literal("]").suppress()
 ).set_parse_action(lambda tks: FoamFile.DimensionSet(*tks))
-_TOKEN = QuotedString('"', unquote_results=False) | Word(
-    identchars + "$", identbodychars
-)
-_ITEM = Forward()
-_LIST = Opt(
-    Literal("List") + Literal("<") + common.identifier + Literal(">")
-).suppress() + (
-    (
-        Opt(common.integer).suppress()
-        + Literal("(").suppress()
-        + Group(_ITEM[...])
-        + Literal(")").suppress()
+
+
+def _list_of(elem: ParserElement) -> ParserElement:
+    return Opt(
+        Literal("List") + Literal("<") + common.identifier + Literal(">")
+    ).suppress() + (
+        (
+            Opt(common.integer).suppress()
+            + (
+                Literal("(").suppress()
+                + Group((elem)[...]).set_parse_action(lambda tks: tks.as_list())
+                + Literal(")").suppress()
+            )
+        )
+        | (
+            common.integer + Literal("{").suppress() + elem + Literal("}").suppress()
+        ).set_parse_action(lambda tks: [[tks[1]] * tks[0]])
     )
-    | (
-        common.integer + Literal("{").suppress() + _ITEM + Literal("}").suppress()
-    ).set_parse_action(lambda tks: [tks[1]] * tks[0])
-)
-_FIELD = (Keyword("uniform").suppress() + _ITEM) | (
-    Keyword("nonuniform").suppress() + _LIST
-)
-_DIMENSIONED = (Opt(common.identifier) + _DIMENSIONS + _ITEM).set_parse_action(
+
+
+_TENSOR = _list_of(common.number) | common.number
+_IDENTIFIER = Word(identbodychars + "$", identbodychars + "({,./:^!)}")
+_DIMENSIONED = (Opt(_IDENTIFIER) + _DIMENSIONS + _TENSOR).set_parse_action(
     lambda tks: FoamFile.Dimensioned(*reversed(tks.as_list()))
 )
+_FIELD = (Keyword("uniform").suppress() + _TENSOR) | (
+    Keyword("nonuniform").suppress() + _list_of(_TENSOR)
+)
+_TOKEN = QuotedString('"', unquote_results=False) | _IDENTIFIER
+_DICTIONARY = Forward()
+_SUBDICT = Literal("{").suppress() + _DICTIONARY + Literal("}").suppress()
+_ITEM = Forward()
+_LIST = _list_of(_ITEM)
 _ITEM <<= (
-    _FIELD | _LIST | _DIMENSIONED | _DIMENSIONS | common.number | _YES | _NO | _TOKEN
+    _FIELD
+    | _LIST
+    | _SUBDICT
+    | _DIMENSIONED
+    | _DIMENSIONS
+    | common.number
+    | _YES
+    | _NO
+    | _TOKEN
 )
-
 _TOKENS = (
-    QuotedString('"', unquote_results=False)
-    | Word(printables.replace(";", "").replace("{", "").replace("}", ""))
+    QuotedString('"', unquote_results=False) | Word(printables.replace(";", ""))
 )[2, ...].set_parse_action(lambda tks: " ".join(tks))
 
-_VALUE = (_ITEM ^ _TOKENS).ignore(c_style_comment).ignore(cpp_style_comment)
-
+_VALUE = _ITEM ^ _TOKENS
 
-_UNPARSED_VALUE = (
-    QuotedString('"', unquote_results=False)
-    | Word(printables.replace(";", "").replace("{", "").replace("}", ""))
-)[...]
-_KEYWORD = QuotedString('"', unquote_results=False) | Word(
-    identchars + "$(,.)", identbodychars + "$(,.)"
-)
-_DICTIONARY = Forward()
-_ENTRY = _KEYWORD + (
-    (
-        Located(_UNPARSED_VALUE).set_parse_action(lambda tks: (tks[0], tks[2]))
-        + Literal(";").suppress()
-    )
-    | (Literal("{").suppress() + _DICTIONARY + Literal("}").suppress())
+_ENTRY = _IDENTIFIER + (
+    (Opt(_VALUE, default=None) + Literal(";").suppress()) | _SUBDICT
 )
 _DICTIONARY <<= (
     Dict(Group(_ENTRY)[...])
     .set_parse_action(lambda tks: {} if not tks else tks)
     .ignore(c_style_comment)
     .ignore(cpp_style_comment)
-    .ignore(Literal("#include") + ... + LineEnd())  # type: ignore
+    .ignore(Literal("#include") + ... + LineEnd())  # type: ignore [no-untyped-call]
 )
 
 

{foamlib-0.2.0.dist-info → foamlib-0.2.2.dist-info}/METADATA

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

@@ -0,0 +1,10 @@
+foamlib/__init__.py,sha256=EFlApZJu-niDqPz_q3gjFdJ4ScRjPAjKC1gfKtXLMDQ,241
+foamlib/_cases.py,sha256=4f3c5BXnsHPhFvgXNjUcGGHyu7I0WZT6zxlvGhb9kMY,21213
+foamlib/_dictionaries.py,sha256=5hElrfAk_2SjINqmFE1dYK4H7lg8rRTzO-vwzMWj5QM,14874
+foamlib/_subprocesses.py,sha256=5vqdQvpN_2v4GgDqxi-s88NGhZ6doFxkh0XY89ZWuHA,1926
+foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foamlib-0.2.2.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
+foamlib-0.2.2.dist-info/METADATA,sha256=3J72tulIUFzK32O6aGy_LDzNI1LXWzcLM-9yVRVeJVY,4600
+foamlib-0.2.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+foamlib-0.2.2.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
+foamlib-0.2.2.dist-info/RECORD,,

foamlib-0.2.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-foamlib/__init__.py,sha256=s2updNwJoQGYD43xhqmQaUs_SSaeRTYKM2sjhjDRgjg,241
-foamlib/_cases.py,sha256=FL6d2_fCB9KCu9ps8Ur8ITlla3rSFsuvdvMYEXGCBM4,20923
-foamlib/_dictionaries.py,sha256=QF8f5bUg1JSMbCZK9CTULtE6y0SKnIDaUFipftXffMg,14820
-foamlib/_subprocesses.py,sha256=5vqdQvpN_2v4GgDqxi-s88NGhZ6doFxkh0XY89ZWuHA,1926
-foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foamlib-0.2.0.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
-foamlib-0.2.0.dist-info/METADATA,sha256=0-ZHRls6qUypSO521d02ocuMW05xJxG4EhgPR3byco4,4600
-foamlib-0.2.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-foamlib-0.2.0.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
-foamlib-0.2.0.dist-info/RECORD,,