ssh-handler 1.4.1__tar.gz → 1.5.0__tar.gz

{ssh_handler-1.4.1/ssh_handler.egg-info → ssh_handler-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ssh-handler
-Version: 1.4.1
+Version: 1.5.0
 Summary: Extensive SSH/SFTP/SCP/FTP handler built on Paramiko, for test automation, CLIs and PyQt5 tools.
 Author: ssh-handler contributors
 License-Expression: MIT

{ssh_handler-1.4.1 → ssh_handler-1.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ssh-handler"
-version = "1.4.1"
+version = "1.5.0"
 description = "Extensive SSH/SFTP/SCP/FTP handler built on Paramiko, for test automation, CLIs and PyQt5 tools."
 readme = "README.md"
 requires-python = ">=3.8"

{ssh_handler-1.4.1 → ssh_handler-1.5.0}/ssh_handler/__init__.py

@@ -22,7 +22,7 @@ dependencies (PyQt5 / scp) don't break the core package.
 
 from __future__ import annotations
 
-__version__ = "1.4.1"
+__version__ = "1.5.0"
 
 from .config import SSHConfig, FTPConfig
 from .core import SSHHandler, ShellSession

{ssh_handler-1.4.1 → ssh_handler-1.5.0}/ssh_handler/core.py

@@ -603,7 +603,7 @@ class SSHHandler:
     # Continuous / streaming output (tail -f, slog2info -w, journalctl -f…)
     # ------------------------------------------------------------------ #
     def iter_lines(self, command: str, *, timeout: Optional[float] = None,
-                   stop_event=None, get_pty: bool = True, encoding: str = "utf-8",
+                   stop_event=None, get_pty: bool = False, encoding: str = "utf-8",
                    idle_poll: float = 0.4):
         """
         Run a (possibly never-ending) command and yield its stdout **line by
@@ -655,7 +655,8 @@ class SSHHandler:
 
     def stream(self, command: str, *, on_line=None, on_match=None, match=None,
                stop_on_match: bool = False, save_to: Optional[str] = None,
-               append: bool = True, timeout: Optional[float] = None,
+               append: bool = True, clean: bool = True,
+               timeout: Optional[float] = None,
                stop_event=None, encoding: str = "utf-8", safe: Optional[bool] = None):
         """
         Consume a streaming command with built-in matching and file logging.
@@ -669,6 +670,7 @@ class SSHHandler:
         :returns:             dict with 'lines' (count) and 'matches' (list).
         """
         import re
+        from .results import strip_ansi
 
         def _do():
             pat = re.compile(match) if isinstance(match, str) else match
@@ -678,6 +680,8 @@ class SSHHandler:
             try:
                 for line in self.iter_lines(command, timeout=timeout,
                                             stop_event=stop_event, encoding=encoding):
+                    if clean:
+                        line = strip_ansi(line)
                     count += 1
                     if fh:
                         fh.write(line + "\n")
@@ -708,8 +712,9 @@ class SSHHandler:
     def serial_stream(self, device: str = "/dev/ttyUSB0", *, baudrate: int = 115200,
                       mode: str = "auto", on_line=None, on_match=None, match=None,
                       stop_on_match: bool = False, save_to: Optional[str] = None,
-                      timeout: Optional[float] = None, stop_event=None,
-                      configure: bool = True, safe: Optional[bool] = None):
+                      clean: bool = True, timeout: Optional[float] = None,
+                      stop_event=None, configure: bool = True,
+                      safe: Optional[bool] = None):
         """
         Stream a serial port attached to the **remote** host, over SSH — so it
         works through a jump host (laptop -> RDP machine -> target). Same live
@@ -753,7 +758,7 @@ class SSHHandler:
             else:
                 cmd = f"cat {dev}"
         return self.stream(cmd, on_line=on_line, on_match=on_match, match=match,
-                           stop_on_match=stop_on_match, save_to=save_to,
+                           stop_on_match=stop_on_match, save_to=save_to, clean=clean,
                            timeout=timeout, stop_event=stop_event, safe=safe)
 
     def serial_write(self, device: str, data: str, *, baudrate: int = 115200,
@@ -1027,6 +1032,10 @@ class SSHHandler:
         local_path = os.path.expanduser(local_path)
         sftp = self.sftp()
         start = time.time()
+        # Verify the remote path exists FIRST, so a missing source never leaves
+        # behind an empty local file (sftp.get opens the local file before fetch).
+        if not self._remote_exists(sftp, remote_path):
+            raise SSHTransferError(f"Remote path does not exist: {remote_path}")
         try:
             if self._remote_is_dir(sftp, remote_path):
                 if not recursive:
@@ -1039,7 +1048,17 @@ class SSHHandler:
                     if parent and not os.path.exists(parent):
                         os.makedirs(parent, exist_ok=True)
                 self._emit(logging.INFO, f"PULL {remote_path} -> {local_path}")
-                sftp.get(remote_path, local_path, callback=callback)
+                existed = os.path.exists(local_path)
+                try:
+                    sftp.get(remote_path, local_path, callback=callback)
+                except BaseException:
+                    # don't leave a partial/empty local file behind on failure
+                    if not existed and os.path.exists(local_path):
+                        try:
+                            os.remove(local_path)
+                        except OSError:
+                            pass
+                    raise
                 size, count = os.path.getsize(local_path), 1
         except SSHTransferError:
             raise

{ssh_handler-1.4.1 → ssh_handler-1.5.0}/ssh_handler/results.py

@@ -2,11 +2,28 @@
 
 from __future__ import annotations
 
+import re
 import time
 from dataclasses import dataclass, field, asdict
 from typing import Optional
 
 
+# ANSI/VT escape sequences (CSI like ESC[23;80H, OSC like ESC]0;title BEL, etc.)
+_ANSI_RE = re.compile(r"\x1b(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~]|\][^\x07\x1b]*(?:\x07|\x1b\\))")
+# control chars except tab(09), newline(0a), carriage-return(0d handled separately)
+_CTRL_RE = re.compile(r"[\x00-\x08\x0b\x0c\x0e-\x1f\x7f]")
+
+
+def strip_ansi(text: str) -> str:
+    """Remove ANSI/VT escape codes, carriage returns, and other control chars,
+    so streamed console output is clean to save, match, and read."""
+    if not text:
+        return text
+    text = _ANSI_RE.sub("", text)
+    text = text.replace("\r", "")
+    return _CTRL_RE.sub("", text)
+
+
 def _human_size(num: float) -> str:
     for unit in ("B", "KB", "MB", "GB", "TB"):
         if abs(num) < 1024.0:
@@ -43,10 +60,8 @@ class CommandResult:
         return asdict(self)
 
     def __str__(self) -> str:
-        return (
-            f"<CommandResult host={self.host} exit={self.exit_code} "
-            f"ok={self.ok} dur={self.duration:.2f}s cmd={self.command!r}>"
-        )
+        status = "ok" if self.ok else f"FAILED (exit {self.exit_code})"
+        return f"$ {self.command}  [{status}, {self.duration:.2f}s]"
 
 
 @dataclass
@@ -79,11 +94,11 @@ class TransferResult:
         return d
 
     def __str__(self) -> str:
-        return (
-            f"<TransferResult {self.direction}/{self.protocol} "
-            f"{self.source} -> {self.dest} {self.human_size} "
-            f"in {self.duration:.2f}s ({self.human_speed}), files={self.files}>"
-        )
+        verb = "Uploaded" if self.direction == "push" else "Downloaded"
+        files = f"{self.files} files, " if self.files != 1 else ""
+        return (f"{verb} {self.source} -> {self.dest}  "
+                f"({files}{self.human_size} in {self.duration:.2f}s, "
+                f"{self.human_speed})")
 
 
 @dataclass

{ssh_handler-1.4.1 → ssh_handler-1.5.0}/ssh_handler/serial_handler.py

@@ -153,12 +153,16 @@ class SerialHandler:
 
     def stream(self, *, on_line=None, on_match=None, match=None,
                stop_on_match: bool = False, save_to: Optional[str] = None,
-               append: bool = True, timeout: Optional[float] = None, stop_event=None,
+               append: bool = True, clean: bool = True,
+               timeout: Optional[float] = None, stop_event=None,
                encoding: str = "utf-8", safe=None):
         """
         Read the serial console continuously with built-in matching + file
-        logging. Same signature/semantics as SSHHandler.stream.
+        logging. Same signature/semantics as SSHHandler.stream. ``clean=True``
+        strips ANSI escape codes and control chars from each line.
         """
+        from .results import strip_ansi
+
         def _do():
             pat = re.compile(match) if isinstance(match, str) else match
             matches, count = [], 0
@@ -167,6 +171,8 @@ class SerialHandler:
             try:
                 for line in self.iter_lines(stop_event=stop_event, timeout=timeout,
                                             encoding=encoding):
+                    if clean:
+                        line = strip_ansi(line)
                     count += 1
                     if fh:
                         fh.write(line + "\n")

{ssh_handler-1.4.1 → ssh_handler-1.5.0/ssh_handler.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ssh-handler
-Version: 1.4.1
+Version: 1.5.0
 Summary: Extensive SSH/SFTP/SCP/FTP handler built on Paramiko, for test automation, CLIs and PyQt5 tools.
 Author: ssh-handler contributors
 License-Expression: MIT