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

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

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

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

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

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

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

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

@@ -7,11 +7,14 @@ 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
 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
@@ -19,6 +22,7 @@ if TYPE_CHECKING:
     from utilities.types import LoggerLike, PathLike, StrMapping, StrStrMapping
 
 
+type _Retry = tuple[int, Delta | None]
 _HOST_KEY_ALGORITHMS = ["ssh-ed25519"]
 BASH_LC = ["bash", "-lc"]
 BASH_LS = ["bash", "-ls"]
@@ -79,6 +83,7 @@ def run(
     return_: Literal[True],
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -98,6 +103,7 @@ def run(
     return_: bool = False,
     return_stdout: Literal[True],
     return_stderr: bool = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -117,6 +123,7 @@ def run(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: Literal[True],
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -136,6 +143,7 @@ def run(
     return_: Literal[False] = False,
     return_stdout: Literal[False] = False,
     return_stderr: Literal[False] = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> None: ...
 @overload
@@ -155,6 +163,7 @@ def run(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str | None: ...
 def run(
@@ -173,10 +182,11 @@ def run(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str | None:
     args: list[str] = []
-    if user is not None:
+    if user is not None:  # pragma: no cover
         args.extend(["su", "-", str(user)])
     args.extend([cmd, *cmds_or_args])
     buffer = StringIO()
@@ -208,8 +218,8 @@ def run(
         if proc.stderr is None:  # pragma: no cover
             raise ImpossibleCaseError(case=[f"{proc.stderr=}"])
         with (
-            _yield_write(proc.stdout, "proc.stdout", *stdout_outputs),
-            _yield_write(proc.stderr, "proc.stderr", *stderr_outputs),
+            _yield_write(proc.stdout, *stdout_outputs),
+            _yield_write(proc.stderr, *stderr_outputs),
         ):
             if input is not None:
                 _ = proc.stdin.write(input)
@@ -229,6 +239,10 @@ def run(
             case 0, False, False:
                 return None
             case _, _, _:
+                if retry is None:
+                    attempts = delta = None
+                else:
+                    attempts, delta = retry
                 _ = stdout.seek(0)
                 stdout_text = stdout.read()
                 _ = stderr.seek(0)
@@ -243,24 +257,52 @@ def run(
  - shell        = {shell}
  - cwd          = {cwd}
  - env          = {env}
- - input        = {input}
 
+-- stdin ----------------------------------------------------------------------
+{"" if input is None else input}-------------------------------------------------------------------------------
 -- stdout ---------------------------------------------------------------------
 {stdout_text}-------------------------------------------------------------------------------
 -- stderr ---------------------------------------------------------------------
 {stderr_text}-------------------------------------------------------------------------------
 """)
+                    if (attempts is not None) and (attempts >= 1):
+                        if delta is None:
+                            msg = f"{msg}\n\nRetrying {attempts} more time(s)..."
+                        else:
+                            msg = f"{msg}\n\nRetrying {attempts} more time(s) after {delta}..."
                     to_logger(logger).error(msg)
-                raise CalledProcessError(
+                error = CalledProcessError(
                     return_code, args, output=stdout_text, stderr=stderr_text
                 )
+                if (attempts is None) or (attempts <= 0):
+                    raise error
+                if delta is not None:
+                    sleep(to_seconds(delta))
+                return run(
+                    cmd,
+                    *cmds_or_args,
+                    user=user,
+                    executable=executable,
+                    shell=shell,
+                    cwd=cwd,
+                    env=env,
+                    input=input,
+                    print=print,
+                    print_stdout=print_stdout,
+                    print_stderr=print_stderr,
+                    return_=return_,
+                    return_stdout=return_stdout,
+                    return_stderr=return_stderr,
+                    retry=(attempts - 1, delta),
+                    logger=logger,
+                )
             case never:
                 assert_never(never)
 
 
 @contextmanager
-def _yield_write(input_: IO[str], desc: str, /, *outputs: IO[str]) -> Iterator[None]:
-    thread = Thread(target=_run_target, args=(input_, desc, *outputs), daemon=True)
+def _yield_write(input_: IO[str], /, *outputs: IO[str]) -> Iterator[None]:
+    thread = Thread(target=_run_target, args=(input_, *outputs), daemon=True)
     thread.start()
     try:
         yield
@@ -268,14 +310,10 @@ def _yield_write(input_: IO[str], desc: str, /, *outputs: IO[str]) -> Iterator[N
         thread.join()
 
 
-def _run_target(input_: IO[str], desc: str, /, *outputs: IO[str]) -> None:
-    try:
-        with input_:
-            for text in iter(input_.readline, ""):
-                _write_to_streams(text, *outputs)
-    except ValueError:
-        _ = sys.stderr.write(f"Failed to write to {desc!r}...")
-        raise
+def _run_target(input_: IO[str], /, *outputs: IO[str]) -> None:
+    with input_:
+        for text in iter(input_.readline, ""):
+            _write_to_streams(text, *outputs)
 
 
 def _write_to_streams(text: str, /, *outputs: IO[str]) -> None:
@@ -299,6 +337,7 @@ def ssh(
     return_: Literal[True],
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -317,6 +356,7 @@ def ssh(
     return_: bool = False,
     return_stdout: Literal[True],
     return_stderr: bool = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -335,6 +375,7 @@ def ssh(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: Literal[True],
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -353,8 +394,28 @@ def ssh(
     return_: Literal[False] = False,
     return_stdout: Literal[False] = False,
     return_stderr: Literal[False] = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | 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,
+    retry: _Retry | None = None,
+    logger: LoggerLike | None = None,
+) -> str | None: ...
 def ssh(
     user: str,
     hostname: str,
@@ -370,6 +431,7 @@ def ssh(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: _Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str | None:
     cmd_and_args = ssh_cmd(  # skipif-ci
@@ -389,6 +451,7 @@ def ssh(
         return_=return_,
         return_stdout=return_stdout,
         return_stderr=return_stderr,
+        retry=retry,
         logger=logger,
     )