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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dycw-utilities
-Version: 0.174.2
+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.2 → dycw_utilities-0.174.4}/pyproject.toml

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

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

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

{dycw_utilities-0.174.2 → 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.2 → dycw_utilities-0.174.4}/src/utilities/subprocess.py

@@ -13,13 +13,12 @@ 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.whenever import to_seconds
 
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
-    from whenever import TimeDelta
-
-    from utilities.types import LoggerLike, PathLike, StrMapping, StrStrMapping
+    from utilities.types import LoggerLike, PathLike, Retry, StrMapping, StrStrMapping
 
 
 _HOST_KEY_ALGORITHMS = ["ssh-ed25519"]
@@ -82,6 +81,7 @@ def run(
     return_: Literal[True],
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -101,6 +101,7 @@ def run(
     return_: bool = False,
     return_stdout: Literal[True],
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -120,6 +121,7 @@ def run(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: Literal[True],
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
 ) -> str: ...
 @overload
@@ -139,6 +141,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
@@ -158,6 +161,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(
@@ -176,10 +180,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()
@@ -211,8 +216,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)
@@ -232,6 +237,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)
@@ -246,24 +255,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
@@ -271,14 +308,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:
@@ -302,8 +335,8 @@ def ssh(
     return_: Literal[True],
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
-    retry: tuple[int, TimeDelta] | None = None,
 ) -> str: ...
 @overload
 def ssh(
@@ -321,8 +354,8 @@ def ssh(
     return_: bool = False,
     return_stdout: Literal[True],
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
-    retry: tuple[int, TimeDelta] | None = None,
 ) -> str: ...
 @overload
 def ssh(
@@ -340,8 +373,8 @@ def ssh(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: Literal[True],
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
-    retry: tuple[int, TimeDelta] | None = None,
 ) -> str: ...
 @overload
 def ssh(
@@ -359,8 +392,8 @@ def ssh(
     return_: Literal[False] = False,
     return_stdout: Literal[False] = False,
     return_stderr: Literal[False] = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
-    retry: tuple[int, TimeDelta] | None = None,
 ) -> None: ...
 @overload
 def ssh(
@@ -378,8 +411,8 @@ def ssh(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
-    retry: tuple[int, TimeDelta] | None = None,
 ) -> str | None: ...
 def ssh(
     user: str,
@@ -396,8 +429,8 @@ def ssh(
     return_: bool = False,
     return_stdout: bool = False,
     return_stderr: bool = False,
+    retry: Retry | None = None,
     logger: LoggerLike | None = None,
-    retry: tuple[int, TimeDelta] | None = None,
 ) -> str | None:
     cmd_and_args = ssh_cmd(  # skipif-ci
         user,
@@ -407,61 +440,18 @@ def ssh(
         host_key_algorithms=host_key_algorithms,
         strict_host_key_checking=strict_host_key_checking,
     )
-    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),
-        )
+    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,
+        retry=retry,
+        logger=logger,
+    )
 
 
 def ssh_cmd(
@@ -492,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:
@@ -502,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.2 → 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",