foamlib 0.7.0__py3-none-any.whl → 0.7.2__py3-none-any.whl

foamlib/__init__.py

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

foamlib/_files/_parsing.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import array
+import re
 import sys
 from typing import Tuple, Union, cast
 
@@ -28,10 +29,10 @@ from pyparsing import (
     ParserElement,
     ParseResults,
     QuotedString,
+    Regex,
     Word,
     common,
     counted_array,
-    cpp_style_comment,
     identchars,
     printables,
 )
@@ -40,7 +41,9 @@ from ._types import DataEntry, Dimensioned, DimensionSet, File
 
 
 def _list_of(entry: ParserElement) -> ParserElement:
-    return (
+    return Opt(
+        Literal("List") + Literal("<") + _IDENTIFIER + Literal(">")
+    ).suppress() + (
         (
             counted_array(entry, common.integer + Literal("(").suppress())
             + Literal(")").suppress()
@@ -56,6 +59,58 @@ def _list_of(entry: ParserElement) -> ParserElement:
     )
 
 
+def _counted_tensor_list(*, size: int, ignore: Regex) -> ParserElement:
+    float_pattern = r"[+-]?((\d+\.?\d*(e[+-]?\d+)?)|nan|inf(inity)?)"
+    ignore_pattern = rf"(?:\s|{ignore.re.pattern})+"
+
+    if size == 1:
+        tensor_pattern = float_pattern
+        tensor = common.ieee_float
+    else:
+        tensor_pattern = rf"\((?:{ignore_pattern})?(?:{float_pattern}{ignore_pattern}){{{size - 1}}}{float_pattern}(?:{ignore_pattern})?\)"
+        tensor = (
+            Literal("(").suppress()
+            + Group(common.ieee_float[size], aslist=True)
+            + Literal(")").suppress()
+        )
+
+    list_ = Forward()
+
+    def count_parse_action(tks: ParseResults) -> None:
+        nonlocal list_
+        length = tks[0]
+        assert isinstance(length, int)
+
+        list_ <<= Regex(
+            rf"\((?:{ignore_pattern})?(?:{tensor_pattern}{ignore_pattern}){{{length - 1}}}{tensor_pattern}(?:{ignore_pattern})?\)",
+            flags=re.IGNORECASE,
+        )
+
+    count = common.integer.add_parse_action(count_parse_action)
+
+    def list_parse_action(
+        tks: ParseResults,
+    ) -> list[list[float]] | list[list[list[float]]]:
+        values = [
+            float(v)
+            for v in re.sub(ignore.re, " ", tks[0])
+            .replace("(", " ")
+            .replace(")", " ")
+            .split()
+        ]
+
+        if size == 1:
+            return [values]
+
+        return [[values[i : i + size] for i in range(0, len(values), size)]]
+
+    list_.add_parse_action(list_parse_action)
+
+    return (count.suppress() + list_) | (
+        common.integer + Literal("{").suppress() + tensor + Literal("}").suppress()
+    ).set_parse_action(lambda tks: [[tks[1]] * tks[0]])
+
+
 def _keyword_entry_of(
     keyword: ParserElement,
     data_entries: ParserElement,
@@ -96,6 +151,9 @@ def _unpack_binary_field(
     return [values]
 
 
+# https://github.com/pyparsing/pyparsing/pull/584
+_COMMENT = Regex(r"(?:/\*(?:[^*]|\*(?!/))*\*/)|(?://(?:\\\n|[^\n])*)")
+
 _IDENTCHARS = identchars + "$"
 _IDENTBODYCHARS = (
     printables.replace(";", "")
@@ -124,7 +182,7 @@ _DIMENSIONS = (
 _TENSOR = common.ieee_float | (
     Literal("(").suppress()
     + Group(
-        common.ieee_float[9] | common.ieee_float[6] | common.ieee_float[3], aslist=True
+        common.ieee_float[3] | common.ieee_float[6] | common.ieee_float[9], aslist=True
     )
     + Literal(")").suppress()
 )
@@ -145,7 +203,7 @@ _FIELD = (Keyword("uniform", _IDENTBODYCHARS).suppress() + _TENSOR) | (
                 Literal("scalar").suppress()
                 + Literal(">").suppress()
                 + (
-                    _list_of(common.ieee_float)
+                    _counted_tensor_list(size=1, ignore=_COMMENT)
                     | (
                         (
                             (
@@ -169,11 +227,7 @@ _FIELD = (Keyword("uniform", _IDENTBODYCHARS).suppress() + _TENSOR) | (
                 Literal("vector").suppress()
                 + Literal(">").suppress()
                 + (
-                    _list_of(
-                        Literal("(").suppress()
-                        + Group(common.ieee_float[3], aslist=True)
-                        + Literal(")").suppress()
-                    )
+                    _counted_tensor_list(size=3, ignore=_COMMENT)
                     | (
                         (
                             (
@@ -194,14 +248,10 @@ _FIELD = (Keyword("uniform", _IDENTBODYCHARS).suppress() + _TENSOR) | (
                 )
             )
             | (
-                Literal("vector").suppress()
+                Literal("symmTensor").suppress()
                 + Literal(">").suppress()
                 + (
-                    _list_of(
-                        Literal("(").suppress()
-                        + Group(common.ieee_float[6], aslist=True)
-                        + Literal(")").suppress()
-                    )
+                    _counted_tensor_list(size=6, ignore=_COMMENT)
                     | (
                         (
                             (
@@ -225,11 +275,7 @@ _FIELD = (Keyword("uniform", _IDENTBODYCHARS).suppress() + _TENSOR) | (
                 Literal("tensor").suppress()
                 + Literal(">").suppress()
                 + (
-                    _list_of(
-                        Literal("(").suppress()
-                        + Group(common.ieee_float[9], aslist=True)
-                        + Literal(")").suppress()
-                    )
+                    _counted_tensor_list(size=9, ignore=_COMMENT)
                     | (
                         (
                             (
@@ -254,8 +300,12 @@ _FIELD = (Keyword("uniform", _IDENTBODYCHARS).suppress() + _TENSOR) | (
 )
 _TOKEN = QuotedString('"', unquote_results=False) | _IDENTIFIER
 DATA = Forward()
-KEYWORD = _TOKEN | _list_of(_IDENTIFIER).set_parse_action(
-    lambda tks: "(" + " ".join(tks[0]) + ")"
+KEYWORD = (
+    _TOKEN
+    | _list_of(_IDENTIFIER)
+    .set_parse_action(lambda tks: "(" + " ".join(tks[0]) + ")")
+    .ignore(_COMMENT)
+    .parse_with_tabs()
 )
 _KEYWORD_ENTRY = Dict(Group(_keyword_entry_of(KEYWORD, DATA)), asdict=True)
 _DATA_ENTRY = Forward()
@@ -264,25 +314,20 @@ _LIST = _list_of(_LIST_ENTRY)
 _NUMBER = common.signed_integer ^ common.ieee_float
 _DATA_ENTRY <<= _FIELD | _LIST | _DIMENSIONED | _DIMENSIONS | _NUMBER | _SWITCH | _TOKEN
 
-DATA <<= _DATA_ENTRY[1, ...].set_parse_action(
-    lambda tks: tuple(tks) if len(tks) > 1 else [tks[0]]
+DATA <<= (
+    _DATA_ENTRY[1, ...]
+    .set_parse_action(lambda tks: tuple(tks) if len(tks) > 1 else [tks[0]])
+    .ignore(_COMMENT)
+    .parse_with_tabs()
 )
 
 _FILE = (
     Dict(
         Group(_keyword_entry_of(KEYWORD, Opt(DATA, default=""), located=True))[...]
-        + Opt(
-            Group(
-                Located(
-                    _DATA_ENTRY[1, ...].set_parse_action(
-                        lambda tks: [None, tuple(tks) if len(tks) > 1 else tks[0]]
-                    )
-                )
-            )
-        )
+        + Opt(Group(Located(DATA.copy().add_parse_action(lambda tks: ["", tks[0]]))))
         + Group(_keyword_entry_of(KEYWORD, Opt(DATA, default=""), located=True))[...]
     )
-    .ignore(cpp_style_comment)
+    .ignore(_COMMENT)
     .ignore(Literal("#include") + ... + LineEnd())  # type: ignore [no-untyped-call]
     .parse_with_tabs()
 )
@@ -317,7 +362,8 @@ class Parsed(Mapping[Tuple[str, ...], Union[DataEntry, EllipsisType]]):
         end = parse_result.locn_end
         assert isinstance(end, int)
         keyword, *data = item
-        if keyword is None:
+        assert isinstance(keyword, str)
+        if not keyword:
             assert not _keywords
             assert len(data) == 1
             assert not isinstance(data[0], ParseResults)

{foamlib-0.7.0.dist-info → foamlib-0.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.7.0
+Version: 0.7.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
@@ -69,13 +69,19 @@ Requires-Dist: mypy <2,>=1 ; extra == 'typing'
 [![Docker](https://github.com/gerlero/foamlib/actions/workflows/docker.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/docker.yml)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
 
-## 👋 Basics
+**foamlib** provides a simple, modern, ergonomic and fast Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
+
+<p align="center">
+    <img alt="benchmark" src="https://github.com/gerlero/foamlib/raw/main/benchmark.png" height="250">
+    <br>
+  <i>Parsing a </i>volVectorField<i> with 200k cells.</i>
+</p>
 
-**foamlib** provides a simple, modern and ergonomic Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
+## 👋 Basics
 
-It offers the following Python classes:
+**foamlib** offers the following Python classes:
 
-* [`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile) (and [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)): read-write access to OpenFOAM configuration and field files as if they were Python `dict`s, using `foamlib`'s own parser. Supports ASCII and binary field formats (with or without compression).
+* [`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile) (and [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)): read-write access to OpenFOAM configuration and field files as if they were Python `dict`s, using `foamlib`'s own parser and in-place editor. Supports ASCII and binary field formats (with or without compression).
 * [`FoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.FoamCase): a class for configuring, running, and accessing the results of OpenFOAM cases.
 * [`AsyncFoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.AsyncFoamCase): variant of `FoamCase` with asynchronous methods for running multiple cases at once.
 * [`AsyncSlurmFoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.AsyncSlurmFoamCase): subclass of `AsyncFoamCase` used for running cases on a Slurm cluster.

{foamlib-0.7.0.dist-info → foamlib-0.7.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-foamlib/__init__.py,sha256=OHt58vUx0Dlrq-2Nblufg5Cww_FfaUxvVAHqFcJTAQ4,452
+foamlib/__init__.py,sha256=YrFnCARXwvjW-QZzK9cS_ivto2gvTEJwdSVU5ZfCBkM,452
 foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 foamlib/_cases/__init__.py,sha256=wTUHcUgU1CBgpu0cUMtksQ5VKG6B8CFu9xc3dWwsQuo,358
 foamlib/_cases/_async.py,sha256=i6g4EBHqvI-1PkdrxsRto2ynW7sxsOga2bSYk1XVG1U,7795
@@ -11,12 +11,12 @@ foamlib/_cases/_util.py,sha256=lhVca3ERY0zwYjDam6W2QMROt0yX5vAF-9_DS5RuMbM,1547
 foamlib/_files/__init__.py,sha256=GDkYkF3F-ADhkCRT3j9dQQHPP5LyJJYb8TaBbZTQ6fo,96
 foamlib/_files/_files.py,sha256=LVLMeP9Zt9esuVGhntnjBA4_u_NhiX5xkm09Qemcle8,15846
 foamlib/_files/_io.py,sha256=IQLqoqnA1TpHf21NbUho2wsYWevyqC6MKo-wfpaObUU,2226
-foamlib/_files/_parsing.py,sha256=qEspHK6D4urT1qszfJcYptKg4xexfcA6pmcfw5uptCg,14007
+foamlib/_files/_parsing.py,sha256=D1l7j_KldD6h-iJvFT6c0CiwctWvUxeGJxh-J93zDs8,15430
 foamlib/_files/_serialization.py,sha256=0vqJxltjscqp16mIvd0iKXbeRMbq3a7uLG2INWxzCBg,5861
 foamlib/_files/_types.py,sha256=eY06nox8cZe6FixUQigvZRV9Fc7gwehJxuQz_wCCnqo,1678
 foamlib/_files/_util.py,sha256=O9t2W26XDs63cVLroW8rZ35Puas20NhnKr_gLMlZixI,493
-foamlib-0.7.0.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
-foamlib-0.7.0.dist-info/METADATA,sha256=UFLbuRZL2MCR1z5k-FNTtVpuhSRT6OLyWG_ohgDiIDI,7727
-foamlib-0.7.0.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-foamlib-0.7.0.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
-foamlib-0.7.0.dist-info/RECORD,,
+foamlib-0.7.2.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
+foamlib-0.7.2.dist-info/METADATA,sha256=dK_DN2ZLU49org-G_XI4kdNDg551I8b68d52Q4cAePU,7957
+foamlib-0.7.2.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+foamlib-0.7.2.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
+foamlib-0.7.2.dist-info/RECORD,,