shelltastic 0.4.8__tar.gz → 0.5.0__tar.gz

{shelltastic-0.4.8 → shelltastic-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shelltastic
-Version: 0.4.8
+Version: 0.5.0
 Summary: A fantastic shell command runner for python
 Author: Bearmine
 License-Expression: MPL-2.0

{shelltastic-0.4.8 → shelltastic-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shelltastic"
-version = "0.4.8"
+version = "0.5.0"
 description = "A fantastic shell command runner for python"
 readme = "README.md"
 authors = [

{shelltastic-0.4.8 → shelltastic-0.5.0}/src/shelltastic/backend/default/common.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
 import logging
+import os
 import shlex
 import subprocess
+import time
 from multiprocessing.pool import ThreadPool
 from typing import IO, TYPE_CHECKING, Literal
 
@@ -17,6 +19,74 @@ if TYPE_CHECKING:
 LOGGER = logging.getLogger(__name__)
 
 
+class IOTimeoutStream:
+    """
+    Iterable for reading from an IO stream. Return lines but
+    if no bytes have been read since the given timeout, return
+    whatever is in the buffer.
+    """
+
+    def __init__(
+        self, io: IO[bytes], *, timeout: float = 0.1, batch_size: int = 1000
+    ) -> None:
+        self.io = io
+        self.buffer = b""
+        self.batch_size = batch_size
+        self.timeout = timeout
+
+    def __iter__(self):
+        return self
+
+    def __next__(self) -> bytes:
+        last_read_time = time.time()
+        # Read into our buffer
+        while True:
+            # If we have no data in our buffer, then we block until we get data.
+            # Otherwise, we're waiting for end of line and should unblock.
+            if len(self.buffer) == 0:
+                os.set_blocking(self.io.fileno(), True)
+                batch_size = 1
+            else:
+                os.set_blocking(self.io.fileno(), False)
+                batch_size = self.batch_size
+
+            # Read from IO
+            batch = self.io.read(batch_size)
+
+            # Handle return batch
+            # None means no data to read, but NOT end of file
+            if batch is not None:
+                last_read_time = time.time()
+                self.buffer += batch
+
+                # If batch is not none,
+                # and the batch was 0 size,
+                # and our buffer is empty,
+                # we're at EOF
+                if len(self.buffer) == 0:
+                    raise StopIteration()
+
+            # If buffer contains at least one line, return the first line, save the rest
+            if b"\n" in self.buffer:
+                buffer_lines = self.buffer.splitlines(keepends=True)
+                self.buffer = b""
+                for b in buffer_lines[1:]:
+                    self.buffer += b
+                return buffer_lines[0]
+
+            # If we're at end of file, and we have no lines, just return what we have
+            if batch is not None and len(batch) == 0:
+                return_val = self.buffer
+                self.buffer = b""
+                return return_val
+
+            # Handle timeout
+            if time.time() - last_read_time >= self.timeout:
+                return_val = self.buffer
+                self.buffer = b""
+                return return_val
+
+
 def _output_and_collect(
     io: IO[bytes] | None, display: display.IODisplay | None, collect: bool = True
 ) -> bytes | None:
@@ -26,14 +96,14 @@ def _output_and_collect(
     if collect:
         if display:
             return_bytes: bytes = b""
-            for line in io:
+            for line in IOTimeoutStream(io):
                 return_bytes += line
                 display.printbytes(line)
             return return_bytes
         return io.read()
 
     if display:
-        for line in io:
+        for line in IOTimeoutStream(io):
             display.printbytes(line)
 
     return None

{shelltastic-0.4.8 → shelltastic-0.5.0}/src/shelltastic/display.py

@@ -13,30 +13,36 @@ _io_display_lock = threading.RLock()
 class IODisplay(ABC):
     def printbytes(self, line: bytes):
         with _io_display_lock:
-            self._emit_line("%s", line.decode().rstrip())
+            self._emit("%s", line.decode(), end="")
 
     def printline(self, msg: object, *args: object):
         with _io_display_lock:
-            self._emit_line(msg, *args)
+            self._emit(msg, *args)
 
     @abstractmethod
-    def _emit_line(self, msg: object, *args: object):
+    def _emit(self, msg: object, *args: object, end="\n"):
         raise NotImplementedError
 
 
 class DevNullDisplay(IODisplay):
-    def _emit_line(self, msg: object, *args: object):
+    def _emit(self, msg: object, *args: object, end="\n"):
         pass
 
 
 class StdoutDisplay(IODisplay):
-    def _emit_line(self, msg: object, *args: object):
-        print(str(msg) % args, flush=True)
+    def _emit(self, msg: object, *args: object, end="\n"):
+        if args:
+            print(str(msg) % args, flush=True, end=end)
+            return
+        print(str(msg), flush=True, end=end)
 
 
 class StderrDisplay(IODisplay):
-    def _emit_line(self, msg: object, *args: object):
-        print(str(msg) % args, file=sys.stderr, flush=True)
+    def _emit(self, msg: object, *args: object, end="\n"):
+        if args:
+            print(str(msg) % args, file=sys.stderr, flush=True, end=end)
+            return
+        print(str(msg), file=sys.stderr, flush=True, end=end)
 
 
 class LogDisplay(IODisplay):
@@ -44,7 +50,7 @@ class LogDisplay(IODisplay):
         super().__init__()
         self.log_level = log_level
 
-    def _emit_line(self, msg: object, *args: object):
+    def _emit(self, msg: object, *args: object, end="\n"):
         LOGGER.log(self.log_level, msg, *args, stacklevel=3)