stouputils 1.19.5__tar.gz → 1.20.0__tar.gz

{stouputils-1.19.5 → stouputils-1.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stouputils
-Version: 1.19.5
+Version: 1.20.0
 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
@@ -17,6 +17,7 @@ Requires-Dist: msgspec[toml,yaml]>=0.20.0
 Requires-Dist: pillow>=12.0.0
 Requires-Dist: python-box>=7.0.0
 Requires-Dist: argcomplete>=3.0.0
+Requires-Dist: setproctitle
 Requires-Dist: numpy
 Requires-Dist: opencv-python ; extra == 'data-science'
 Requires-Dist: scikit-image ; extra == 'data-science'

{stouputils-1.19.5 → stouputils-1.20.0}/pyproject.toml

@@ -8,7 +8,7 @@ module-root = ""
 
 [project]
 name = "stouputils"
-version = "1.19.5"
+version = "1.20.0"
 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"]
@@ -28,6 +28,7 @@ dependencies = [
     "pillow>=12.0.0",
     "python-box>=7.0.0",
     "argcomplete>=3.0.0",
+    "setproctitle",
     "numpy",
 ]
 authors = [

{stouputils-1.19.5 → stouputils-1.20.0}/stouputils/parallel/multi.py

@@ -28,6 +28,7 @@ def multiprocessing[T, R](
 	capture_output: bool = False,
 	delay_first_calls: float = 0,
 	nice: int | None = None,
+	process_title: str | None = None,
 	color: str = MAGENTA,
 	bar_format: str = BAR_FORMAT,
 	ascii: bool = False,
@@ -61,6 +62,7 @@ def multiprocessing[T, R](
 			Positive values reduce priority, negative values increase it.
 			Automatically converted to appropriate priority class on Windows.
 			If None, no priority adjustment is made.
+		process_title		(str | None):		If provided, sets the process title for worker processes.
 		color				(str):				Color of the progress bar (Defaults to MAGENTA)
 		bar_format			(str):				Format of the progress bar (Defaults to BAR_FORMAT)
 		ascii				(bool):				Whether to use ASCII or Unicode characters for the progress bar
@@ -139,6 +141,11 @@ def multiprocessing[T, R](
 			wrapped_args = args
 			wrapped_func = func
 
+		# Wrap function with process_title if specified
+		if process_title is not None:
+			wrapped_args = [(process_title, i, wrapped_func, arg) for i, arg in enumerate(wrapped_args)]
+			wrapped_func = process_title_wrapper
+
 		# Capture output if specified
 		capturer: CaptureOutput | None = None
 		if capture_output:
@@ -307,3 +314,20 @@ def capture_subprocess_output[T, R](args: tuple[CaptureOutput, Callable[[T], R],
 	capturer.redirect()
 	return func(arg)
 
+
+# "Private" function for setting process title in multiprocessing subprocess
+def process_title_wrapper[T, R](args: tuple[str, int, Callable[[T], R], T]) -> R:
+	""" Wrapper function to set the process title before executing the target function.
+
+	Args:
+		tuple[str,int,Callable,T]: Tuple containing:
+			str: Process title to set
+			int: Worker index to append to title
+			Callable: Target function to execute
+			T: Argument to pass to the target function
+	"""
+	process_title, index, func, arg = args
+	import setproctitle
+	setproctitle.setproctitle(f"{process_title} #{index}")
+	return func(arg)
+

{stouputils-1.19.5 → stouputils-1.20.0}/stouputils/parallel/multi.pyi

@@ -7,7 +7,7 @@ from typing import Any
 
 def doctest_square(x: int) -> int: ...
 def doctest_slow(x: int) -> int: ...
-def multiprocessing[T, R](func: Callable[..., R] | list[Callable[..., R]], args: Iterable[T], use_starmap: bool = False, chunksize: int = 1, desc: str = '', max_workers: int | float = ..., capture_output: bool = False, delay_first_calls: float = 0, nice: int | None = None, color: str = ..., bar_format: str = ..., ascii: bool = False, smooth_tqdm: bool = True, **tqdm_kwargs: Any) -> list[R]:
+def multiprocessing[T, R](func: Callable[..., R] | list[Callable[..., R]], args: Iterable[T], use_starmap: bool = False, chunksize: int = 1, desc: str = '', max_workers: int | float = ..., capture_output: bool = False, delay_first_calls: float = 0, nice: int | None = None, process_title: str | None = None, color: str = ..., bar_format: str = ..., ascii: bool = False, smooth_tqdm: bool = True, **tqdm_kwargs: Any) -> list[R]:
     ''' Method to execute a function in parallel using multiprocessing
 
 \t- For CPU-bound operations where the GIL (Global Interpreter Lock) is a bottleneck.
@@ -35,6 +35,7 @@ def multiprocessing[T, R](func: Callable[..., R] | list[Callable[..., R]], args:
 \t\t\tPositive values reduce priority, negative values increase it.
 \t\t\tAutomatically converted to appropriate priority class on Windows.
 \t\t\tIf None, no priority adjustment is made.
+\t\tprocess_title\t\t(str | None):\t\tIf provided, sets the process title for worker processes.
 \t\tcolor\t\t\t\t(str):\t\t\t\tColor of the progress bar (Defaults to MAGENTA)
 \t\tbar_format\t\t\t(str):\t\t\t\tFormat of the progress bar (Defaults to BAR_FORMAT)
 \t\tascii\t\t\t\t(bool):\t\t\t\tWhether to use ASCII or Unicode characters for the progress bar
@@ -136,3 +137,13 @@ def capture_subprocess_output[T, R](args: tuple[CaptureOutput, Callable[[T], R],
 \t\t\tCallable: Target function to execute
 \t\t\tT: Argument to pass to the target function
 \t"""
+def process_title_wrapper[T, R](args: tuple[str, int, Callable[[T], R], T]) -> R:
+    """ Wrapper function to set the process title before executing the target function.
+
+\tArgs:
+\t\ttuple[str,int,Callable,T]: Tuple containing:
+\t\t\tstr: Process title to set
+\t\t\tint: Worker index to append to title
+\t\t\tCallable: Target function to execute
+\t\t\tT: Argument to pass to the target function
+\t"""

{stouputils-1.19.5 → stouputils-1.20.0}/stouputils/parallel/subprocess.py

@@ -24,6 +24,7 @@ def run_in_subprocess[R](
 	timeout: float | None = None,
 	no_join: bool = False,
 	capture_output: bool = False,
+	process_title: str | None = None,
 	**kwargs: Any
 ) -> R:
 	""" Execute a function in a subprocess with positional and keyword arguments.
@@ -42,6 +43,7 @@ def run_in_subprocess[R](
 		capture_output (bool):         If True, capture the subprocess' stdout/stderr and relay it
 			in real time to the parent's stdout. This enables seeing print() output
 			from the subprocess in the main process.
+		process_title  (str | None):   If provided, sets the process title visible in process lists.
 		**kwargs       (Any):          Keyword arguments to pass to the function.
 
 	Returns:
@@ -89,7 +91,7 @@ def run_in_subprocess[R](
 	process: mp.Process = mp.Process(
 		target=_subprocess_wrapper,
 		args=(result_queue, func, args, kwargs),
-		kwargs={"capturer": capturer}
+		kwargs={"capturer": capturer, "process_title": process_title}
 	)
 	process.start()
 
@@ -141,7 +143,8 @@ def _subprocess_wrapper[R](
 	func: Callable[..., R],
 	args: tuple[Any, ...],
 	kwargs: dict[str, Any],
-	capturer: CaptureOutput | None = None
+	capturer: CaptureOutput | None = None,
+	process_title: str | None = None
 ) -> None:
 	""" Wrapper function to execute the target function and store the result in the queue.
 
@@ -153,8 +156,14 @@ def _subprocess_wrapper[R](
 		args         (tuple):                         Positional arguments for the function.
 		kwargs       (dict):                          Keyword arguments for the function.
 		capturer     (CaptureOutput | None):          Optional CaptureOutput instance for stdout capture.
+		process_title (str | None):                   Optional process title to set.
 	"""
 	try:
+		# Set process title if provided
+		if process_title is not None:
+			import setproctitle
+			setproctitle.setproctitle(process_title)
+
 		# If a CaptureOutput instance was passed, redirect stdout/stderr to the pipe.
 		if capturer is not None:
 			capturer.redirect()

{stouputils-1.19.5 → stouputils-1.20.0}/stouputils/parallel/subprocess.pyi

@@ -11,7 +11,7 @@ class RemoteSubprocessError(RuntimeError):
     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:
+def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | None = None, no_join: bool = False, capture_output: bool = False, process_title: str | None = None, **kwargs: Any) -> R:
     ''' Execute a function in a subprocess with positional and keyword arguments.
 
 \tThis is useful when you need to run a function in isolation to avoid memory leaks,
@@ -28,6 +28,7 @@ def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | No
 \t\tcapture_output (bool):         If True, capture the subprocess\' stdout/stderr and relay it
 \t\t\tin real time to the parent\'s stdout. This enables seeing print() output
 \t\t\tfrom the subprocess in the main process.
+\t\tprocess_title  (str | None):   If provided, sets the process title visible in process lists.
 \t\t**kwargs       (Any):          Keyword arguments to pass to the function.
 
 \tReturns:
@@ -60,7 +61,7 @@ def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | No
 \t\t\t> # With timeout to prevent hanging
 \t\t\t> run_in_subprocess(some_gpu_func, data, timeout=300.0)
 \t'''
-def _subprocess_wrapper[R](result_queue: Any, func: Callable[..., R], args: tuple[Any, ...], kwargs: dict[str, Any], capturer: CaptureOutput | None = None) -> None:
+def _subprocess_wrapper[R](result_queue: Any, func: Callable[..., R], args: tuple[Any, ...], kwargs: dict[str, Any], capturer: CaptureOutput | None = None, process_title: str | None = None) -> None:
     """ Wrapper function to execute the target function and store the result in the queue.
 
 \tMust be at module level to be pickable on Windows (spawn context).
@@ -71,4 +72,5 @@ def _subprocess_wrapper[R](result_queue: Any, func: Callable[..., R], args: tupl
 \t\targs         (tuple):                         Positional arguments for the function.
 \t\tkwargs       (dict):                          Keyword arguments for the function.
 \t\tcapturer     (CaptureOutput | None):          Optional CaptureOutput instance for stdout capture.
+\t\tprocess_title (str | None):                   Optional process title to set.
 \t"""