dycw-utilities 0.174.0__tar.gz → 0.174.2__tar.gz

{dycw_utilities-0.174.0 → dycw_utilities-0.174.2}/PKG-INFO

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

{dycw_utilities-0.174.0 → dycw_utilities-0.174.2}/pyproject.toml

@@ -101,7 +101,7 @@
   name = "dycw-utilities"
   readme = "README.md"
   requires-python = ">= 3.12"
-  version = "0.174.0"
+  version = "0.174.2"
 
   [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.0"
+    current_version = "0.174.2"
 
     [[tool.bumpversion.files]]
       filename = "src/utilities/__init__.py"

{dycw_utilities-0.174.0 → dycw_utilities-0.174.2}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.174.0"
+__version__ = "0.174.2"

{dycw_utilities-0.174.0 → dycw_utilities-0.174.2}/src/utilities/subprocess.py

@@ -7,6 +7,7 @@ from pathlib import Path
 from string import Template
 from subprocess import PIPE, CalledProcessError, Popen
 from threading import Thread
+from time import sleep
 from typing import IO, TYPE_CHECKING, Literal, assert_never, overload
 
 from utilities.errors import ImpossibleCaseError
@@ -16,6 +17,8 @@ from utilities.text import strip_and_dedent
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
+    from whenever import TimeDelta
+
     from utilities.types import LoggerLike, PathLike, StrMapping, StrStrMapping
 
 
@@ -300,6 +303,7 @@ def ssh(
     return_stdout: bool = False,
     return_stderr: bool = False,
     logger: LoggerLike | None = None,
+    retry: tuple[int, TimeDelta] | None = None,
 ) -> str: ...
 @overload
 def ssh(
@@ -318,6 +322,7 @@ def ssh(
     return_stdout: Literal[True],
     return_stderr: bool = False,
     logger: LoggerLike | None = None,
+    retry: tuple[int, TimeDelta] | None = None,
 ) -> str: ...
 @overload
 def ssh(
@@ -336,6 +341,7 @@ def ssh(
     return_stdout: bool = False,
     return_stderr: Literal[True],
     logger: LoggerLike | None = None,
+    retry: tuple[int, TimeDelta] | None = None,
 ) -> str: ...
 @overload
 def ssh(
@@ -354,7 +360,27 @@ def ssh(
     return_stdout: Literal[False] = False,
     return_stderr: Literal[False] = False,
     logger: LoggerLike | None = None,
+    retry: tuple[int, TimeDelta] | None = None,
 ) -> None: ...
+@overload
+def ssh(
+    user: str,
+    hostname: str,
+    /,
+    *cmd_and_cmds_or_args: str,
+    batch_mode: bool = True,
+    host_key_algorithms: list[str] = _HOST_KEY_ALGORITHMS,
+    strict_host_key_checking: bool = True,
+    input: str | None = None,
+    print: bool = False,
+    print_stdout: bool = False,
+    print_stderr: bool = False,
+    return_: bool = False,
+    return_stdout: bool = False,
+    return_stderr: bool = False,
+    logger: LoggerLike | None = None,
+    retry: tuple[int, TimeDelta] | None = None,
+) -> str | None: ...
 def ssh(
     user: str,
     hostname: str,
@@ -371,6 +397,7 @@ def ssh(
     return_stdout: bool = False,
     return_stderr: bool = False,
     logger: LoggerLike | None = None,
+    retry: tuple[int, TimeDelta] | None = None,
 ) -> str | None:
     cmd_and_args = ssh_cmd(  # skipif-ci
         user,
@@ -380,17 +407,61 @@ def ssh(
         host_key_algorithms=host_key_algorithms,
         strict_host_key_checking=strict_host_key_checking,
     )
-    return run(  # skipif-ci
-        *cmd_and_args,
-        input=input,
-        print=print,
-        print_stdout=print_stdout,
-        print_stderr=print_stderr,
-        return_=return_,
-        return_stdout=return_stdout,
-        return_stderr=return_stderr,
-        logger=logger,
-    )
+    try:  # skipif-ci
+        return run(
+            *cmd_and_args,
+            input=input,
+            print=print,
+            print_stdout=print_stdout,
+            print_stderr=print_stderr,
+            return_=return_,
+            return_stdout=return_stdout,
+            return_stderr=return_stderr,
+            logger=logger,
+        )
+    except CalledProcessError as error:  # skipif-ci
+        if retry is None:
+            raise
+        attempts, delta = retry
+        if attempts <= 0:
+            raise
+        if logger is not None:
+            msg = strip_and_dedent(f"""
+'ssh' failed with:
+ - user                     = {user}
+ - hostname                 = {hostname}
+ - cmd_and_cmds_or_args     = {cmd_and_cmds_or_args}
+ - batch_mode               = {batch_mode}
+ - host_key_algorithms      = {host_key_algorithms}
+ - strict_host_key_checking = {strict_host_key_checking}
+ - input                    = {input}
+
+-- stdout ---------------------------------------------------------------------
+{error.stdout}-------------------------------------------------------------------------------
+-- stderr ---------------------------------------------------------------------
+{error.stderr}-------------------------------------------------------------------------------
+
+Retrying {attempts} more time(s) after {delta}...
+""")
+            to_logger(logger).error(msg)
+        sleep(delta.in_seconds())
+        return ssh(
+            user,
+            hostname,
+            *cmd_and_cmds_or_args,
+            batch_mode=batch_mode,
+            host_key_algorithms=host_key_algorithms,
+            strict_host_key_checking=strict_host_key_checking,
+            input=input,
+            print=print,
+            print_stdout=print_stdout,
+            print_stderr=print_stderr,
+            return_=return_,
+            return_stdout=return_stdout,
+            return_stderr=return_stderr,
+            logger=logger,
+            retry=(attempts - 1, delta),
+        )
 
 
 def ssh_cmd(
@@ -419,6 +490,21 @@ def touch_cmd(path: PathLike, /) -> list[str]:
     return ["touch", str(path)]
 
 
+@contextmanager
+def yield_ssh_temp_dir(
+    user: str, hostname: str, /, *, keep: bool = False, logger: LoggerLike | None = None
+) -> Iterator[Path]:
+    path = Path(ssh(user, hostname, *MKTEMP_DIR_CMD, return_=True))
+    try:
+        yield path
+    finally:
+        if keep:
+            if logger is not None:
+                to_logger(logger).info("Keeping temporary directory '%s'...", path)
+        else:
+            ssh(user, hostname, *rm_cmd(path))
+
+
 __all__ = [
     "BASH_LC",
     "BASH_LS",
@@ -434,4 +520,5 @@ __all__ = [
     "ssh_cmd",
     "sudo_cmd",
     "touch_cmd",
+    "yield_ssh_temp_dir",
 ]