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

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

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

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

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

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

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

{dycw_utilities-0.173.5 → dycw_utilities-0.174.0}/src/utilities/docker.py

@@ -7,7 +7,6 @@ from typing import TYPE_CHECKING, Literal, overload
 from utilities.errors import ImpossibleCaseError
 from utilities.subprocess import (
     MKTEMP_DIR_CMD,
-    bash_cmd_and_args,
     maybe_sudo_cmd,
     mkdir,
     mkdir_cmd,
@@ -100,7 +99,7 @@ def docker_exec(
     env: StrStrMapping | None = None,
     user: str | None = None,
     workdir: PathLike | None = None,
-    bash: bool = False,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -119,7 +118,7 @@ def docker_exec(
     env: StrStrMapping | None = None,
     user: str | None = None,
     workdir: PathLike | None = None,
-    bash: bool = False,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -138,7 +137,7 @@ def docker_exec(
     env: StrStrMapping | None = None,
     user: str | None = None,
     workdir: PathLike | None = None,
-    bash: bool = False,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -157,7 +156,7 @@ def docker_exec(
     env: StrStrMapping | None = None,
     user: str | None = None,
     workdir: PathLike | None = None,
-    bash: bool = False,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -176,7 +175,7 @@ def docker_exec(
     env: StrStrMapping | None = None,
     user: str | None = None,
     workdir: PathLike | None = None,
-    bash: bool = False,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -194,7 +193,7 @@ def docker_exec(
     env: StrStrMapping | None = None,
     user: str | None = None,
     workdir: PathLike | None = None,
-    bash: bool = False,
+    input: str | None = None,  # noqa: A002
     print: bool = False,  # noqa: A002
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -209,13 +208,14 @@ def docker_exec(
         cmd,
         *cmds_or_args,
         env=env,
+        interactive=input is not None,
         user=user,
         workdir=workdir,
-        bash=bash,
         **env_kwargs,
     )
     return run(  # skipif-ci
         *cmd_and_args,
+        input=input,
         print=print,
         print_stdout=print_stdout,
         print_stderr=print_stderr,
@@ -232,9 +232,9 @@ def docker_exec_cmd(
     /,
     *cmds_or_args: str,
     env: StrStrMapping | None = None,
+    interactive: bool = False,
     user: str | None = None,
     workdir: PathLike | None = None,
-    bash: bool = False,
     **env_kwargs: str,
 ) -> list[str]:
     """Build a command for `docker exec`."""
@@ -242,16 +242,13 @@ def docker_exec_cmd(
     mapping: dict[str, str] = ({} if env is None else dict(env)) | env_kwargs
     for key, value in mapping.items():
         args.extend(["--env", f"{key}={value}"])
+    if interactive:
+        args.append("--interactive")
     if user is not None:
         args.extend(["--user", user])
     if workdir is not None:
         args.extend(["--workdir", str(workdir)])
-    args.append(container)
-    if bash:
-        args.extend(bash_cmd_and_args(cmd, *cmds_or_args))
-    else:
-        args.extend([cmd, *cmds_or_args])
-    return args
+    return [*args, container, cmd, *cmds_or_args]
 
 
 @contextmanager

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

@@ -20,13 +20,11 @@ if TYPE_CHECKING:
 
 
 _HOST_KEY_ALGORITHMS = ["ssh-ed25519"]
+BASH_LC = ["bash", "-lc"]
+BASH_LS = ["bash", "-ls"]
 MKTEMP_DIR_CMD = ["mktemp", "-d"]
 
 
-def bash_cmd_and_args(cmd: str, /, *cmds: str) -> list[str]:
-    return ["bash", "-lc", "\n".join([cmd, *cmds])]
-
-
 def echo_cmd(text: str, /) -> list[str]:
     return ["echo", text]
 
@@ -69,12 +67,12 @@ def run(
     cmd: str,
     /,
     *cmds_or_args: str,
-    bash: bool = False,
     user: str | int | None = None,
     executable: str | None = None,
     shell: bool = False,
     cwd: PathLike | None = None,
     env: StrStrMapping | None = None,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -88,12 +86,12 @@ def run(
     cmd: str,
     /,
     *cmds_or_args: str,
-    bash: bool = False,
     user: str | int | None = None,
     executable: str | None = None,
     shell: bool = False,
     cwd: PathLike | None = None,
     env: StrStrMapping | None = None,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -107,12 +105,12 @@ def run(
     cmd: str,
     /,
     *cmds_or_args: str,
-    bash: bool = False,
     user: str | int | None = None,
     executable: str | None = None,
     shell: bool = False,
     cwd: PathLike | None = None,
     env: StrStrMapping | None = None,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -126,12 +124,12 @@ def run(
     cmd: str,
     /,
     *cmds_or_args: str,
-    bash: bool = False,
     user: str | int | None = None,
     executable: str | None = None,
     shell: bool = False,
     cwd: PathLike | None = None,
     env: StrStrMapping | None = None,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -145,12 +143,12 @@ def run(
     cmd: str,
     /,
     *cmds_or_args: str,
-    bash: bool = False,
     user: str | int | None = None,
     executable: str | None = None,
     shell: bool = False,
     cwd: PathLike | None = None,
     env: StrStrMapping | None = None,
+    input: str | None = None,
     print: bool = False,
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -163,12 +161,12 @@ def run(
     cmd: str,
     /,
     *cmds_or_args: str,
-    bash: bool = False,
     user: str | int | None = None,
     executable: str | None = None,
     shell: bool = False,
     cwd: PathLike | None = None,
     env: StrStrMapping | None = None,
+    input: str | None = None,  # noqa: A002
     print: bool = False,  # noqa: A002
     print_stdout: bool = False,
     print_stderr: bool = False,
@@ -177,55 +175,46 @@ def run(
     return_stderr: bool = False,
     logger: LoggerLike | None = None,
 ) -> str | None:
-    match bash, user:
-        case False, user_use:
-            args: list[str] = [cmd, *cmds_or_args]
-        case True, None:
-            args: list[str] = bash_cmd_and_args(cmd, *cmds_or_args)
-            user_use = None
-        case True, str() | int():  # skipif-ci-or-mac
-            args: list[str] = [
-                "su",
-                "-",
-                str(user),
-                *bash_cmd_and_args(cmd, *cmds_or_args),
-            ]
-            user_use = None
-        case never:
-            assert_never(never)
+    args: list[str] = []
+    if user is not None:
+        args.extend(["su", "-", str(user)])
+    args.extend([cmd, *cmds_or_args])
     buffer = StringIO()
     stdout = StringIO()
     stderr = StringIO()
+    stdout_outputs: list[IO[str]] = [buffer, stdout]
+    if print or print_stdout:
+        stdout_outputs.append(sys.stdout)
+    stderr_outputs: list[IO[str]] = [buffer, stderr]
+    if print or print_stderr:
+        stderr_outputs.append(sys.stderr)
     with Popen(
         args,
         bufsize=1,
         executable=executable,
+        stdin=PIPE,
         stdout=PIPE,
         stderr=PIPE,
         shell=shell,
         cwd=cwd,
         env=env,
         text=True,
-        user=user_use,
+        user=user,
     ) as proc:
+        if proc.stdin is None:  # pragma: no cover
+            raise ImpossibleCaseError(case=[f"{proc.stdin=}"])
         if proc.stdout is None:  # pragma: no cover
             raise ImpossibleCaseError(case=[f"{proc.stdout=}"])
         if proc.stderr is None:  # pragma: no cover
             raise ImpossibleCaseError(case=[f"{proc.stderr=}"])
         with (
-            _yield_write(
-                proc.stdout,
-                buffer,
-                stdout,
-                *([sys.stdout] if print or print_stdout else []),
-            ),
-            _yield_write(
-                proc.stderr,
-                buffer,
-                stderr,
-                *([sys.stderr] if print or print_stderr else []),
-            ),
+            _yield_write(proc.stdout, "proc.stdout", *stdout_outputs),
+            _yield_write(proc.stderr, "proc.stderr", *stderr_outputs),
         ):
+            if input is not None:
+                _ = proc.stdin.write(input)
+                proc.stdin.flush()
+                proc.stdin.close()
             return_code = proc.wait()
         match return_code, return_ or return_stdout, return_ or return_stderr:
             case 0, True, True:
@@ -247,14 +236,14 @@ def run(
                 if logger is not None:
                     msg = strip_and_dedent(f"""
 'run' failed with:
- - cmd        = {cmd}
- - cmds       = {cmds_or_args}
- - bash       = {bash}
- - user       = {user}
- - executable = {executable}
- - shell      = {shell}
- - cwd        = {cwd}
- - env        = {env}
+ - cmd          = {cmd}
+ - cmds_or_args = {cmds_or_args}
+ - user         = {user}
+ - executable   = {executable}
+ - shell        = {shell}
+ - cwd          = {cwd}
+ - env          = {env}
+ - input        = {input}
 
 -- stdout ---------------------------------------------------------------------
 {stdout_text}-------------------------------------------------------------------------------
@@ -270,8 +259,8 @@ def run(
 
 
 @contextmanager
-def _yield_write(input_: IO[str], /, *outputs: IO[str]) -> Iterator[None]:
-    thread = Thread(target=_run_target, args=(input_, *outputs), daemon=True)
+def _yield_write(input_: IO[str], desc: str, /, *outputs: IO[str]) -> Iterator[None]:
+    thread = Thread(target=_run_target, args=(input_, desc, *outputs), daemon=True)
     thread.start()
     try:
         yield
@@ -279,23 +268,139 @@ def _yield_write(input_: IO[str], /, *outputs: IO[str]) -> Iterator[None]:
         thread.join()
 
 
-def _run_target(input_: IO[str], /, *outputs: IO[str]) -> None:
-    with input_:
-        for line in iter(input_.readline, ""):
-            for output in outputs:
-                _ = output.write(line)
+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 _write_to_streams(text: str, /, *outputs: IO[str]) -> None:
+    for output in outputs:
+        _ = output.write(text)
+
+
+@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_: Literal[True],
+    return_stdout: bool = False,
+    return_stderr: bool = False,
+    logger: LoggerLike | None = None,
+) -> str: ...
+@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: Literal[True],
+    return_stderr: bool = False,
+    logger: LoggerLike | None = None,
+) -> str: ...
+@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: Literal[True],
+    logger: LoggerLike | None = None,
+) -> str: ...
+@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_: Literal[False] = False,
+    return_stdout: Literal[False] = False,
+    return_stderr: Literal[False] = False,
+    logger: LoggerLike | None = None,
+) -> None: ...
+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,  # noqa: A002
+    print: bool = False,  # noqa: A002
+    print_stdout: bool = False,
+    print_stderr: bool = False,
+    return_: bool = False,
+    return_stdout: bool = False,
+    return_stderr: bool = False,
+    logger: LoggerLike | None = None,
+) -> str | None:
+    cmd_and_args = ssh_cmd(  # skipif-ci
+        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,
+    )
+    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,
+    )
 
 
 def ssh_cmd(
     user: str,
     hostname: str,
-    cmd: str,
     /,
-    *cmds_or_args: 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,
-    bash: bool = False,
 ) -> list[str]:
     args: list[str] = ["ssh"]
     if batch_mode:
@@ -303,12 +408,7 @@ def ssh_cmd(
     args.extend(["-o", f"HostKeyAlgorithms={','.join(host_key_algorithms)}"])
     if strict_host_key_checking:
         args.extend(["-o", "StrictHostKeyChecking=yes"])
-    args.append(f"{user}@{hostname}")
-    if bash:
-        args.extend(bash_cmd_and_args(cmd, *cmds_or_args))
-    else:
-        args.extend([cmd, *cmds_or_args])
-    return args
+    return [*args, "-T", f"{user}@{hostname}", *cmd_and_cmds_or_args]
 
 
 def sudo_cmd(cmd: str, /, *args: str) -> list[str]:
@@ -320,8 +420,9 @@ def touch_cmd(path: PathLike, /) -> list[str]:
 
 
 __all__ = [
+    "BASH_LC",
+    "BASH_LS",
     "MKTEMP_DIR_CMD",
-    "bash_cmd_and_args",
     "echo_cmd",
     "expand_path",
     "maybe_sudo_cmd",
@@ -329,6 +430,7 @@ __all__ = [
     "mkdir_cmd",
     "rm_cmd",
     "run",
+    "ssh",
     "ssh_cmd",
     "sudo_cmd",
     "touch_cmd",