foamlib 0.3.16__tar.gz → 0.3.18__tar.gz

{foamlib-0.3.16 → foamlib-0.3.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.3.16
+Version: 0.3.18
 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.16 → foamlib-0.3.18}/foamlib/__init__.py

@@ -1,10 +1,15 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.3.16"
+__version__ = "0.3.18"
 
-from ._cases import AsyncFoamCase, FoamCase, FoamCaseBase
+from ._cases import (
+    AsyncFoamCase,
+    CalledProcessError,
+    CalledProcessWarning,
+    FoamCase,
+    FoamCaseBase,
+)
 from ._files import FoamDict, FoamFieldFile, FoamFile
-from ._util import CalledProcessError, CalledProcessWarning
 
 __all__ = [
     "FoamCase",

{foamlib-0.3.16 → foamlib-0.3.18}/foamlib/_cases/__init__.py

@@ -1,9 +1,12 @@
 from ._async import AsyncFoamCase
 from ._base import FoamCaseBase
 from ._sync import FoamCase
+from ._util import CalledProcessError, CalledProcessWarning
 
 __all__ = [
     "FoamCaseBase",
     "FoamCase",
     "AsyncFoamCase",
+    "CalledProcessError",
+    "CalledProcessWarning",
 ]

{foamlib-0.3.16 → foamlib-0.3.18}/foamlib/_cases/_async.py

@@ -15,8 +15,9 @@ else:
 
 import aioshutil
 
-from .._util import run_process_async
+from .._util import is_sequence
 from ._base import FoamCaseBase
+from ._util import check_returncode
 
 
 class AsyncFoamCase(FoamCaseBase):
@@ -89,7 +90,33 @@ class AsyncFoamCase(FoamCaseBase):
         *,
         check: bool = True,
     ) -> None:
-        await run_process_async(cmd, cwd=self.path, check=check)
+        if not is_sequence(cmd):
+            proc = await asyncio.create_subprocess_shell(
+                str(cmd),
+                cwd=self.path,
+                env=self._env(shell=True),
+                stdout=asyncio.subprocess.DEVNULL,
+                stderr=asyncio.subprocess.PIPE if check else asyncio.subprocess.DEVNULL,
+            )
+
+        else:
+            if sys.version_info < (3, 8):
+                cmd = (str(arg) for arg in cmd)
+            proc = await asyncio.create_subprocess_exec(
+                *cmd,
+                cwd=self.path,
+                env=self._env(shell=False),
+                stdout=asyncio.subprocess.DEVNULL,
+                stderr=asyncio.subprocess.PIPE if check else asyncio.subprocess.DEVNULL,
+            )
+
+        stdout, stderr = await proc.communicate()
+
+        assert stdout is None
+        assert proc.returncode is not None
+
+        if check:
+            check_returncode(proc.returncode, cmd, stderr.decode())
 
     async def run(
         self,

{foamlib-0.3.16 → foamlib-0.3.18}/foamlib/_cases/_base.py

@@ -1,3 +1,4 @@
+import os
 import sys
 from pathlib import Path
 from typing import (
@@ -227,6 +228,24 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
 
         return script
 
+    def _env(self, *, shell: bool) -> Optional[Mapping[str, str]]:
+        sip_workaround = os.environ.get(
+            "FOAM_LD_LIBRARY_PATH", ""
+        ) and not os.environ.get("DYLD_LIBRARY_PATH", "")
+
+        if not shell or sip_workaround:
+            env = os.environ.copy()
+
+            if not shell:
+                env["PWD"] = str(self.path)
+
+            if sip_workaround:
+                env["DYLD_LIBRARY_PATH"] = env["FOAM_LD_LIBRARY_PATH"]
+
+            return env
+        else:
+            return None
+
     def _run_cmds(
         self,
         cmd: Optional[Union[Sequence[Union[str, Path]], str, Path]] = None,

{foamlib-0.3.16 → foamlib-0.3.18}/foamlib/_cases/_sync.py

@@ -1,4 +1,5 @@
 import shutil
+import subprocess
 import sys
 from pathlib import Path
 from typing import (
@@ -11,8 +12,9 @@ if sys.version_info >= (3, 9):
 else:
     from typing import Sequence
 
-from .._util import run_process
+from .._util import is_sequence
 from ._base import FoamCaseBase
+from ._util import check_returncode
 
 
 class FoamCase(FoamCaseBase):
@@ -55,7 +57,26 @@ class FoamCase(FoamCaseBase):
         *,
         check: bool = True,
     ) -> None:
-        run_process(cmd, cwd=self.path, check=check)
+        shell = not is_sequence(cmd)
+
+        if sys.version_info < (3, 8):
+            if shell:
+                cmd = str(cmd)
+            else:
+                cmd = (str(arg) for arg in cmd)
+
+        proc = subprocess.run(
+            cmd,
+            cwd=self.path,
+            env=self._env(shell=shell),
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE if check else subprocess.DEVNULL,
+            text=True,
+            shell=shell,
+        )
+
+        if check:
+            check_returncode(proc.returncode, cmd, proc.stderr)
 
     def run(
         self,

foamlib-0.3.18/foamlib/_cases/_util.py

@@ -0,0 +1,35 @@
+import subprocess
+import sys
+from pathlib import Path
+from typing import Optional, Union
+from warnings import warn
+
+if sys.version_info >= (3, 9):
+    from collections.abc import Sequence
+else:
+    from typing import Sequence
+
+
+class CalledProcessError(subprocess.CalledProcessError):
+    """Exception raised when a process fails and `check=True`."""
+
+    def __str__(self) -> str:
+        msg = super().__str__()
+        if self.stderr:
+            msg += f"\n{self.stderr}"
+        return msg
+
+
+class CalledProcessWarning(Warning):
+    """Warning raised when a process prints to stderr and `check=True`."""
+
+
+def check_returncode(
+    retcode: int,
+    cmd: Union[Sequence[Union[str, Path]], str, Path],
+    stderr: Optional[str],
+) -> None:
+    if retcode != 0:
+        raise CalledProcessError(retcode, cmd, None, stderr)
+    elif stderr:
+        warn(f"Command {cmd} printed to stderr.\n{stderr}", CalledProcessWarning)

{foamlib-0.3.16 → foamlib-0.3.18}/foamlib/_files/_files.py

@@ -6,6 +6,7 @@ if sys.version_info >= (3, 9):
 else:
     from typing import Iterator, Mapping, MutableMapping, Sequence
 
+from .._util import is_sequence
 from ._base import FoamDict
 from ._io import FoamFileIO
 from ._serialization import Kind, dumpb
@@ -24,7 +25,7 @@ class FoamFile(
     FoamFileIO,
 ):
     """
-    An OpenFOAM dictionary file.
+    An OpenFOAM data file.
 
     Use as a mutable mapping (i.e., like a dict) to access and modify entries.
 
@@ -88,6 +89,74 @@ class FoamFile(
 
             return ret
 
+    class Header(SubDict):
+        """The header of an OpenFOAM file."""
+
+        @property
+        def version(self) -> float:
+            """Alias of `self["version"]`."""
+            ret = self["version"]
+            if not isinstance(ret, float):
+                raise TypeError("version is not a float")
+            return ret
+
+        @version.setter
+        def version(self, data: float) -> None:
+            self["version"] = data
+
+        @property
+        def format(self) -> str:
+            """Alias of `self["format"]`."""
+            ret = self["format"]
+            if not isinstance(ret, str):
+                raise TypeError("format is not a string")
+            return ret
+
+        @format.setter
+        def format(self, data: str) -> None:
+            self["format"] = data
+
+        @property
+        def class_(self) -> str:
+            """Alias of `self["class"]`."""
+            ret = self["class"]
+            if not isinstance(ret, str):
+                raise TypeError("class is not a string")
+            return ret
+
+        @class_.setter
+        def class_(self, data: str) -> None:
+            self["class"] = data
+
+        @property
+        def location(self) -> str:
+            """Alias of `self["location"]`."""
+            ret = self["location"]
+            if not isinstance(ret, str):
+                raise TypeError("location is not a string")
+            return ret
+
+        @location.setter
+        def location(self, data: str) -> None:
+            self["location"] = data
+
+        @property
+        def object(self) -> str:
+            """Alias of `self["object"]`."""
+            ret = self["object"]
+            if not isinstance(ret, str):
+                raise TypeError("object is not a string")
+            return ret
+
+    @property
+    def header(self) -> "FoamFile.Header":
+        """Alias of `self["FoamFile"]`."""
+        ret = self["FoamFile"]
+        if not isinstance(ret, FoamFile.Header):
+            assert not isinstance(ret, FoamFile.SubDict)
+            raise TypeError("FoamFile is not a dictionary")
+        return ret
+
     def __getitem__(
         self, keywords: Union[str, Tuple[str, ...]]
     ) -> Union["FoamFile.Data", "FoamFile.SubDict"]:
@@ -99,7 +168,10 @@ class FoamFile(
         value = parsed[keywords]
 
         if value is ...:
-            return FoamFile.SubDict(self, keywords)
+            if keywords == ("FoamFile",):
+                return FoamFile.Header(self, keywords)
+            else:
+                return FoamFile.SubDict(self, keywords)
         else:
             return value
 
@@ -115,23 +187,23 @@ class FoamFile(
         assume_field: bool = False,
         assume_dimensions: bool = False,
     ) -> None:
-        if not isinstance(keywords, tuple):
-            keywords = (keywords,)
-
-        kind = Kind.DEFAULT
-        if keywords == ("internalField",) or (
-            len(keywords) == 3
-            and keywords[0] == "boundaryField"
-            and keywords[2] == "value"
-        ):
-            kind = Kind.BINARY_FIELD if self._binary else Kind.FIELD
-        elif keywords == ("dimensions",):
-            kind = Kind.DIMENSIONS
-
-        contents, parsed = self._read()
-
-        if isinstance(data, Mapping):
-            with self:
+        with self:
+            if not isinstance(keywords, tuple):
+                keywords = (keywords,)
+
+            kind = Kind.DEFAULT
+            if keywords == ("internalField",) or (
+                len(keywords) == 3
+                and keywords[0] == "boundaryField"
+                and keywords[2] == "value"
+            ):
+                kind = Kind.BINARY_FIELD if self._binary else Kind.FIELD
+            elif keywords == ("dimensions",):
+                kind = Kind.DIMENSIONS
+
+            contents, parsed = self._read()
+
+            if isinstance(data, Mapping):
                 if isinstance(data, FoamDict):
                     data = data.as_dict()
 
@@ -147,16 +219,44 @@ class FoamFile(
 
                 for k, v in data.items():
                     self[(*keywords, k)] = v
-        else:
-            start, end = parsed.entry_location(keywords, missing_ok=True)
-
-            self._write(
-                contents[:start]
-                + b"\n"
-                + dumpb({keywords[-1]: data}, kind=kind)
-                + b"\n"
-                + contents[end:]
-            )
+
+            elif not self and keywords[0] != "FoamFile":
+                self["FoamFile"] = {
+                    "version": 2.0,
+                    "format": "ascii",
+                    "class": "dictionary",
+                    "location": f'"{self.path.parent.name}"',
+                    "object": self.path.name,
+                }
+                self[keywords] = data
+
+            elif (
+                kind == Kind.FIELD or kind == Kind.BINARY_FIELD
+            ) and self.header.class_ == "dictionary":
+                if not is_sequence(data):
+                    class_ = "volScalarField"
+                elif (len(data) == 3 and not is_sequence(data[0])) or len(data[0]) == 3:
+                    class_ = "volVectorField"
+                elif (len(data) == 6 and not is_sequence(data[0])) or len(data[0]) == 6:
+                    class_ = "volSymmTensorField"
+                elif (len(data) == 9 and not is_sequence(data[0])) or len(data[0]) == 9:
+                    class_ = "volTensorField"
+                else:
+                    class_ = "volScalarField"
+
+                self.header.class_ = class_
+                self[keywords] = data
+
+            else:
+                start, end = parsed.entry_location(keywords, missing_ok=True)
+
+                self._write(
+                    contents[:start]
+                    + b"\n"
+                    + dumpb({keywords[-1]: data}, kind=kind)
+                    + b"\n"
+                    + contents[end:]
+                )
 
     def __delitem__(self, keywords: Union[str, Tuple[str, ...]]) -> None:
         if not isinstance(keywords, tuple):

foamlib-0.3.18/foamlib/_util.py

@@ -0,0 +1,18 @@
+import sys
+from typing import Any
+
+if sys.version_info >= (3, 9):
+    from collections.abc import Sequence
+else:
+    from typing import Sequence
+
+if sys.version_info >= (3, 10):
+    from typing import TypeGuard
+else:
+    from typing_extensions import TypeGuard
+
+
+def is_sequence(
+    value: Any,
+) -> TypeGuard[Sequence[Any]]:
+    return isinstance(value, Sequence) and not isinstance(value, str)

{foamlib-0.3.16 → foamlib-0.3.18}/foamlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.3.16
+Version: 0.3.18
 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.16 → foamlib-0.3.18}/foamlib.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ foamlib/_cases/__init__.py
 foamlib/_cases/_async.py
 foamlib/_cases/_base.py
 foamlib/_cases/_sync.py
+foamlib/_cases/_util.py
 foamlib/_files/__init__.py
 foamlib/_files/_base.py
 foamlib/_files/_files.py

foamlib-0.3.16/foamlib/_util.py

@@ -1,119 +0,0 @@
-import asyncio
-import os
-import subprocess
-import sys
-from pathlib import Path
-from typing import Any, Optional, Union
-from warnings import warn
-
-if sys.version_info >= (3, 9):
-    from collections.abc import Mapping, Sequence
-else:
-    from typing import Mapping, Sequence
-
-if sys.version_info >= (3, 10):
-    from typing import TypeGuard
-else:
-    from typing_extensions import TypeGuard
-
-
-def is_sequence(
-    value: Any,
-) -> TypeGuard[Sequence[Any]]:
-    return isinstance(value, Sequence) and not isinstance(value, str)
-
-
-class CalledProcessError(subprocess.CalledProcessError):
-    """Exception raised when a process fails and `check=True`."""
-
-    def __str__(self) -> str:
-        msg = super().__str__()
-        if self.stderr:
-            msg += f"\n{self.stderr}"
-        return msg
-
-
-class CalledProcessWarning(Warning):
-    """Warning raised when a process prints to stderr and `check=True`."""
-
-
-def _check(
-    retcode: int,
-    cmd: Union[Sequence[Union[str, Path]], str, Path],
-    stderr: Optional[str],
-) -> None:
-    if retcode != 0:
-        raise CalledProcessError(retcode, cmd, None, stderr)
-    elif stderr:
-        warn(f"Command {cmd} printed to stderr.\n{stderr}", CalledProcessWarning)
-
-
-def _env(cwd: Optional[Union[str, Path]] = None) -> Optional[Mapping[str, str]]:
-    if cwd is not None:
-        env = os.environ.copy()
-        env["PWD"] = str(cwd)
-        return env
-    else:
-        return None
-
-
-def run_process(
-    cmd: Union[Sequence[Union[str, Path]], str, Path],
-    *,
-    check: bool = True,
-    cwd: Union[None, str, Path] = None,
-) -> None:
-    shell = not is_sequence(cmd)
-
-    if sys.version_info < (3, 8):
-        if shell:
-            cmd = str(cmd)
-        else:
-            cmd = (str(arg) for arg in cmd)
-
-    proc = subprocess.run(
-        cmd,
-        cwd=cwd,
-        env=_env(cwd) if not shell else None,
-        stdout=subprocess.DEVNULL,
-        stderr=subprocess.PIPE if check else subprocess.DEVNULL,
-        text=True,
-        shell=shell,
-    )
-
-    if check:
-        _check(proc.returncode, cmd, proc.stderr)
-
-
-async def run_process_async(
-    cmd: Union[Sequence[Union[str, Path]], str, Path],
-    *,
-    check: bool = True,
-    cwd: Union[None, str, Path] = None,
-) -> None:
-    if not is_sequence(cmd):
-        proc = await asyncio.create_subprocess_shell(
-            str(cmd),
-            cwd=cwd,
-            stdout=asyncio.subprocess.DEVNULL,
-            stderr=asyncio.subprocess.PIPE if check else asyncio.subprocess.DEVNULL,
-        )
-
-    else:
-        if sys.version_info < (3, 8):
-            cmd = (str(arg) for arg in cmd)
-        proc = await asyncio.create_subprocess_exec(
-            *cmd,
-            cwd=cwd,
-            env=_env(cwd),
-            stdout=asyncio.subprocess.DEVNULL,
-            stderr=asyncio.subprocess.PIPE if check else asyncio.subprocess.DEVNULL,
-        )
-
-    stdout, stderr = await proc.communicate()
-
-    assert stdout is None
-    assert proc.returncode is not None
-
-    if check:
-        _check(proc.returncode, cmd, stderr.decode())