foamlib 0.6.4__tar.gz → 0.6.6__tar.gz

{foamlib-0.6.4 → foamlib-0.6.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.4
+Version: 0.6.6
 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
@@ -68,9 +68,10 @@ Requires-Dist: foamlib[docs]; extra == "dev"
 
 It offers the following 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 both ASCII and binary field formats.
+* [`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).
 * [`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.
 
 ## Get started
 
@@ -164,6 +165,7 @@ from foamlib import AsyncFoamCase
 from scipy.optimize import differential_evolution
 
 base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
+# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
 
 async def cost(x):
     async with base.clone() as clone:

{foamlib-0.6.4 → foamlib-0.6.6}/README.md

@@ -14,9 +14,10 @@
 
 It offers the following 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 both ASCII and binary field formats.
+* [`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).
 * [`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.
 
 ## Get started
 
@@ -110,6 +111,7 @@ from foamlib import AsyncFoamCase
 from scipy.optimize import differential_evolution
 
 base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
+# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
 
 async def cost(x):
     async with base.clone() as clone:

{foamlib-0.6.4 → foamlib-0.6.6}/foamlib/__init__.py

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

{foamlib-0.6.4 → foamlib-0.6.6}/foamlib/_cases/_subprocess.py

@@ -2,6 +2,7 @@ import asyncio
 import os
 import subprocess
 import sys
+from io import BytesIO
 from typing import IO, Optional, Union
 
 if sys.version_info >= (3, 9):
@@ -48,22 +49,26 @@ def run_sync(
         shell=isinstance(cmd, str),
     )
 
-    error = b""
-
     if stderr == STDOUT:
         stderr = stdout
     if stderr not in (PIPE, DEVNULL):
+        stderr_copy = BytesIO()
+
         assert not isinstance(stderr, int)
         if stderr is None:
             stderr = sys.stderr.buffer
 
         assert proc.stderr is not None
         for line in proc.stderr:
-            error += line
             stderr.write(line)
+            stderr_copy.write(line)
+
+        output, _ = proc.communicate()
+        assert not _
+        error = stderr_copy.getvalue()
+    else:
+        output, error = proc.communicate()
 
-    output, _ = proc.communicate()
-    assert not _
     assert proc.returncode is not None
 
     if check and proc.returncode != 0:
@@ -108,22 +113,26 @@ async def run_async(
             stderr=PIPE,
         )
 
-    error = b""
-
     if stderr == STDOUT:
         stderr = stdout
     if stderr not in (PIPE, DEVNULL):
+        stderr_copy = BytesIO()
+
         assert not isinstance(stderr, int)
         if stderr is None:
             stderr = sys.stderr.buffer
 
         assert proc.stderr is not None
         async for line in proc.stderr:
-            error += line
             stderr.write(line)
+            stderr_copy.write(line)
+
+        output, _ = await proc.communicate()
+        assert not _
+        error = stderr_copy.getvalue()
+    else:
+        output, error = await proc.communicate()
 
-    output, _ = await proc.communicate()
-    assert not _
     assert proc.returncode is not None
 
     if check and proc.returncode != 0:

{foamlib-0.6.4 → foamlib-0.6.6}/foamlib/_cases/_sync.py

@@ -1,7 +1,6 @@
 import os
 import shutil
 import sys
-from pathlib import Path
 from types import TracebackType
 from typing import Any, Callable, Optional, Type, Union, overload
 
@@ -49,9 +48,6 @@ class FoamCase(FoamCaseRunBase):
 
             return calls.value
 
-    def __init__(self, path: Union["os.PathLike[str]", str] = Path()):
-        super().__init__(path)
-
     @staticmethod
     def _run(
         cmd: Union[Sequence[Union[str, "os.PathLike[str]"]], str],

{foamlib-0.6.4 → foamlib-0.6.6}/foamlib/_files/_files.py

@@ -186,12 +186,10 @@ class FoamFile(
 
             try:
                 write_header = (
-                    not self
-                    and "FoamFile" not in self
-                    and (not keywords or keywords[0] != "FoamFile")
+                    not self and "FoamFile" not in self and keywords != ("FoamFile",)
                 )
             except FileNotFoundError:
-                write_header = not keywords or keywords[0] != "FoamFile"
+                write_header = keywords != ("FoamFile",)
 
             if write_header:
                 self["FoamFile"] = {}

{foamlib-0.6.4 → foamlib-0.6.6}/foamlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.4
+Version: 0.6.6
 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
@@ -68,9 +68,10 @@ Requires-Dist: foamlib[docs]; extra == "dev"
 
 It offers the following 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 both ASCII and binary field formats.
+* [`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).
 * [`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.
 
 ## Get started
 
@@ -164,6 +165,7 @@ from foamlib import AsyncFoamCase
 from scipy.optimize import differential_evolution
 
 base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
+# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
 
 async def cost(x):
     async with base.clone() as clone: