stouputils 1.19.2__tar.gz → 1.19.4__tar.gz

{stouputils-1.19.2 → stouputils-1.19.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stouputils
-Version: 1.19.2
+Version: 1.19.4
 Summary: Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more.
 Keywords: utilities,tools,helpers,development,python
 Author: Stoupy51

{stouputils-1.19.2 → stouputils-1.19.4}/pyproject.toml

@@ -8,7 +8,7 @@ module-root = ""
 
 [project]
 name = "stouputils"
-version = "1.19.2"
+version = "1.19.4"
 description = "Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more."
 readme = "README.md"
 keywords = ["utilities", "tools", "helpers", "development", "python"]

{stouputils-1.19.2 → stouputils-1.19.4}/stouputils/parallel/capturer.py

@@ -27,13 +27,23 @@ class CaptureOutput:
 	The class creates an os.pipe(), marks fds as inheritable (for spawn method),
 	provides methods to start a listener thread that reads from the pipe and writes
 	to the main process's sys.stdout/sys.stderr, and to close/join the listener.
+
+	>>> capturer = CaptureOutput(encoding="utf-8", errors="replace")
+
+	>>> pass # send capturer object to subprocess
+	>>> capturer.redirect()  # Redirects sys.stdout/sys.stderr to the pipe
+
+	>>> pass # in parent process:
+	>>> #capturer.parent_close_write()  # Close parent's write end
+	>>> capturer.start_listener()      # Start listener thread to read from pipe
+	>>> ...                            # do other work
+	>>> capturer.join_listener(timeout=0.1)       # Wait for listener to finish (on EOF)
 	"""
-	def __init__(self, encoding: str = "utf-8", errors: str = "replace", chunk_size: int = 1024):
+	def __init__(self, encoding: str = "utf-8", errors: str = "replace"):
 		import multiprocessing as mp
 		import threading
 		self.encoding: str = encoding
 		self.errors: str = errors
-		self.chunk_size: int = chunk_size
 		self.read_conn, self.write_conn = mp.Pipe(duplex=False)
 		self.read_fd = self.read_conn.fileno()
 		self.write_fd = self.write_conn.fileno()
@@ -91,10 +101,11 @@ class CaptureOutput:
 			nonlocal buffer
 			try:
 				while True:
-					# Read a chunk from the pipe, stop loop on error
+					# Read the next message from the pipe. Use recv_bytes() without a maxlength
+					# so we don't error when a single message is larger than our chunk size.
 					try:
-						data: bytes = self.read_conn.recv_bytes(self.chunk_size)
-					except EOFError:
+						data: bytes = self.read_conn.recv_bytes()
+					except (EOFError, OSError, BrokenPipeError):
 						_handle_buffer()
 						break
 
@@ -104,10 +115,7 @@ class CaptureOutput:
 					except Exception:
 						chunk = data.decode(self.encoding, errors="replace")
 					buffer += chunk
-
-					# Periodically flush large buffers to avoid holding too much memory
-					if len(buffer) > self.chunk_size * 4:
-						_handle_buffer()
+					_handle_buffer()
 			finally:
 				safe_close(self.read_conn)
 				self.read_fd = -1

{stouputils-1.19.2 → stouputils-1.19.4}/stouputils/parallel/capturer.pyi

@@ -12,20 +12,30 @@ class PipeWriter:
     def flush(self) -> None: ...
 
 class CaptureOutput:
-    """ Utility to capture stdout/stderr from a subprocess and relay it to the parent's stdout.
+    ''' Utility to capture stdout/stderr from a subprocess and relay it to the parent\'s stdout.
 
 \tThe class creates an os.pipe(), marks fds as inheritable (for spawn method),
 \tprovides methods to start a listener thread that reads from the pipe and writes
-\tto the main process's sys.stdout/sys.stderr, and to close/join the listener.
-\t"""
+\tto the main process\'s sys.stdout/sys.stderr, and to close/join the listener.
+
+\t>>> capturer = CaptureOutput(encoding="utf-8", errors="replace")
+
+\t>>> pass # send capturer object to subprocess
+\t>>> capturer.redirect()  # Redirects sys.stdout/sys.stderr to the pipe
+
+\t>>> pass # in parent process:
+\t>>> #capturer.parent_close_write()  # Close parent\'s write end
+\t>>> capturer.start_listener()      # Start listener thread to read from pipe
+\t>>> ...                            # do other work
+\t>>> capturer.join_listener(timeout=0.1)       # Wait for listener to finish (on EOF)
+\t'''
     encoding: str
     errors: str
-    chunk_size: int
     read_fd: Incomplete
     write_fd: Incomplete
     _thread: threading.Thread | None
     _reader_file: IO[Any] | None
-    def __init__(self, encoding: str = 'utf-8', errors: str = 'replace', chunk_size: int = 1024) -> None: ...
+    def __init__(self, encoding: str = 'utf-8', errors: str = 'replace') -> None: ...
     def __repr__(self) -> str: ...
     def __getstate__(self) -> dict[str, Any]: ...
     def redirect(self) -> None: