mm-std 0.5.2__py3-none-any.whl → 0.5.3__py3-none-any.whl

mm_std/__init__.py

@@ -3,15 +3,19 @@ from .dict_utils import replace_empty_dict_entries
 from .json_utils import ExtendedJSONEncoder, json_dumps
 from .random_utils import random_datetime, random_decimal
 from .str_utils import parse_lines, str_contains_any, str_ends_with_any, str_starts_with_any
+from .subprocess_utils import ShellResult, shell, ssh_shell  # nosec
 
 __all__ = [
     "ExtendedJSONEncoder",
+    "ShellResult",
     "json_dumps",
     "parse_date",
     "parse_lines",
     "random_datetime",
     "random_decimal",
     "replace_empty_dict_entries",
+    "shell",
+    "ssh_shell",
     "str_contains_any",
     "str_ends_with_any",
     "str_starts_with_any",

mm_std/subprocess_utils.py

@@ -0,0 +1,75 @@
+import shlex
+import subprocess  # nosec
+from dataclasses import dataclass
+
+TIMEOUT_EXIT_CODE = 255
+
+
+@dataclass
+class ShellResult:
+    """Result of shell command execution.
+
+    Args:
+        stdout: Standard output from the command
+        stderr: Standard error from the command
+        code: Exit code of the command
+    """
+
+    stdout: str
+    stderr: str
+    code: int
+
+    @property
+    def combined_output(self) -> str:
+        """Combined stdout and stderr output."""
+        result = ""
+        if self.stdout:
+            result += self.stdout
+        if self.stderr:
+            if result:
+                result += "\n"
+            result += self.stderr
+        return result
+
+
+def shell(cmd: str, timeout: int | None = 60, capture_output: bool = True, echo_command: bool = False) -> ShellResult:
+    """Execute a shell command.
+
+    Args:
+        cmd: Command to execute
+        timeout: Timeout in seconds, None for no timeout
+        capture_output: Whether to capture stdout/stderr
+        echo_command: Whether to print the command before execution
+
+    Returns:
+        ShellResult with stdout, stderr and exit code
+    """
+    if echo_command:
+        print(cmd)  # noqa: T201
+    try:
+        process = subprocess.run(cmd, timeout=timeout, capture_output=capture_output, shell=True, check=False)  # noqa: S602 # nosec
+        stdout = process.stdout.decode("utf-8", errors="replace") if capture_output else ""
+        stderr = process.stderr.decode("utf-8", errors="replace") if capture_output else ""
+        return ShellResult(stdout=stdout, stderr=stderr, code=process.returncode)
+    except subprocess.TimeoutExpired:
+        return ShellResult(stdout="", stderr="timeout", code=TIMEOUT_EXIT_CODE)
+
+
+def ssh_shell(host: str, cmd: str, ssh_key_path: str | None = None, timeout: int = 60, echo_command: bool = False) -> ShellResult:
+    """Execute a command on remote host via SSH.
+
+    Args:
+        host: Remote host to connect to
+        cmd: Command to execute on remote host
+        ssh_key_path: Path to SSH private key file
+        timeout: Timeout in seconds
+        echo_command: Whether to print the command before execution
+
+    Returns:
+        ShellResult with stdout, stderr and exit code
+    """
+    ssh_cmd = "ssh -o 'StrictHostKeyChecking=no' -o 'LogLevel=ERROR'"
+    if ssh_key_path:
+        ssh_cmd += f" -i {shlex.quote(ssh_key_path)}"
+    ssh_cmd += f" {shlex.quote(host)} {shlex.quote(cmd)}"
+    return shell(ssh_cmd, timeout=timeout, echo_command=echo_command)

{mm_std-0.5.2.dist-info → mm_std-0.5.3.dist-info}/METADATA

@@ -1,4 +1,4 @@
 Metadata-Version: 2.4
 Name: mm-std
-Version: 0.5.2
+Version: 0.5.3
 Requires-Python: >=3.13

{mm_std-0.5.2.dist-info → mm_std-0.5.3.dist-info}/RECORD

@@ -1,10 +1,11 @@
-mm_std/__init__.py,sha256=ZUQF8XNKe2qwGjhO2JPla1gD1l_YxXCPRA0X5vjpXTo,597
+mm_std/__init__.py,sha256=V1na3dOxX52p44hOwhHFaIgrZEHR3yEjFdmSIcB2n0c,715
 mm_std/date_utils.py,sha256=aFdIacoNgDSPGeUkZihXZADd86TeHu4hr1uIT9zcqvw,1732
 mm_std/dict_utils.py,sha256=GVegQXTIo3tzLGbBkiUSGTJkfaD5WWwz6OQnw9KcXlg,2275
 mm_std/json_utils.py,sha256=3tOv2rowc9B18TpJyGSci1MvPEj5XogRy3qrJ1W_7Bg,4129
 mm_std/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mm_std/random_utils.py,sha256=x3uNuKjKY8GxYjbnOq0LU1pGXhI2wezpH2K-t9hrhfA,2225
 mm_std/str_utils.py,sha256=I6vVC81dGBDTHm7FxW-ka5OlUPjHmgagei7Zjld65lk,1520
-mm_std-0.5.2.dist-info/METADATA,sha256=KCFX6O2KkVXN5yo-CmTHAZ1aqIZBpYjo3vbPVVjBZGQ,74
-mm_std-0.5.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mm_std-0.5.2.dist-info/RECORD,,
+mm_std/subprocess_utils.py,sha256=6Bkw6ZYHT1NLIYbQUV9LGkBzUl5RtaVzMJiLJrTGq48,2507
+mm_std-0.5.3.dist-info/METADATA,sha256=GbbfchD5CvEJq3n5ZMNJyNPwUwvfOd_bJxj7tc6iGqY,74
+mm_std-0.5.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mm_std-0.5.3.dist-info/RECORD,,