foamlib 0.3.16__py3-none-any.whl → 0.3.17__py3-none-any.whl

foamlib/__init__.py

@@ -1,10 +1,15 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.3.16"
+__version__ = "0.3.17"
 
-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/_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/_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/_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/_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/_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/_util.py

@@ -1,15 +1,10 @@
-import asyncio
-import os
-import subprocess
 import sys
-from pathlib import Path
-from typing import Any, Optional, Union
-from warnings import warn
+from typing import Any
 
 if sys.version_info >= (3, 9):
-    from collections.abc import Mapping, Sequence
+    from collections.abc import Sequence
 else:
-    from typing import Mapping, Sequence
+    from typing import Sequence
 
 if sys.version_info >= (3, 10):
     from typing import TypeGuard
@@ -21,99 +16,3 @@ 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())

{foamlib-0.3.16.dist-info → foamlib-0.3.17.dist-info}/METADATA

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

@@ -0,0 +1,19 @@
+foamlib/__init__.py,sha256=XJCVvMns0YE5_ztycf50szXPcPfnKIW3Upxs-ODwx04,439
+foamlib/_util.py,sha256=UMzXmTFgvbp46w6k3oEZJoYC98pFgEK6LN5uLOwrlCg,397
+foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foamlib/_cases/__init__.py,sha256=xnQpR64EvFtCh07qnSz7kjQ1IhJXjRDwaZWwQGZhGv4,280
+foamlib/_cases/_async.py,sha256=dAMudqtpXdi1kmRoWpTE37dwvWhcYEh7cuued56SAZI,5930
+foamlib/_cases/_base.py,sha256=jfKevsV5CtxsyORvp-sYrdnW4pUxs6Or0I6nGXZVjII,12336
+foamlib/_cases/_sync.py,sha256=CloQgd-93jxfSXIt7J5NxcAu3N_iF3eXMKO-NfNOgi4,4522
+foamlib/_cases/_util.py,sha256=v6sHxHCEgagsVuup0S1xJW-x9py5xj3bUye8PiFfb3o,925
+foamlib/_files/__init__.py,sha256=vDkPj8u8bX_I_m2YfeKvXBgwg8D1ufyFCfHGHKN3JPQ,140
+foamlib/_files/_base.py,sha256=YA5a-i5HZuA3JslCD6r-DwZzpSA8r42dqSXef286Ako,2050
+foamlib/_files/_files.py,sha256=4rZb3HMJADmJBGmRpChiujJNX1UIxhgHI5YPEmEOWvE,10784
+foamlib/_files/_io.py,sha256=hlcqQqU-1cdIbDc3YqxnMfxALo4SFAEcRIoZM2vMtnE,2083
+foamlib/_files/_parsing.py,sha256=-IgvCOFMAERNOrpw2NaHtVXubBg4Ey6xR55bzEZb2B4,7696
+foamlib/_files/_serialization.py,sha256=LCeaLWtNvkcs0dfowL7nViiByxw7U_fvgueVjFliipU,3462
+foamlib-0.3.17.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
+foamlib-0.3.17.dist-info/METADATA,sha256=aLs74nCqbOMv3PnD34XF32-OMa20FHY8IS92wDYP32o,5458
+foamlib-0.3.17.dist-info/WHEEL,sha256=nCVcAvsfA9TDtwGwhYaRrlPhTLV9m-Ga6mdyDtuwK18,91
+foamlib-0.3.17.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
+foamlib-0.3.17.dist-info/RECORD,,

foamlib-0.3.16.dist-info/RECORD

@@ -1,18 +0,0 @@
-foamlib/__init__.py,sha256=a4a9sO9XCFmXj_flrKg-4kY1qyf4obb3iTXfkuLKgfY,432
-foamlib/_util.py,sha256=vL03aAzpWdZyYIhe2WTxHiz9b4lnttVnRuzqUmZvXXk,3047
-foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foamlib/_cases/__init__.py,sha256=4bHQRLtYh0IBOuuCSwUbipZEPqIF0sypU2xtoc6YW3c,166
-foamlib/_cases/_async.py,sha256=Rfbq3rerYZdt4lX7YxnStj4LSqwH2j0rAmbPkSDHhP0,4995
-foamlib/_cases/_base.py,sha256=6_zkF_TjKrwhsTZvqhmpaHQPVHIgZqmUfG5-9PV6gg4,11807
-foamlib/_cases/_sync.py,sha256=irMprDmcvjvdIj82griGhXvDU_L9UnyAbyJjS74Z3ug,3961
-foamlib/_files/__init__.py,sha256=vDkPj8u8bX_I_m2YfeKvXBgwg8D1ufyFCfHGHKN3JPQ,140
-foamlib/_files/_base.py,sha256=YA5a-i5HZuA3JslCD6r-DwZzpSA8r42dqSXef286Ako,2050
-foamlib/_files/_files.py,sha256=4rZb3HMJADmJBGmRpChiujJNX1UIxhgHI5YPEmEOWvE,10784
-foamlib/_files/_io.py,sha256=hlcqQqU-1cdIbDc3YqxnMfxALo4SFAEcRIoZM2vMtnE,2083
-foamlib/_files/_parsing.py,sha256=-IgvCOFMAERNOrpw2NaHtVXubBg4Ey6xR55bzEZb2B4,7696
-foamlib/_files/_serialization.py,sha256=LCeaLWtNvkcs0dfowL7nViiByxw7U_fvgueVjFliipU,3462
-foamlib-0.3.16.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
-foamlib-0.3.16.dist-info/METADATA,sha256=n_H2qQGKIewzGdVrfEKgk8QycZrDDHPbvk9qY-cnDTE,5458
-foamlib-0.3.16.dist-info/WHEEL,sha256=nCVcAvsfA9TDtwGwhYaRrlPhTLV9m-Ga6mdyDtuwK18,91
-foamlib-0.3.16.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
-foamlib-0.3.16.dist-info/RECORD,,