mm-std 0.5.4__py3-none-any.whl → 0.6.0__py3-none-any.whl

mm_std/__init__.py

@@ -3,19 +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
+from .subprocess_utils import CmdResult, run_cmd, run_ssh_cmd  # nosec
 
 __all__ = [
+    "CmdResult",
     "ExtendedJSONEncoder",
-    "ShellResult",
     "json_dumps",
     "parse_date",
     "parse_lines",
     "random_datetime",
     "random_decimal",
     "replace_empty_dict_entries",
-    "shell",
-    "ssh_shell",
+    "run_cmd",
+    "run_ssh_cmd",
     "str_contains_any",
     "str_ends_with_any",
     "str_starts_with_any",

mm_std/json_utils.py

@@ -49,17 +49,17 @@ class ExtendedJSONEncoder(json.JSONEncoder):
             raise ValueError(f"Cannot override built-in JSON type: {type_.__name__}")
         cls._type_handlers[type_] = serializer
 
-    def default(self, obj: Any) -> Any:  # noqa: ANN401
+    def default(self, o: Any) -> Any:  # noqa: ANN401
         # Check registered type handlers first
         for type_, handler in self._type_handlers.items():
-            if isinstance(obj, type_):
-                return handler(obj)
+            if isinstance(o, type_):
+                return handler(o)
 
         # Special case: dataclasses (requires is_dataclass check, not isinstance)
-        if is_dataclass(obj) and not isinstance(obj, type):
-            return asdict(obj)  # Don't need recursive serialization
+        if is_dataclass(o) and not isinstance(o, type):
+            return asdict(o)  # Don't need recursive serialization
 
-        return super().default(obj)
+        return super().default(o)
 
 
 def json_dumps(data: Any, type_handlers: dict[type[Any], Callable[[Any], Any]] | None = None, **kwargs: Any) -> str:  # noqa: ANN401

mm_std/subprocess_utils.py

@@ -6,14 +6,8 @@ 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
-    """
+class CmdResult:
+    """Result of command execution."""
 
     stdout: str
     stderr: str
@@ -32,30 +26,57 @@ class ShellResult:
         return result
 
 
-def shell(cmd: str, timeout: int | None = 60, capture_output: bool = True, echo_command: bool = False) -> ShellResult:
-    """Execute a shell command.
+def run_cmd(
+    cmd: str,
+    timeout: int | None = 60,
+    capture_output: bool = True,
+    echo_command: bool = False,
+    shell: bool = False,
+) -> CmdResult:
+    """Execute a 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
+        shell: If False (default), the command is parsed with shlex.split() and
+            executed without shell interpretation. Special characters like
+            backticks, $(), pipes (|), redirects (>, <), and wildcards (*) are
+            treated as literal text. This is the safe mode for commands with
+            user input.
+            If True, the command is passed to the shell as-is, enabling pipes,
+            redirects, command substitution, and other shell features. Use this
+            only for trusted commands that need shell functionality.
 
     Returns:
-        ShellResult with stdout, stderr and exit code
+        CmdResult 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
+        if shell:
+            process = subprocess.run(  # noqa: S602 # nosec
+                cmd, timeout=timeout, capture_output=capture_output, shell=True, check=False
+            )
+        else:
+            process = subprocess.run(  # noqa: S603 # nosec
+                shlex.split(cmd), timeout=timeout, capture_output=capture_output, shell=False, check=False
+            )
         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)
+        return CmdResult(stdout=stdout, stderr=stderr, code=process.returncode)
     except subprocess.TimeoutExpired:
-        return ShellResult(stdout="", stderr="timeout", code=TIMEOUT_EXIT_CODE)
+        return CmdResult(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:
+def run_ssh_cmd(
+    host: str,
+    cmd: str,
+    ssh_key_path: str | None = None,
+    timeout: int = 60,
+    echo_command: bool = False,
+) -> CmdResult:
     """Execute a command on remote host via SSH.
 
     Args:
@@ -66,10 +87,10 @@ def ssh_shell(host: str, cmd: str, ssh_key_path: str | None = None, timeout: int
         echo_command: Whether to print the command before execution
 
     Returns:
-        ShellResult with stdout, stderr and exit code
+        CmdResult 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)
+    return run_cmd(ssh_cmd, timeout=timeout, echo_command=echo_command)

{mm_std-0.5.4.dist-info → mm_std-0.6.0.dist-info}/METADATA

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

mm_std-0.6.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+mm_std/__init__.py,sha256=6VZQzG9evSp0V1HES_OLkbVPP41-ziJ2AwBsSkF4N5M,719
+mm_std/date_utils.py,sha256=aFdIacoNgDSPGeUkZihXZADd86TeHu4hr1uIT9zcqvw,1732
+mm_std/dict_utils.py,sha256=Gq_LYuidf24SWvzNmUx8wVPGuop9263GOxcIflB__uQ,2850
+mm_std/json_utils.py,sha256=SXrqNk5vlUxzJC8TE9yteMl8eTxBcWSQK63CHnQ3ZxI,3983
+mm_std/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mm_std/random_utils.py,sha256=3q5ZylCqfFHKN3VaDXuy4heo8C1jNbLHNNOFvyYJoZY,2253
+mm_std/str_utils.py,sha256=I6vVC81dGBDTHm7FxW-ka5OlUPjHmgagei7Zjld65lk,1520
+mm_std/subprocess_utils.py,sha256=PsrwPdpfPLozVIFbqBNgIAOIKpj0LAeVcq833YGcHbo,3212
+mm_std-0.6.0.dist-info/METADATA,sha256=kGDjddlSMx1LnxwnME8L0qAS6dLmu8H7wOvxW8u0sxw,74
+mm_std-0.6.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+mm_std-0.6.0.dist-info/RECORD,,

{mm_std-0.5.4.dist-info → mm_std-0.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

mm_std-0.5.4.dist-info/RECORD

@@ -1,11 +0,0 @@
-mm_std/__init__.py,sha256=V1na3dOxX52p44hOwhHFaIgrZEHR3yEjFdmSIcB2n0c,715
-mm_std/date_utils.py,sha256=aFdIacoNgDSPGeUkZihXZADd86TeHu4hr1uIT9zcqvw,1732
-mm_std/dict_utils.py,sha256=Gq_LYuidf24SWvzNmUx8wVPGuop9263GOxcIflB__uQ,2850
-mm_std/json_utils.py,sha256=NuDomTThfCkJBCmfQ6vkr7dvChKGsuLoAyLW0TON_dQ,3997
-mm_std/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mm_std/random_utils.py,sha256=3q5ZylCqfFHKN3VaDXuy4heo8C1jNbLHNNOFvyYJoZY,2253
-mm_std/str_utils.py,sha256=I6vVC81dGBDTHm7FxW-ka5OlUPjHmgagei7Zjld65lk,1520
-mm_std/subprocess_utils.py,sha256=6Bkw6ZYHT1NLIYbQUV9LGkBzUl5RtaVzMJiLJrTGq48,2507
-mm_std-0.5.4.dist-info/METADATA,sha256=SnanvJ0gBE6Y_5-dSOkUaH5BVV482k3KPXFhuUKeV5Q,74
-mm_std-0.5.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mm_std-0.5.4.dist-info/RECORD,,