dycw-utilities 0.174.3__py3-none-any.whl → 0.174.5__py3-none-any.whl

{dycw_utilities-0.174.3.dist-info → dycw_utilities-0.174.5.dist-info}/METADATA

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

{dycw_utilities-0.174.3.dist-info → dycw_utilities-0.174.5.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=l_p1vPbF4nOs4tHjj2e93HKXxeAoQ_-FUBDK_Tm0K0I,60
+utilities/__init__.py,sha256=HSEHPwrjbITUKM0rHSI676yh7VgQMNCB5ksk8o1Hb8M,60
 utilities/aeventkit.py,sha256=OmDBhYGgbsKrB7cdC5FFpJHUatX9O76eTeKVVTksp2Y,12673
 utilities/altair.py,sha256=rUK99g9x6CYDDfiZrf-aTx5fSRbL1Q8ctgKORowzXHg,9060
 utilities/asyncio.py,sha256=aJySVxBY0gqsIYnoNmH7-1r8djKuf4vSsU69VCD08t8,16772
@@ -12,7 +12,7 @@ utilities/contextvars.py,sha256=J8OhC7jqozAGYOCe2KUWysbPXNGe5JYz3HfaY_mIs08,883
 utilities/cryptography.py,sha256=5PFrzsNUGHay91dFgYnDKwYprXxahrBqztmUqViRzBk,956
 utilities/cvxpy.py,sha256=Rv1-fD-XYerosCavRF8Pohop2DBkU3AlFaGTfD8AEAA,13776
 utilities/dataclasses.py,sha256=xbU3QN1GFy7RC6hIJRZIeUZm7YRlodrgEWmahWG6k2g,32465
-utilities/docker.py,sha256=bLMXK1WCCoyVg92Yc4BNfaCXMaCIHRKEvqL2DiHTX4s,7270
+utilities/docker.py,sha256=DBgSz-UPBDHk_XJLPNaNMkNym1kKK8l3Os8IqMwEyW8,7866
 utilities/enum.py,sha256=5l6pwZD1cjSlVW4ss-zBPspWvrbrYrdtJWcg6f5_J5w,5781
 utilities/errors.py,sha256=mFlDGSM0LI1jZ1pbqwLAH3ttLZ2JVIxyZLojw8tGVZU,1479
 utilities/fastapi.py,sha256=TqyKvBjiMS594sXPjrz-KRTLMb3l3D3rZ1zAYV7GfOk,1454
@@ -80,14 +80,14 @@ utilities/sqlalchemy.py,sha256=HQYpd7LFxdTF5WYVWYtCJeEBI71EJm7ytvCGyAH9B-U,37163
 utilities/sqlalchemy_polars.py,sha256=JCGhB37raSR7fqeWV5dTsciRTMVzIdVT9YSqKT0piT0,13370
 utilities/statsmodels.py,sha256=koyiBHvpMcSiBfh99wFUfSggLNx7cuAw3rwyfAhoKpQ,3410
 utilities/string.py,sha256=shmBK87zZwzGyixuNuXCiUbqzfeZ9xlrFwz6JTaRvDk,582
-utilities/subprocess.py,sha256=FlE_SWoA6nUCTR7CregeXtjM6xtqNuuT9y6hqgnb8ZY,15407
+utilities/subprocess.py,sha256=r91VteJ7I1upuiWxRT2kvm17xffS5eXMZ3CJXdmZT4s,15686
 utilities/tempfile.py,sha256=Lx6qa16lL1XVH6WdmD_G9vlN6gLI8nrIurxmsFkPKvg,3022
 utilities/testbook.py,sha256=j1KmaVbrX9VrbeMgtPh5gk55myAsn3dyRUn7jGbPbRk,1294
 utilities/text.py,sha256=7SvwcSR2l_5cOrm1samGnR4C-ZI6qyFLHLzSpO1zeHQ,13958
 utilities/threading.py,sha256=GvBOp4CyhHfN90wGXZuA2VKe9fGzMaEa7oCl4f3nnPU,1009
 utilities/timer.py,sha256=BGlwEVznx67scuLOUohyWJ4d5rTnwtk-IR4yLXFiNfo,2574
 utilities/traceback.py,sha256=B_sc0TRUv-mGDnF-ek05nbqjmBiHr3-wvxliAqIF5hI,9608
-utilities/types.py,sha256=IlRrCtPdLkGYVfpe-QIg2qNUgBr8OJNN7BhTKxnhh-M,18817
+utilities/types.py,sha256=UwxYajRnupKTCnzReaYWYqtKdpIPeSO-d97Wu4bLEq8,18878
 utilities/typing.py,sha256=xuR8LxzjD-XlSftTM3TNvGVdQyV1mzpdwWdDMzWwCPE,25310
 utilities/tzdata.py,sha256=fgNVj66yUbCSI_-vrRVzSD3gtf-L_8IEJEPjP_Jel5Y,266
 utilities/tzlocal.py,sha256=KyCXEgCTjqGFx-389JdTuhMRUaT06U1RCMdWoED-qro,728
@@ -97,7 +97,7 @@ utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
 utilities/whenever.py,sha256=F4ek0-OBWxHYrZdmoZt76N2RnNyKY5KrEHt7rqO4AQE,60183
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=tdIScrTB2-B-LH0ukb1HUXKooLknOfJNwHk10MuMYvA,3619
-dycw_utilities-0.174.3.dist-info/WHEEL,sha256=ZyFSCYkV2BrxH6-HRVRg3R9Fo7MALzer9KiPYqNxSbo,79
-dycw_utilities-0.174.3.dist-info/entry_points.txt,sha256=ykGI1ArwOPHqm2g5Cqh3ENdMxEej_a_FcOUov5EM5Oc,155
-dycw_utilities-0.174.3.dist-info/METADATA,sha256=XSqrLMadX1FSoqYHcNS8LSzYZ0eTrmXvGWWQk72wVhM,1709
-dycw_utilities-0.174.3.dist-info/RECORD,,
+dycw_utilities-0.174.5.dist-info/WHEEL,sha256=ZyFSCYkV2BrxH6-HRVRg3R9Fo7MALzer9KiPYqNxSbo,79
+dycw_utilities-0.174.5.dist-info/entry_points.txt,sha256=ykGI1ArwOPHqm2g5Cqh3ENdMxEej_a_FcOUov5EM5Oc,155
+dycw_utilities-0.174.5.dist-info/METADATA,sha256=qYrj2g20dkkvXEdb1v43eAPpIoIS2vJOu4nM5QEFG54,1709
+dycw_utilities-0.174.5.dist-info/RECORD,,

utilities/__init__.py

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

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"]

utilities/subprocess.py

@@ -13,22 +13,24 @@ 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"]
 MKTEMP_DIR_CMD = ["mktemp", "-d"]
 
 
+def cp_cmd(src: PathLike, dest: PathLike, /) -> list[str]:
+    return ["cp", "-r", str(src), str(dest)]
+
+
 def echo_cmd(text: str, /) -> list[str]:
     return ["echo", text]
 
@@ -62,6 +64,10 @@ def mkdir_cmd(path: PathLike, /, *, parent: bool = False) -> list[str]:
     return ["mkdir", "-p", str(path_use)]
 
 
+def mv_cmd(src: PathLike, dest: PathLike, /) -> list[str]:
+    return ["mv", str(src), str(dest)]
+
+
 def rm_cmd(path: PathLike, /) -> list[str]:
     return ["rm", "-rf", str(path)]
 
@@ -83,7 +89,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 +109,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 +129,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 +149,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 +169,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 +188,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 +343,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 +362,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 +381,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 +400,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 +419,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 +437,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 +490,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,18 +508,20 @@ 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__ = [
     "BASH_LC",
     "BASH_LS",
     "MKTEMP_DIR_CMD",
+    "cp_cmd",
     "echo_cmd",
     "expand_path",
     "maybe_sudo_cmd",
     "mkdir",
     "mkdir_cmd",
+    "mv_cmd",
     "rm_cmd",
     "run",
     "ssh",

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",