dycw-utilities 0.174.3__tar.gz → 0.174.4__tar.gz

{dycw_utilities-0.174.3 → dycw_utilities-0.174.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dycw-utilities
-Version: 0.174.3
+Version: 0.174.4
 Author: Derek Wan
 Author-email: Derek Wan <d.wan@icloud.com>
 Requires-Dist: atomicwrites>=1.4.1,<1.5

{dycw_utilities-0.174.3 → dycw_utilities-0.174.4}/pyproject.toml

@@ -101,7 +101,7 @@
   name = "dycw-utilities"
   readme = "README.md"
   requires-python = ">= 3.12"
-  version = "0.174.3"
+  version = "0.174.4"
 
   [project.entry-points.pytest11]
     pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -135,7 +135,7 @@
   # bump-my-version
   [tool.bumpversion]
     allow_dirty = true
-    current_version = "0.174.3"
+    current_version = "0.174.4"
 
     [[tool.bumpversion.files]]
       filename = "src/utilities/__init__.py"

{dycw_utilities-0.174.3 → dycw_utilities-0.174.4}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.174.3"
+__version__ = "0.174.4"

{dycw_utilities-0.174.3 → dycw_utilities-0.174.4}/src/utilities/docker.py

@@ -5,6 +5,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Literal, overload
 
 from utilities.errors import ImpossibleCaseError
+from utilities.logging import to_logger
 from utilities.subprocess import (
     MKTEMP_DIR_CMD,
     maybe_sudo_cmd,
@@ -17,7 +18,7 @@ from utilities.subprocess import (
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
-    from utilities.types import LoggerLike, PathLike, StrStrMapping
+    from utilities.types import LoggerLike, PathLike, Retry, StrStrMapping
 
 
 @overload
@@ -106,6 +107,7 @@ def docker_exec(
     return_: Literal[True],
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
     **env_kwargs: str,
 ) -> str: ...
@@ -125,6 +127,7 @@ def docker_exec(
     return_: bool = False,
     return_stdout: Literal[True],
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
     **env_kwargs: str,
 ) -> str: ...
@@ -144,6 +147,7 @@ def docker_exec(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: Literal[True],
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
     **env_kwargs: str,
 ) -> str: ...
@@ -163,6 +167,7 @@ def docker_exec(
     return_: Literal[False] = False,
     return_stdout: Literal[False] = False,
     return_stderr: Literal[False] = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
     **env_kwargs: str,
 ) -> None: ...
@@ -182,6 +187,7 @@ def docker_exec(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
     **env_kwargs: str,
 ) -> str | None: ...
@@ -200,6 +206,7 @@ def docker_exec(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
     **env_kwargs: str,
 ) -> str | None:
@@ -222,6 +229,7 @@ def docker_exec(
         return_=return_,
         return_stdout=return_stdout,
         return_stderr=return_stderr,
+        retry=retry,
         logger=logger,
     )
 
@@ -253,15 +261,32 @@ def docker_exec_cmd(
 
 @contextmanager
 def yield_docker_temp_dir(
-    container: str, /, *, user: str | None = None, logger: LoggerLike | None = None
+    container: str,
+    /,
+    *,
+    user: str | None = None,
+    retry: Retry | None = None,
+    logger: LoggerLike | None = None,
+    keep: bool = False,
 ) -> Iterator[Path]:
     path = Path(  # skipif-ci
-        docker_exec(container, *MKTEMP_DIR_CMD, user=user, return_=True, logger=logger)
+        docker_exec(
+            container,
+            *MKTEMP_DIR_CMD,
+            user=user,
+            return_=True,
+            retry=retry,
+            logger=logger,
+        )
     )
     try:  # skipif-ci
         yield path
     finally:  # skipif-ci
-        docker_exec(container, *rm_cmd(path), user=user, logger=logger)
+        if keep:
+            if logger is not None:
+                to_logger(logger).info("Keeping temporary directory '%s'...", path)
+        else:
+            docker_exec(container, *rm_cmd(path), user=user, retry=retry, logger=logger)
 
 
 __all__ = ["docker_cp_cmd", "docker_exec", "docker_exec_cmd", "yield_docker_temp_dir"]

{dycw_utilities-0.174.3 → dycw_utilities-0.174.4}/src/utilities/subprocess.py

@@ -13,16 +13,14 @@ from typing import IO, TYPE_CHECKING, Literal, assert_never, overload
 from utilities.errors import ImpossibleCaseError
 from utilities.logging import to_logger
 from utilities.text import strip_and_dedent
-from utilities.types import Delta
 from utilities.whenever import to_seconds
 
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
-    from utilities.types import LoggerLike, PathLike, StrMapping, StrStrMapping
+    from utilities.types import LoggerLike, PathLike, Retry, StrMapping, StrStrMapping
 
 
-type _Retry = tuple[int, Delta | None]
 _HOST_KEY_ALGORITHMS = ["ssh-ed25519"]
 BASH_LC = ["bash", "-lc"]
 BASH_LS = ["bash", "-ls"]
@@ -83,7 +81,7 @@ def run(
     return_: Literal[True],
     return_stdout: bool = False,
     return_stderr: bool = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -103,7 +101,7 @@ def run(
     return_: bool = False,
     return_stdout: Literal[True],
     return_stderr: bool = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -123,7 +121,7 @@ def run(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: Literal[True],
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -143,7 +141,7 @@ def run(
     return_: Literal[False] = False,
     return_stdout: Literal[False] = False,
     return_stderr: Literal[False] = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> None: ...
 @overload
@@ -163,7 +161,7 @@ def run(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str | None: ...
 def run(
@@ -182,7 +180,7 @@ def run(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str | None:
     args: list[str] = []
@@ -337,7 +335,7 @@ def ssh(
     return_: Literal[True],
     return_stdout: bool = False,
     return_stderr: bool = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -356,7 +354,7 @@ def ssh(
     return_: bool = False,
     return_stdout: Literal[True],
     return_stderr: bool = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -375,7 +373,7 @@ def ssh(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: Literal[True],
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -394,7 +392,7 @@ def ssh(
     return_: Literal[False] = False,
     return_stdout: Literal[False] = False,
     return_stderr: Literal[False] = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> None: ...
 @overload
@@ -413,7 +411,7 @@ def ssh(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str | None: ...
 def ssh(
@@ -431,7 +429,7 @@ def ssh(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
-    retry: _Retry | None = None,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str | None:
     cmd_and_args = ssh_cmd(  # skipif-ci
@@ -484,9 +482,17 @@ def touch_cmd(path: PathLike, /) -> list[str]:
 
 @contextmanager
 def yield_ssh_temp_dir(
-    user: str, hostname: str, /, *, keep: bool = False, logger: LoggerLike | None = None
+    user: str,
+    hostname: str,
+    /,
+    *,
+    retry: Retry | None = None,
+    logger: LoggerLike | None = None,
+    keep: bool = False,
 ) -> Iterator[Path]:
-    path = Path(ssh(user, hostname, *MKTEMP_DIR_CMD, return_=True))
+    path = Path(
+        ssh(user, hostname, *MKTEMP_DIR_CMD, return_=True, retry=retry, logger=logger)
+    )
     try:
         yield path
     finally:
@@ -494,7 +500,7 @@ def yield_ssh_temp_dir(
             if logger is not None:
                 to_logger(logger).info("Keeping temporary directory '%s'...", path)
         else:
-            ssh(user, hostname, *rm_cmd(path))
+            ssh(user, hostname, *rm_cmd(path), retry=retry, logger=logger)
 
 
 __all__ = [

{dycw_utilities-0.174.3 → dycw_utilities-0.174.4}/src/utilities/types.py

@@ -231,6 +231,10 @@ type Seed = int | float | str | bytes | bytearray | Random
 type PatternLike = MaybeStr[Pattern[str]]
 
 
+# retry
+type Retry = tuple[int, Delta | None]
+
+
 # text
 type MaybeCallableStr = MaybeCallable[str]
 
@@ -332,6 +336,7 @@ __all__ = [
     "PathLike",
     "PatternLike",
     "PlainDateTimeLike",
+    "Retry",
     "Seed",
     "SequenceStr",
     "SerializeObjectExtra",