stouputils 1.18.1__tar.gz → 1.18.2__tar.gz

{stouputils-1.18.1 → stouputils-1.18.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stouputils
-Version: 1.18.1
+Version: 1.18.2
 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.18.1 → stouputils-1.18.2}/pyproject.toml

@@ -8,7 +8,7 @@ module-root = ""
 
 [project]
 name = "stouputils"
-version = "1.18.1"
+version = "1.18.2"
 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.18.1 → stouputils-1.18.2}/stouputils/io.py

@@ -492,7 +492,7 @@ def clean_path(file_path: str, trailing_slash: bool = True) -> str:
 	# Return the cleaned path
 	return file_path if file_path != "." else ""
 
-def safe_close(file: IO[Any] | int | None) -> None:
+def safe_close(file: IO[Any] | int | Any | None) -> None:
 	""" Safely close a file object (or file descriptor) after flushing, ignoring any exceptions.
 
 	Args:
@@ -506,9 +506,9 @@ def safe_close(file: IO[Any] | int | None) -> None:
 				except Exception:
 					pass
 	elif file:
-		for func in (file.flush, file.close):
+		for func in ("flush", "close"):
 			try:
-				func()
+				getattr(file, func)()
 			except Exception:
 				pass
 

{stouputils-1.18.1 → stouputils-1.18.2}/stouputils/io.pyi

@@ -211,7 +211,7 @@ def clean_path(file_path: str, trailing_slash: bool = True) -> str:
 \t\t>>> clean_path("C:/folder1\\\\folder2")
 \t\t\'C:/folder1/folder2\'
 \t'''
-def safe_close(file: IO[Any] | int | None) -> None:
+def safe_close(file: IO[Any] | int | Any | None) -> None:
     """ Safely close a file object (or file descriptor) after flushing, ignoring any exceptions.
 
 \tArgs:

{stouputils-1.18.1 → stouputils-1.18.2}/stouputils/parallel/capturer.py

@@ -65,8 +65,7 @@ class CaptureOutput:
 
 	def parent_close_write(self) -> None:
 		""" Close the parent's copy of the write end; the child's copy remains. """
-		safe_close(self.write_fd)
-		self.write_conn.close()
+		safe_close(self.write_conn)
 		self.write_fd = -1	# Prevent accidental reuse
 
 	def start_listener(self) -> None:
@@ -110,8 +109,7 @@ class CaptureOutput:
 					if len(buffer) > self.chunk_size * 4:
 						_handle_buffer()
 			finally:
-				safe_close(self.read_fd)
-				self.read_conn.close()
+				safe_close(self.read_conn)
 				self.read_fd = -1
 				self._thread = None		# Mark thread as stopped so callers don't block unnecessarily
 
@@ -123,8 +121,9 @@ class CaptureOutput:
 	def join_listener(self, timeout: float | None = None) -> None:
 		""" Wait for the listener thread to finish (until EOF). """
 		if self._thread is None:
-			safe_close(self.read_fd)
-			return self.read_conn.close()
+			safe_close(self.read_conn)
+			self.read_fd = -1
+			return
 		self._thread.join(timeout)
 
 		# If thread finished, ensure read fd is closed and clear thread

{stouputils-1.18.1 → stouputils-1.18.2}/stouputils/parallel/subprocess.py

@@ -4,9 +4,20 @@ import time
 from collections.abc import Callable
 from typing import Any
 
+from ..typing import JsonDict
 from .capturer import CaptureOutput
 
 
+class RemoteSubprocessError(RuntimeError):
+	""" Raised in the parent when the child raised an exception - contains the child's formatted traceback. """
+	def __init__(self, exc_type: str, exc_repr: str, traceback_str: str):
+		msg = f"Exception in subprocess ({exc_type}): {exc_repr}\n\nRemote traceback:\n{traceback_str}"
+		super().__init__(msg)
+		self.remote_type = exc_type
+		self.remote_repr = exc_repr
+		self.remote_traceback = traceback_str
+
+
 def run_in_subprocess[R](
 	func: Callable[..., R],
 	*args: Any,
@@ -37,7 +48,8 @@ def run_in_subprocess[R](
 		R: The return value of the function.
 
 	Raises:
-		RuntimeError: If the subprocess exits with a non-zero exit code or times out.
+		RemoteSubprocessError: If the child raised an exception - contains the child's formatted traceback.
+		RuntimeError: If the subprocess exits with a non-zero exit code or did not return a result.
 		TimeoutError: If the subprocess exceeds the specified timeout.
 
 	Examples:
@@ -66,7 +78,7 @@ def run_in_subprocess[R](
 	from multiprocessing import Queue
 
 	# Create a queue to get the result from the subprocess (only if we need to wait)
-	result_queue: Queue[R | Exception] | None = None if no_join else Queue()
+	result_queue: Queue[JsonDict] | None = None if no_join else Queue()
 
 	# Optionally setup output capture pipe and listener
 	capturer: CaptureOutput | None = None
@@ -105,23 +117,22 @@ def run_in_subprocess[R](
 			process.join()
 			raise TimeoutError(f"Subprocess exceeded timeout of {timeout} seconds and was terminated")
 
-		# Check exit code
+		# Retrieve the payload if present
+		result_payload: JsonDict | None = result_queue.get_nowait() if not result_queue.empty() else None
+
+		# If the child sent a structured exception, raise it with the formatted traceback
+		if isinstance(result_payload, dict):
+			if result_payload.pop("ok", False) is False:
+				raise RemoteSubprocessError(**result_payload)
+			else:
+				return result_payload["result"]
+
+		# Raise an error according to the exit code presence
 		if process.exitcode != 0:
-			# Try to get any exception from the queue (non-blocking)
-			if not result_queue.empty():
-				result_or_exception = result_queue.get_nowait()
-				if isinstance(result_or_exception, Exception):
-					raise result_or_exception
 			raise RuntimeError(f"Subprocess failed with exit code {process.exitcode}")
+		raise RuntimeError("Subprocess did not return any result")
 
-		# Retrieve the result
-		try:
-			result_or_exception = result_queue.get_nowait()
-			if isinstance(result_or_exception, Exception):
-				raise result_or_exception
-			return result_or_exception
-		except Exception as e:
-			raise RuntimeError("Subprocess did not return any result") from e
+	# Finally, ensure we drain/join the listener if capturing output
 	finally:
 		if capturer is not None:
 			capturer.join_listener(timeout=5.0)
@@ -154,10 +165,21 @@ def _subprocess_wrapper[R](
 		# Execute the target function and put the result in the queue
 		result: R = func(*args, **kwargs)
 		if result_queue is not None:
-			result_queue.put(result)
+			result_queue.put({"ok": True, "result": result})
 
 	# Handle cleanup and exceptions
 	except Exception as e:
 		if result_queue is not None:
-			result_queue.put(e)
+			try:
+				import traceback
+				tb = traceback.format_exc()
+				result_queue.put({
+					"ok": False,
+					"exc_type": e.__class__.__name__,
+					"exc_repr": repr(e),
+					"traceback_str": tb,
+				})
+			except Exception:
+				# Nothing we can do if even this fails
+				pass
 

{stouputils-1.18.1 → stouputils-1.18.2}/stouputils/parallel/subprocess.pyi

@@ -1,7 +1,16 @@
+from ..typing import JsonDict as JsonDict
 from .capturer import CaptureOutput as CaptureOutput
+from _typeshed import Incomplete
 from collections.abc import Callable as Callable
 from typing import Any
 
+class RemoteSubprocessError(RuntimeError):
+    """ Raised in the parent when the child raised an exception - contains the child's formatted traceback. """
+    remote_type: Incomplete
+    remote_repr: Incomplete
+    remote_traceback: Incomplete
+    def __init__(self, exc_type: str, exc_repr: str, traceback_str: str) -> None: ...
+
 def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | None = None, no_join: bool = False, capture_output: bool = False, **kwargs: Any) -> R:
     ''' Execute a function in a subprocess with positional and keyword arguments.
 
@@ -25,7 +34,8 @@ def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | No
 \t\tR: The return value of the function.
 
 \tRaises:
-\t\tRuntimeError: If the subprocess exits with a non-zero exit code or times out.
+\t\tRemoteSubprocessError: If the child raised an exception - contains the child\'s formatted traceback.
+\t\tRuntimeError: If the subprocess exits with a non-zero exit code or did not return a result.
 \t\tTimeoutError: If the subprocess exceeds the specified timeout.
 
 \tExamples: