foamlib 0.3.7__py3-none-any.whl → 0.3.9__py3-none-any.whl

foamlib/__init__.py

@@ -1,6 +1,6 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.3.7"
+__version__ = "0.3.9"
 
 from ._cases import AsyncFoamCase, FoamCase, FoamCaseBase
 from ._files import FoamDict, FoamFieldFile, FoamFile

foamlib/_cases.py

@@ -32,8 +32,6 @@ from ._util import is_sequence, run_process, run_process_async
 class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
     def __init__(self, path: Union[Path, str] = Path()):
         self.path = Path(path).absolute()
-        if not self.path.is_dir():
-            raise NotADirectoryError(f"{self.path} is not a directory")
 
     class TimeDirectory(Set[FoamFieldFile]):
         """
@@ -46,8 +44,6 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
 
         def __init__(self, path: Union[Path, str]):
             self.path = Path(path).absolute()
-            if not self.path.is_dir():
-                raise NotADirectoryError(f"{self.path} is not a directory")
 
         @property
         def time(self) -> float:
@@ -60,23 +56,29 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
             return self.path.name
 
         def __getitem__(self, key: str) -> FoamFieldFile:
-            try:
+            if (self.path / key).is_file():
                 return FoamFieldFile(self.path / key)
-            except FileNotFoundError as e:
-                raise KeyError(key) from e
+            elif (self.path / f"{key}.gz").is_file():
+                return FoamFieldFile(self.path / f"{key}.gz")
+            else:
+                raise KeyError(key)
 
         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()
+                return (self.path / obj).is_file() or (
+                    self.path / f"{obj}.gz"
+                ).is_file()
             else:
                 return False
 
         def __iter__(self) -> Iterator[FoamFieldFile]:
             for p in self.path.iterdir():
-                if p.is_file():
-                    yield FoamFieldFile(p.name)
+                if p.is_file() and (
+                    p.suffix != ".gz" or not p.with_suffix("").is_file()
+                ):
+                    yield FoamFieldFile(p)
 
         def __len__(self) -> int:
             return len(list(iter(self)))
@@ -118,7 +120,7 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
         self, index: Union[int, slice, float, str]
     ) -> Union["FoamCaseBase.TimeDirectory", Sequence["FoamCaseBase.TimeDirectory"]]:
         if isinstance(index, str):
-            return FoamCaseBase.TimeDirectory(self.path / str(index))
+            return FoamCaseBase.TimeDirectory(self.path / index)
         elif isinstance(index, float):
             for time in self._times:
                 if time.time == index:
@@ -148,9 +150,15 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
                 if has_decompose_par_dict and p.name.startswith("processor"):
                     paths.add(p)
 
+        if (self.path / "0.orig").is_dir() and (self.path / "0").is_dir():
+            paths.add(self.path / "0")
+
         if has_block_mesh_dict and (self.path / "constant" / "polyMesh").exists():
             paths.add(self.path / "constant" / "polyMesh")
 
+        if self._run_script() is not None:
+            paths.update(self.path.glob("log.*"))
+
         return paths
 
     def _clone_ignore(
@@ -176,7 +184,7 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
         else:
             return None
 
-    def _run_script(self, *, parallel: Optional[bool]) -> Optional[Path]:
+    def _run_script(self, *, parallel: Optional[bool] = None) -> Optional[Path]:
         """Return the path to the (All)run script, or None if no run script is found."""
         run = self.path / "run"
         run_parallel = self.path / "run-parallel"
@@ -325,7 +333,10 @@ class FoamCase(FoamCaseBase):
             self.run([script_path], check=check)
         else:
             for p in self._clean_paths():
-                shutil.rmtree(p)
+                if p.is_dir():
+                    shutil.rmtree(p)
+                else:
+                    p.unlink()
 
     def run(
         self,
@@ -359,6 +370,9 @@ class FoamCase(FoamCaseBase):
                 return self.run([script_path], check=check)
 
             else:
+                if not self and (self.path / "0.orig").is_dir():
+                    self.restore_0_dir()
+
                 if (self.path / "system" / "blockMeshDict").is_file():
                     self.block_mesh()
 
@@ -393,6 +407,11 @@ class FoamCase(FoamCaseBase):
         """Reconstruct this case after parallel running."""
         self.run(["reconstructPar"], check=check)
 
+    def restore_0_dir(self) -> None:
+        """Restore the 0 directory from the 0.orig directory."""
+        shutil.rmtree(self.path / "0", ignore_errors=True)
+        shutil.copytree(self.path / "0.orig", self.path / "0")
+
     def copy(self, dest: Union[Path, str]) -> "FoamCase":
         """
         Make a copy of this case.
@@ -478,7 +497,10 @@ class AsyncFoamCase(FoamCaseBase):
             await self.run([script_path], check=check)
         else:
             for p in self._clean_paths():
-                await aioshutil.rmtree(p)
+                if p.is_dir():
+                    await aioshutil.rmtree(p)
+                else:
+                    p.unlink()
 
     async def run(
         self,
@@ -531,6 +553,9 @@ class AsyncFoamCase(FoamCaseBase):
                 await self.run([script_path], check=check, cpus=cpus)
 
             else:
+                if not self and (self.path / "0.orig").is_dir():
+                    await self.restore_0_dir()
+
                 if (self.path / "system" / "blockMeshDict").is_file():
                     await self.block_mesh()
 
@@ -572,6 +597,11 @@ class AsyncFoamCase(FoamCaseBase):
         """Reconstruct this case after parallel running."""
         await self.run(["reconstructPar"], check=check)
 
+    async def restore_0_dir(self) -> None:
+        """Restore the 0 directory from the 0.orig directory."""
+        await aioshutil.rmtree(self.path / "0", ignore_errors=True)
+        await aioshutil.copytree(self.path / "0.orig", self.path / "0")
+
     async def copy(self, dest: Union[Path, str]) -> "AsyncFoamCase":
         """
         Make a copy of this case.

foamlib/_files/_files.py

@@ -101,7 +101,7 @@ class FoamFile(
         if value is ...:
             return FoamFile.SubDict(self, keywords)
         else:
-            return value  # type: ignore [return-value]
+            return value
 
     @property
     def _binary(self) -> bool:

foamlib/_files/_io.py

@@ -1,3 +1,4 @@
+import gzip
 import sys
 from copy import deepcopy
 from pathlib import Path
@@ -20,10 +21,6 @@ from ._parsing import Parsed
 class FoamFileIO:
     def __init__(self, path: Union[str, Path]) -> None:
         self.path = Path(path).absolute()
-        if self.path.is_dir():
-            raise IsADirectoryError(self.path)
-        elif not self.path.is_file():
-            raise FileNotFoundError(self.path)
 
         self.__contents: Optional[bytes] = None
         self.__parsed: Optional[Parsed] = None
@@ -51,6 +48,10 @@ class FoamFileIO:
     def _read(self) -> Tuple[bytes, Parsed]:
         if not self.__defer_io:
             contents = self.path.read_bytes()
+
+            if self.path.suffix == ".gz":
+                contents = gzip.decompress(contents)
+
             if contents != self.__contents:
                 self.__contents = contents
                 self.__parsed = None
@@ -67,6 +68,9 @@ class FoamFileIO:
         self.__contents = contents
         self.__parsed = None
         if not self.__defer_io:
+            if self.path.suffix == ".gz":
+                contents = gzip.compress(contents)
+
             self.path.write_bytes(contents)
             self.__dirty = False
         else:

foamlib/_files/_parsing.py

@@ -247,6 +247,6 @@ class Parsed(Mapping[Tuple[str, ...], Union[FoamDict.Data, EllipsisType]]):
                 r = v
 
             assert isinstance(r, dict)
-            r[keywords[-1]] = {} if data is ... else data  # type: ignore [assignment]
+            r[keywords[-1]] = {} if data is ... else data
 
         return ret

{foamlib-0.3.7.dist-info → foamlib-0.3.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.3.7
+Version: 0.3.9
 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
@@ -45,7 +45,7 @@ Requires-Dist: pytest <9,>=7 ; extra == 'typing'
 Requires-Dist: pytest-asyncio <0.24,>=0.21 ; extra == 'typing'
 Requires-Dist: numpy <2,>=1 ; extra == 'typing'
 
-# foamlib
+[<img alt="foamlib" src="https://github.com/gerlero/foamlib/raw/main/logo.png" height="50">](https://github.com/gerlero/foamlib)
 
 [![Documentation](https://img.shields.io/readthedocs/foamlib)](https://foamlib.readthedocs.io/)
 [![CI](https://github.com/gerlero/foamlib/actions/workflows/ci.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/ci.yml)
@@ -54,7 +54,8 @@ Requires-Dist: numpy <2,>=1 ; extra == 'typing'
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![PyPI](https://img.shields.io/pypi/v/foamlib)](https://pypi.org/project/foamlib/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/foamlib)](https://pypi.org/project/foamlib/)
-[![Docker image](https://img.shields.io/badge/docker%20image-gerlero%2Ffoamlib-informational)](https://hub.docker.com/r/gerlero/foamlib/)
+![OpenFOAM](https://img.shields.io/badge/openfoam-.com%20|%20.org-informational)
+[![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
 
 **foamlib** provides a simple, modern and ergonomic Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
 

foamlib-0.3.9.dist-info/RECORD

@@ -0,0 +1,15 @@
+foamlib/__init__.py,sha256=VA5OODQTc1hOiKx4Hg0kYE_r9Q9num_-mR-wMHHhR1c,431
+foamlib/_cases.py,sha256=4b9CCDAuKi5Dp8DUksIbaMsp0Yi0xv5QeZLVAUrKRh8,21417
+foamlib/_util.py,sha256=vL03aAzpWdZyYIhe2WTxHiz9b4lnttVnRuzqUmZvXXk,3047
+foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+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=pGYMoLI5Dz2Y90EB1CtklZiffpDTGuQbbbkyqRe0JAo,2115
+foamlib/_files/_parsing.py,sha256=sWUeF9xiM6AriQjljl3jEpvoFRMmaS1h3bT3b0oor3U,7279
+foamlib/_files/_serialization.py,sha256=rmZW42Pyn1DIJbGMZqFG_lZ5DcLhPmfUgH24qsu2rIk,3400
+foamlib-0.3.9.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
+foamlib-0.3.9.dist-info/METADATA,sha256=FmZVopicBSscMw3JI3D6dnpLLDfcHLn4BQkrhklp8Sw,5242
+foamlib-0.3.9.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+foamlib-0.3.9.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
+foamlib-0.3.9.dist-info/RECORD,,

foamlib-0.3.7.dist-info/RECORD

@@ -1,15 +0,0 @@
-foamlib/__init__.py,sha256=hW4v8Ud3Ftd_sV1O_SuF4JzxkLRjjKwCl-A81aOu0zo,431
-foamlib/_cases.py,sha256=ELwX-Gr3ZB11axG6coHqXDyGh9Xb7kgAfYkhCsEGZy4,20278
-foamlib/_util.py,sha256=vL03aAzpWdZyYIhe2WTxHiz9b4lnttVnRuzqUmZvXXk,3047
-foamlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foamlib/_files/__init__.py,sha256=vDkPj8u8bX_I_m2YfeKvXBgwg8D1ufyFCfHGHKN3JPQ,140
-foamlib/_files/_base.py,sha256=YA5a-i5HZuA3JslCD6r-DwZzpSA8r42dqSXef286Ako,2050
-foamlib/_files/_files.py,sha256=JcOVP3eu9QYCOPt_DfobigKsd0VqgJRfEVytMOwES_g,10815
-foamlib/_files/_io.py,sha256=So9rG6iW77sRK2xFz5KHX6AFtYc2L19voAwn-_NmQow,2075
-foamlib/_files/_parsing.py,sha256=-zSpEDjuPxzOdsLWaeQl7j6FZHyw2-jXNgOCXkcGskU,7308
-foamlib/_files/_serialization.py,sha256=rmZW42Pyn1DIJbGMZqFG_lZ5DcLhPmfUgH24qsu2rIk,3400
-foamlib-0.3.7.dist-info/LICENSE.txt,sha256=5Dte9TUnLZzPRs4NQzl-Jc2-Ljd-t_v0ZR5Ng5r0UsY,35131
-foamlib-0.3.7.dist-info/METADATA,sha256=CqC7YFwGgMYkr_niGYF3p_675P8Jc1670msKlZcqjZw,5037
-foamlib-0.3.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-foamlib-0.3.7.dist-info/top_level.txt,sha256=ZdVYtetXGwPwyfL-WhlhbTFQGAwKX5P_gXxtH9JYFPI,8
-foamlib-0.3.7.dist-info/RECORD,,