dycw-utilities 0.174.6__tar.gz → 0.174.8__tar.gz

{dycw_utilities-0.174.6 → dycw_utilities-0.174.8}/PKG-INFO

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

{dycw_utilities-0.174.6 → dycw_utilities-0.174.8}/pyproject.toml

@@ -28,7 +28,7 @@
     "pytest-cov >=7.0.0, <7.1",
     "pytest-timeout >=2.4.0, <2.5",
   ]
-  fastapi = ["fastapi >=0.127.0, <0.128"]
+  fastapi = ["fastapi >=0.127.1, <0.128"]
   fastapi-test = ["httpx", "uvicorn"]
   fpdf2 = ["fpdf2 >=2.8.5, <2.9"]
   gitpython = ["gitpython >=3.1.45, <3.2"]
@@ -101,7 +101,7 @@
   name = "dycw-utilities"
   readme = "README.md"
   requires-python = ">= 3.12"
-  version = "0.174.6"
+  version = "0.174.8"
 
   [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.6"
+    current_version = "0.174.8"
 
     [[tool.bumpversion.files]]
       filename = "src/utilities/__init__.py"

{dycw_utilities-0.174.6 → dycw_utilities-0.174.8}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.174.6"
+__version__ = "0.174.8"

{dycw_utilities-0.174.6 → dycw_utilities-0.174.8}/src/utilities/subprocess.py

@@ -5,6 +5,7 @@ from contextlib import contextmanager
 from dataclasses import dataclass
 from io import StringIO
 from pathlib import Path
+from shlex import join
 from string import Template
 from subprocess import PIPE, CalledProcessError, Popen
 from threading import Thread
@@ -12,6 +13,7 @@ from time import sleep
 from typing import IO, TYPE_CHECKING, Literal, assert_never, overload, override
 
 from utilities.errors import ImpossibleCaseError
+from utilities.iterables import always_iterable
 from utilities.logging import to_logger
 from utilities.text import strip_and_dedent
 from utilities.whenever import to_seconds
@@ -19,7 +21,14 @@ from utilities.whenever import to_seconds
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
-    from utilities.types import LoggerLike, PathLike, Retry, StrMapping, StrStrMapping
+    from utilities.types import (
+        LoggerLike,
+        MaybeIterable,
+        PathLike,
+        Retry,
+        StrMapping,
+        StrStrMapping,
+    )
 
 
 _HOST_KEY_ALGORITHMS = ["ssh-ed25519"]
@@ -31,22 +40,37 @@ RESTART_SSHD = ["systemctl", "restart", "sshd"]
 UPDATE_CA_CERTIFICATES: str = "update-ca-certificates"
 
 
+##
+
+
 def apt_install_cmd(package: str, /) -> list[str]:
     return ["apt", "install", "-y", package]
 
 
+##
+
+
 def cat_cmd(path: PathLike, /) -> list[str]:
     return ["cat", str(path)]
 
 
+##
+
+
 def cd_cmd(path: PathLike, /) -> list[str]:
     return ["cd", str(path)]
 
 
+##
+
+
 def chmod_cmd(path: PathLike, mode: str, /) -> list[str]:
     return ["chmod", mode, str(path)]
 
 
+##
+
+
 def chown_cmd(
     path: PathLike, /, *, user: str | None = None, group: str | None = None
 ) -> list[str]:
@@ -71,14 +95,23 @@ class ChownCmdError(Exception):
         return "At least one of 'user' and/or 'group' must be given; got None"
 
 
+##
+
+
 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]
 
 
+##
+
+
 def expand_path(
     path: PathLike, /, *, subs: StrMapping | None = None, sudo: bool = False
 ) -> Path:
@@ -89,42 +122,192 @@ def expand_path(
     return Path(path).expanduser()
 
 
+##
+
+
 def git_clone_cmd(url: str, path: PathLike, /) -> list[str]:
     return ["git", "clone", "--recurse-submodules", url, str(path)]
 
 
+##
+
+
 def git_hard_reset_cmd(*, branch: str | None = None) -> list[str]:
     branch_use = "master" if branch is None else branch
     return ["git", "hard-reset", branch_use]
 
 
+##
+
+
+def maybe_parent(path: PathLike, /, *, parent: bool = False) -> Path:
+    path = Path(path)
+    return path.parent if parent else path
+
+
+##
+
+
 def maybe_sudo_cmd(cmd: str, /, *args: str, sudo: bool = False) -> list[str]:
     parts: list[str] = [cmd, *args]
     return sudo_cmd(*parts) if sudo else parts
 
 
+##
+
+
 def mkdir(path: PathLike, /, *, sudo: bool = False, parent: bool = False) -> None:
     if sudo:  # pragma: no cover
         run(*sudo_cmd(*mkdir_cmd(path, parent=parent)))
     else:
-        path = expand_path(path)
-        path_use = path.parent if parent else path
-        path_use.mkdir(parents=True, exist_ok=True)
+        maybe_parent(path, parent=parent).mkdir(parents=True, exist_ok=True)
+
+
+##
 
 
 def mkdir_cmd(path: PathLike, /, *, parent: bool = False) -> list[str]:
-    path_use = f"$(dirname {path})" if parent else path
-    return ["mkdir", "-p", str(path_use)]
+    return ["mkdir", "-p", str(maybe_parent(path, parent=parent))]
+
+
+##
 
 
 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)]
 
 
+##
+
+
+def rsync(
+    src_or_srcs: MaybeIterable[PathLike],
+    user: str,
+    hostname: str,
+    dest: PathLike,
+    /,
+    *,
+    sudo: bool = False,
+    batch_mode: bool = True,
+    host_key_algorithms: list[str] = _HOST_KEY_ALGORITHMS,
+    strict_host_key_checking: bool = True,
+    print: bool = False,  # noqa: A002
+    retry: Retry | None = None,
+    logger: LoggerLike | None = None,
+    chown_user: str | None = None,
+    chown_group: str | None = None,
+    exclude: MaybeIterable[str] | None = None,
+    chmod: str | None = None,
+) -> None:
+    mkdir_args = maybe_sudo_cmd(*mkdir_cmd(dest, parent=True), sudo=sudo)  # skipif-ci
+    ssh(  # skipif-ci
+        user,
+        hostname,
+        *mkdir_args,
+        batch_mode=batch_mode,
+        host_key_algorithms=host_key_algorithms,
+        strict_host_key_checking=strict_host_key_checking,
+        print=print,
+        retry=retry,
+        logger=logger,
+    )
+    is_dir = any(Path(s).is_dir() for s in always_iterable(src_or_srcs))  # skipif-ci
+    rsync_args = rsync_cmd(  # skipif-ci
+        src_or_srcs,
+        user,
+        hostname,
+        dest,
+        archive=is_dir,
+        chown_user=chown_user,
+        chown_group=chown_group,
+        exclude=exclude,
+        batch_mode=batch_mode,
+        host_key_algorithms=host_key_algorithms,
+        strict_host_key_checking=strict_host_key_checking,
+        sudo=sudo,
+        parent=is_dir,
+    )
+    run(*rsync_args, print=print, retry=retry, logger=logger)  # skipif-ci
+    if chmod is not None:  # skipif-ci
+        chmod_args = maybe_sudo_cmd(*chmod_cmd(dest, chmod), sudo=sudo)
+        ssh(
+            user,
+            hostname,
+            *chmod_args,
+            batch_mode=batch_mode,
+            host_key_algorithms=host_key_algorithms,
+            strict_host_key_checking=strict_host_key_checking,
+            print=print,
+            retry=retry,
+            logger=logger,
+        )
+
+
+##
+
+
+def rsync_cmd(
+    src_or_srcs: MaybeIterable[PathLike],
+    user: str,
+    hostname: str,
+    dest: PathLike,
+    /,
+    *,
+    archive: bool = False,
+    chown_user: str | None = None,
+    chown_group: str | None = None,
+    exclude: MaybeIterable[str] | None = None,
+    batch_mode: bool = True,
+    host_key_algorithms: list[str] = _HOST_KEY_ALGORITHMS,
+    strict_host_key_checking: bool = True,
+    sudo: bool = False,
+    parent: bool = False,
+) -> list[str]:
+    args: list[str] = ["rsync"]
+    if archive:
+        args.append("--archive")
+    args.append("--checksum")
+    match chown_user, chown_group:
+        case None, None:
+            ...
+        case str(), None:
+            args.extend(["--chown", chown_user])
+        case None, str():
+            args.extend(["--chown", f":{chown_group}"])
+        case str(), str():
+            args.extend(["--chown", f"{chown_user}:{chown_group}"])
+        case never:
+            assert_never(never)
+    args.append("--compress")
+    if exclude is not None:
+        for exclude_i in always_iterable(exclude):
+            args.extend(["--exclude", exclude_i])
+    rsh_args: list[str] = ssh_opts_cmd(
+        batch_mode=batch_mode,
+        host_key_algorithms=host_key_algorithms,
+        strict_host_key_checking=strict_host_key_checking,
+    )
+    args.extend(["--rsh", join(rsh_args)])
+    if sudo:
+        args.extend(["--rsync-path", join(sudo_cmd("rsync"))])
+    dest_use = maybe_parent(dest, parent=parent)
+    return [
+        *args,
+        *map(str, always_iterable(src_or_srcs)),
+        f"{user}@{hostname}:{dest_use}",
+    ]
+
+
+##
+
+
 @overload
 def run(
     cmd: str,
@@ -380,10 +563,16 @@ def _run_write_to_streams(text: str, /, *outputs: IO[str]) -> None:
         _ = output.write(text)
 
 
+##
+
+
 def set_hostname_cmd(hostname: str, /) -> list[str]:
     return ["hostnamectl", "set-hostname", hostname]
 
 
+##
+
+
 @overload
 def ssh(
     user: str,
@@ -519,6 +708,9 @@ def ssh(
     )
 
 
+##
+
+
 def ssh_cmd(
     user: str,
     hostname: str,
@@ -527,6 +719,23 @@ def ssh_cmd(
     batch_mode: bool = True,
     host_key_algorithms: list[str] = _HOST_KEY_ALGORITHMS,
     strict_host_key_checking: bool = True,
+) -> list[str]:
+    args: list[str] = ssh_opts_cmd(
+        batch_mode=batch_mode,
+        host_key_algorithms=host_key_algorithms,
+        strict_host_key_checking=strict_host_key_checking,
+    )
+    return [*args, f"{user}@{hostname}", *cmd_and_cmds_or_args]
+
+
+##
+
+
+def ssh_opts_cmd(
+    *,
+    batch_mode: bool = True,
+    host_key_algorithms: list[str] = _HOST_KEY_ALGORITHMS,
+    strict_host_key_checking: bool = True,
 ) -> list[str]:
     args: list[str] = ["ssh"]
     if batch_mode:
@@ -534,29 +743,47 @@ def ssh_cmd(
     args.extend(["-o", f"HostKeyAlgorithms={','.join(host_key_algorithms)}"])
     if strict_host_key_checking:
         args.extend(["-o", "StrictHostKeyChecking=yes"])
-    return [*args, "-T", f"{user}@{hostname}", *cmd_and_cmds_or_args]
+    return [*args, "-T"]
+
+
+##
 
 
 def ssh_keygen_cmd(hostname: str, /) -> list[str]:
     return ["ssh-keygen", "-f", "~/.ssh/known_hosts", "-R", hostname]
 
 
+##
+
+
 def sudo_cmd(cmd: str, /, *args: str) -> list[str]:
     return ["sudo", cmd, *args]
 
 
+##
+
+
 def sudo_nopasswd_cmd(user: str, /) -> str:
     return f"{user} ALL=(ALL) NOPASSWD: ALL"
 
 
+##
+
+
 def symlink_cmd(src: PathLike, dest: PathLike, /) -> list[str]:
     return ["ln", "-s", str(src), str(dest)]
 
 
+##
+
+
 def touch_cmd(path: PathLike, /) -> list[str]:
     return ["touch", str(path)]
 
 
+##
+
+
 def uv_run_cmd(module: str, /, *args: str) -> list[str]:
     return [
         "uv",
@@ -572,6 +799,9 @@ def uv_run_cmd(module: str, /, *args: str) -> list[str]:
     ]
 
 
+##
+
+
 @contextmanager
 def yield_ssh_temp_dir(
     user: str,
@@ -582,12 +812,12 @@ def yield_ssh_temp_dir(
     logger: LoggerLike | None = None,
     keep: bool = False,
 ) -> Iterator[Path]:
-    path = Path(
+    path = Path(  # skipif-ci
         ssh(user, hostname, *MKTEMP_DIR_CMD, return_=True, retry=retry, logger=logger)
     )
-    try:
+    try:  # skipif-ci
         yield path
-    finally:
+    finally:  # skipif-ci
         if keep:
             if logger is not None:
                 to_logger(logger).info("Keeping temporary directory '%s'...", path)
@@ -612,15 +842,19 @@ __all__ = [
     "expand_path",
     "git_clone_cmd",
     "git_hard_reset_cmd",
+    "maybe_parent",
     "maybe_sudo_cmd",
     "mkdir",
     "mkdir_cmd",
     "mv_cmd",
     "rm_cmd",
+    "rsync",
+    "rsync_cmd",
     "run",
     "set_hostname_cmd",
     "ssh",
     "ssh_cmd",
+    "ssh_opts_cmd",
     "sudo_cmd",
     "sudo_nopasswd_cmd",
     "symlink_cmd",