stouputils 1.19.4__py3-none-any.whl → 1.20.0__py3-none-any.whl

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/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/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.
@@ -38,10 +39,11 @@ def run_in_subprocess[R](
 		*args          (Any):          Positional arguments to pass to the function.
 		timeout        (float | None): Maximum time in seconds to wait for the subprocess.
 			If None, wait indefinitely. If the subprocess exceeds this time, it will be terminated.
-		no_join        (bool):         If True, do not wait for the subprocess to finish (fire-and-forget).
+		no_join        (bool):         If True, do not wait for the subprocess to finish (fire-and-forget) and return the Process object.
 		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:
@@ -60,10 +62,10 @@ def run_in_subprocess[R](
 			25
 
 			> # Function with multiple arguments
-			> def add(a: int, b: int) -> int:
-			.     return a + b
-			> run_in_subprocess(add, 10, 20)
-			30
+			> def add(a: int, b: int, c: int) -> int:
+			.     return a + b + c
+			> run_in_subprocess(add, 10, 20, c=30)
+			60
 
 			> # Function with keyword arguments
 			> def greet(name: str, greeting: str = "Hello") -> str:
@@ -89,10 +91,19 @@ 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()
 
+	# Function to kill the process safely
+	def kill_process() -> None:
+		if process.is_alive():
+			process.terminate()
+			time.sleep(0.5)
+			if process.is_alive():
+				process.kill()
+			process.join()
+
 	# For capture_output we must close the parent's copy of the write fd and start listener
 	if capturer is not None:
 		capturer.parent_close_write()
@@ -101,36 +112,24 @@ def run_in_subprocess[R](
 	# Detach process if no_join (fire-and-forget)
 	if result_queue is None:
 		# If capturing, leave listener running in background (daemon)
-		return None  # type: ignore
+		return process  # type: ignore
 
 	# Use a single try/finally to ensure we always drain the listener once
 	# and avoid repeating join calls in multiple branches.
 	try:
-		process.join(timeout=timeout)
-
-		# Check if process is still alive (timed out)
-		if process.is_alive():
-			process.terminate()
-			time.sleep(0.5)  # Give it a moment to terminate gracefully
-			if process.is_alive():
-				process.kill()
-			process.join()
-			raise TimeoutError(f"Subprocess exceeded timeout of {timeout} seconds and was terminated")
-
-		# Retrieve the payload if present
-		result_payload: JsonDict | None = result_queue.get_nowait() if not result_queue.empty() else None
+		try:
+			result_payload: JsonDict = result_queue.get(timeout=timeout)
+		except Exception as e:
+			# Queue.get timed out or failed
+			raise TimeoutError(f"Subprocess exceeded timeout of {timeout} seconds and was terminated") from e
+		finally:
+			kill_process()
 
 		# 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:
-			raise RuntimeError(f"Subprocess failed with exit code {process.exitcode}")
-		raise RuntimeError("Subprocess did not return any result")
+		if result_payload.pop("ok", False) is False:
+			raise RemoteSubprocessError(**result_payload)
+		else:
+			return result_payload["result"]
 
 	# Finally, ensure we drain/join the listener if capturing output
 	finally:
@@ -144,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.
 
@@ -155,12 +155,18 @@ def _subprocess_wrapper[R](
 		func         (Callable):                      The target function to execute.
 		args         (tuple):                         Positional arguments for the function.
 		kwargs       (dict):                          Keyword arguments for the function.
-		_capturer    (CaptureOutput | None):          Optional CaptureOutput instance for stdout capture.
+		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()
+		if capturer is not None:
+			capturer.redirect()
 
 		# Execute the target function and put the result in the queue
 		result: R = func(*args, **kwargs)

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,
@@ -24,10 +24,11 @@ def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | No
 \t\t*args          (Any):          Positional arguments to pass to the function.
 \t\ttimeout        (float | None): Maximum time in seconds to wait for the subprocess.
 \t\t\tIf None, wait indefinitely. If the subprocess exceeds this time, it will be terminated.
-\t\tno_join        (bool):         If True, do not wait for the subprocess to finish (fire-and-forget).
+\t\tno_join        (bool):         If True, do not wait for the subprocess to finish (fire-and-forget) and return the Process object.
 \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:
@@ -46,10 +47,10 @@ def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | No
 \t\t\t25
 
 \t\t\t> # Function with multiple arguments
-\t\t\t> def add(a: int, b: int) -> int:
-\t\t\t.     return a + b
-\t\t\t> run_in_subprocess(add, 10, 20)
-\t\t\t30
+\t\t\t> def add(a: int, b: int, c: int) -> int:
+\t\t\t.     return a + b + c
+\t\t\t> run_in_subprocess(add, 10, 20, c=30)
+\t\t\t60
 
 \t\t\t> # Function with keyword arguments
 \t\t\t> def greet(name: str, greeting: str = "Hello") -> str:
@@ -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).
@@ -70,5 +71,6 @@ def _subprocess_wrapper[R](result_queue: Any, func: Callable[..., R], args: tupl
 \t\tfunc         (Callable):                      The target function to execute.
 \t\targs         (tuple):                         Positional arguments for the function.
 \t\tkwargs       (dict):                          Keyword arguments for the function.
-\t\t_capturer    (CaptureOutput | None):          Optional CaptureOutput instance for stdout capture.
+\t\tcapturer     (CaptureOutput | None):          Optional CaptureOutput instance for stdout capture.
+\t\tprocess_title (str | None):                   Optional process title to set.
 \t"""

stouputils/print.py

@@ -375,49 +375,29 @@ def info(
 		else:
 			print(message, *values, RESET, file=file, **print_kwargs)
 
-def debug(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def debug(*values: Any, flush: bool = True, color: str = CYAN, text: str = "DEBUG", **print_kwargs: Any) -> None:
 	""" Print a debug message looking like "[DEBUG HH:MM:SS] message" in cyan by default. """
-	if "text" not in print_kwargs:
-		print_kwargs["text"] = "DEBUG"
-	if "color" not in print_kwargs:
-		print_kwargs["color"] = CYAN
-	info(*values, flush=flush, **print_kwargs)
+	info(*values, flush=flush, color=color, text=text, **print_kwargs)
 
-def alt_debug(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def alt_debug(*values: Any, flush: bool = True, color: str = BLUE, text: str = "DEBUG", **print_kwargs: Any) -> None:
 	""" Print a debug message looking like "[DEBUG HH:MM:SS] message" in blue by default. """
-	if "text" not in print_kwargs:
-		print_kwargs["text"] = "DEBUG"
-	if "color" not in print_kwargs:
-		print_kwargs["color"] = BLUE
-	info(*values, flush=flush, **print_kwargs)
+	info(*values, flush=flush, color=color, text=text, **print_kwargs)
 
-def suggestion(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def suggestion(*values: Any, flush: bool = True, color: str = CYAN, text: str = "SUGGESTION", **print_kwargs: Any) -> None:
 	""" Print a suggestion message looking like "[SUGGESTION HH:MM:SS] message" in cyan by default. """
-	if "text" not in print_kwargs:
-		print_kwargs["text"] = "SUGGESTION"
-	if "color" not in print_kwargs:
-		print_kwargs["color"] = CYAN
-	info(*values, flush=flush, **print_kwargs)
+	info(*values, flush=flush, color=color, text=text, **print_kwargs)
 
-def progress(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def progress(*values: Any, flush: bool = True, color: str = MAGENTA, text: str = "PROGRESS", **print_kwargs: Any) -> None:
 	""" Print a progress message looking like "[PROGRESS HH:MM:SS] message" in magenta by default. """
-	if "text" not in print_kwargs:
-		print_kwargs["text"] = "PROGRESS"
-	if "color" not in print_kwargs:
-		print_kwargs["color"] = MAGENTA
-	info(*values, flush=flush, **print_kwargs)
+	info(*values, flush=flush, color=color, text=text, **print_kwargs)
 
-def warning(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def warning(*values: Any, flush: bool = True, color: str = YELLOW, text: str = "WARNING", **print_kwargs: Any) -> None:
 	""" Print a warning message looking like "[WARNING HH:MM:SS] message" in yellow by default and in sys.stderr. """
 	if "file" not in print_kwargs:
 		print_kwargs["file"] = sys.stderr
-	if "text" not in print_kwargs:
-		print_kwargs["text"] = "WARNING"
-	if "color" not in print_kwargs:
-		print_kwargs["color"] = YELLOW
-	info(*values, flush=flush, **print_kwargs)
+	info(*values, flush=flush, color=color, text=text, **print_kwargs)
 
-def error(*values: Any, exit: bool = False, flush: bool = True, **print_kwargs: Any) -> None:
+def error(*values: Any, exit: bool = False, flush: bool = True, color: str = RED, text: str = "ERROR", **print_kwargs: Any) -> None:
 	""" Print an error message (in sys.stderr and in red by default)
 	and optionally ask the user to continue or stop the program.
 
@@ -425,6 +405,9 @@ def error(*values: Any, exit: bool = False, flush: bool = True, **print_kwargs:
 		values			(Any):		Values to print (like the print function)
 		exit			(bool):		Whether to ask the user to continue or stop the program,
 			false to ignore the error automatically and continue
+		flush			(bool):		Whether to flush the output
+		color			(str):		Color of the message (default: RED)
+		text			(str):		Text in the message (replaces "ERROR ")
 		print_kwargs	(dict):		Keyword arguments to pass to the print function
 	"""
 	file: TextIO = sys.stderr
@@ -433,11 +416,7 @@ def error(*values: Any, exit: bool = False, flush: bool = True, **print_kwargs:
 			file = cast(TextIO, print_kwargs["file"][0])
 		else:
 			file = print_kwargs["file"]
-	if "text" not in print_kwargs:
-		print_kwargs["text"] = "ERROR"
-	if "color" not in print_kwargs:
-		print_kwargs["color"] = RED
-	info(*values, flush=flush, **print_kwargs)
+	info(*values, flush=flush, color=color, text=text, **print_kwargs)
 	if exit:
 		try:
 			print("Press enter to ignore error and continue, or 'CTRL+C' to stop the program... ", file=file)
@@ -452,6 +431,7 @@ def whatisit(
 	flush: bool = True,
 	max_length: int = 250,
 	color: str = CYAN,
+	text: str = "What is it?",
 	**print_kwargs: Any,
 ) -> None:
 	""" Print the type of each value and the value itself, with its id and length/shape.
@@ -463,6 +443,7 @@ def whatisit(
 		print_function	(Callable):	Function to use to print the values (default: debug())
 		max_length		(int):		Maximum length of the value string to print (default: 250)
 		color			(str):		Color of the message (default: CYAN)
+		text			(str):		Text in the message (replaces "DEBUG")
 		print_kwargs	(dict):		Keyword arguments to pass to the print function
 	"""
 	def _internal(value: Any) -> str:
@@ -471,15 +452,22 @@ def whatisit(
 		# Build metadata parts list
 		metadata_parts: list[str] = []
 
-		# Get the dtype if available
-		try:
-			metadata_parts.append(f"dtype: {value.dtype}")
-		except (AttributeError, TypeError):
-			pass
+		# Get attributes if available (with priority order)
+		for attributes in [("dtype","dtypes"),("nbytes","memory_usage"),("device",)]:
+			# Find the first available attribute of the current tuple
+			for attr in attributes:
+				try:
+					attr_value = getattr(value, attr)
+					if attr_value is not None:
+						metadata_parts.append(f"{attr}: {attr_value}")
+						break
+				except (AttributeError, TypeError):
+					continue
 
 		# Get the shape or length of the value
 		try:
-			metadata_parts.append(f"shape: {value.shape}")
+			if value.shape:
+				metadata_parts.append(f"shape: {value.shape}")
 		except (AttributeError, TypeError):
 			try:
 				metadata_parts.append(f"length: {len(value)}")
@@ -511,37 +499,28 @@ def whatisit(
 		# Return the formatted string
 		return f"{type(value)}, <id {id(value)}>: {metadata_str}{value_str}"
 
-	# Add the color to the message
-	if "color" not in print_kwargs:
-		print_kwargs["color"] = color
-
-	# Set text to "What is it?" if not already set
-	if "text" not in print_kwargs:
-		print_kwargs["text"] = "What is it?"
-
 	# Print the values
 	if len(values) > 1:
-		print_function("".join(f"\n  {_internal(value)}" for value in values), flush=flush, **print_kwargs)
+		print_function("".join(f"\n  {_internal(value)}" for value in values), flush=flush, color=color, text=text, **print_kwargs)
 	elif len(values) == 1:
-		print_function(_internal(values[0]), flush=flush, **print_kwargs)
+		print_function(_internal(values[0]), flush=flush, color=color, text=text, **print_kwargs)
 
-def breakpoint(*values: Any, print_function: Callable[..., None] = warning, flush: bool = True, **print_kwargs: Any) -> None:
+def breakpoint(*values: Any, print_function: Callable[..., None] = warning, flush: bool = True, text: str = "BREAKPOINT (press Enter)", **print_kwargs: Any) -> None:
 	""" Breakpoint function, pause the program and print the values.
 
 	Args:
 		values			(Any):		Values to print
 		print_function	(Callable):	Function to use to print the values (default: warning())
+		text			(str):		Text in the message (replaces "WARNING")
 		print_kwargs	(dict):		Keyword arguments to pass to the print function
 	"""
-	if "text" not in print_kwargs:
-		print_kwargs["text"] = "BREAKPOINT (press Enter)"
 	file: TextIO = sys.stderr
 	if "file" in print_kwargs:
 		if isinstance(print_kwargs["file"], list):
 			file = cast(TextIO, print_kwargs["file"][0])
 		else:
 			file = print_kwargs["file"]
-	whatisit(*values, print_function=print_function, flush=flush, **print_kwargs)
+	whatisit(*values, print_function=print_function, flush=flush, text=text, **print_kwargs)
 	try:
 		input()
 	except (KeyboardInterrupt, EOFError):
@@ -700,24 +679,24 @@ def current_time() -> str:
 		return time.strftime("%H:%M:%S")
 
 # Convenience colored functions
-def infoc(*args: Any, **kwargs: Any) -> None:
-	return info(*args, use_colored=True, **kwargs)
-def debugc(*args: Any, **kwargs: Any) -> None:
-	return debug(*args, use_colored=True, **kwargs)
-def alt_debugc(*args: Any, **kwargs: Any) -> None:
-	return alt_debug(*args, use_colored=True, **kwargs)
-def warningc(*args: Any, **kwargs: Any) -> None:
-	return warning(*args, use_colored=True, **kwargs)
-def errorc(*args: Any, **kwargs: Any) -> None:
-	return error(*args, use_colored=True, **kwargs)
-def progressc(*args: Any, **kwargs: Any) -> None:
-	return progress(*args, use_colored=True, **kwargs)
-def suggestionc(*args: Any, **kwargs: Any) -> None:
-	return suggestion(*args, use_colored=True, **kwargs)
-def whatisitc(*args: Any, **kwargs: Any) -> None:
-	return whatisit(*args, use_colored=True, **kwargs)
-def breakpointc(*args: Any, **kwargs: Any) -> None:
-	return breakpoint(*args, use_colored=True, **kwargs)
+def infoc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return info(*args, use_colored=use_colored, **kwargs)
+def debugc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return debug(*args, use_colored=use_colored, **kwargs)
+def alt_debugc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return alt_debug(*args, use_colored=use_colored, **kwargs)
+def warningc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return warning(*args, use_colored=use_colored, **kwargs)
+def errorc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return error(*args, use_colored=use_colored, **kwargs)
+def progressc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return progress(*args, use_colored=use_colored, **kwargs)
+def suggestionc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return suggestion(*args, use_colored=use_colored, **kwargs)
+def whatisitc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return whatisit(*args, use_colored=use_colored, **kwargs)
+def breakpointc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None:
+	return breakpoint(*args, use_colored=use_colored, **kwargs)
 
 
 # Test the print functions
@@ -747,7 +726,7 @@ if __name__ == "__main__":
 	# Test whatisit with different types
 	import numpy as np
 	print()
-	whatisit(
+	whatisitc(
 		123,
 		"Hello World",
 		[1, 2, 3, 4, 5],

stouputils/print.pyi

@@ -147,27 +147,30 @@ def info(*values: Any, color: str = ..., text: str = 'INFO ', prefix: str = '',
 \t\tuse_colored\t\t(bool):\t\t\t\t\tWhether to use the colored() function to format the message
 \t\tprint_kwargs\t(dict):\t\t\t\t\tKeyword arguments to pass to the print function
 \t'''
-def debug(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def debug(*values: Any, flush: bool = True, color: str = ..., text: str = 'DEBUG', **print_kwargs: Any) -> None:
     ''' Print a debug message looking like "[DEBUG HH:MM:SS] message" in cyan by default. '''
-def alt_debug(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def alt_debug(*values: Any, flush: bool = True, color: str = ..., text: str = 'DEBUG', **print_kwargs: Any) -> None:
     ''' Print a debug message looking like "[DEBUG HH:MM:SS] message" in blue by default. '''
-def suggestion(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def suggestion(*values: Any, flush: bool = True, color: str = ..., text: str = 'SUGGESTION', **print_kwargs: Any) -> None:
     ''' Print a suggestion message looking like "[SUGGESTION HH:MM:SS] message" in cyan by default. '''
-def progress(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def progress(*values: Any, flush: bool = True, color: str = ..., text: str = 'PROGRESS', **print_kwargs: Any) -> None:
     ''' Print a progress message looking like "[PROGRESS HH:MM:SS] message" in magenta by default. '''
-def warning(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
+def warning(*values: Any, flush: bool = True, color: str = ..., text: str = 'WARNING', **print_kwargs: Any) -> None:
     ''' Print a warning message looking like "[WARNING HH:MM:SS] message" in yellow by default and in sys.stderr. '''
-def error(*values: Any, exit: bool = False, flush: bool = True, **print_kwargs: Any) -> None:
-    """ Print an error message (in sys.stderr and in red by default)
+def error(*values: Any, exit: bool = False, flush: bool = True, color: str = ..., text: str = 'ERROR', **print_kwargs: Any) -> None:
+    ''' Print an error message (in sys.stderr and in red by default)
 \tand optionally ask the user to continue or stop the program.
 
 \tArgs:
 \t\tvalues\t\t\t(Any):\t\tValues to print (like the print function)
 \t\texit\t\t\t(bool):\t\tWhether to ask the user to continue or stop the program,
 \t\t\tfalse to ignore the error automatically and continue
+\t\tflush\t\t\t(bool):\t\tWhether to flush the output
+\t\tcolor\t\t\t(str):\t\tColor of the message (default: RED)
+\t\ttext\t\t\t(str):\t\tText in the message (replaces "ERROR ")
 \t\tprint_kwargs\t(dict):\t\tKeyword arguments to pass to the print function
-\t"""
-def whatisit(*values: Any, print_function: Callable[..., None] = ..., flush: bool = True, max_length: int = 250, color: str = ..., **print_kwargs: Any) -> None:
+\t'''
+def whatisit(*values: Any, print_function: Callable[..., None] = ..., flush: bool = True, max_length: int = 250, color: str = ..., text: str = 'What is it?', **print_kwargs: Any) -> None:
     ''' Print the type of each value and the value itself, with its id and length/shape.
 
 \tThe output format is: "type, <id id_number>:\t(length/shape) value"
@@ -177,16 +180,18 @@ def whatisit(*values: Any, print_function: Callable[..., None] = ..., flush: boo
 \t\tprint_function\t(Callable):\tFunction to use to print the values (default: debug())
 \t\tmax_length\t\t(int):\t\tMaximum length of the value string to print (default: 250)
 \t\tcolor\t\t\t(str):\t\tColor of the message (default: CYAN)
+\t\ttext\t\t\t(str):\t\tText in the message (replaces "DEBUG")
 \t\tprint_kwargs\t(dict):\t\tKeyword arguments to pass to the print function
 \t'''
-def breakpoint(*values: Any, print_function: Callable[..., None] = ..., flush: bool = True, **print_kwargs: Any) -> None:
-    """ Breakpoint function, pause the program and print the values.
+def breakpoint(*values: Any, print_function: Callable[..., None] = ..., flush: bool = True, text: str = 'BREAKPOINT (press Enter)', **print_kwargs: Any) -> None:
+    ''' Breakpoint function, pause the program and print the values.
 
 \tArgs:
 \t\tvalues\t\t\t(Any):\t\tValues to print
 \t\tprint_function\t(Callable):\tFunction to use to print the values (default: warning())
+\t\ttext\t\t\t(str):\t\tText in the message (replaces "WARNING")
 \t\tprint_kwargs\t(dict):\t\tKeyword arguments to pass to the print function
-\t"""
+\t'''
 
 class TeeMultiOutput:
     ''' File-like object that duplicates output to multiple file-like objects.
@@ -235,12 +240,12 @@ def is_same_print(*args: Any, **kwargs: Any) -> bool:
     """ Checks if the current print call is the same as the previous one. """
 def current_time() -> str:
     ''' Get the current time as "HH:MM:SS" if less than 24 hours since import, else "YYYY-MM-DD HH:MM:SS" '''
-def infoc(*args: Any, **kwargs: Any) -> None: ...
-def debugc(*args: Any, **kwargs: Any) -> None: ...
-def alt_debugc(*args: Any, **kwargs: Any) -> None: ...
-def warningc(*args: Any, **kwargs: Any) -> None: ...
-def errorc(*args: Any, **kwargs: Any) -> None: ...
-def progressc(*args: Any, **kwargs: Any) -> None: ...
-def suggestionc(*args: Any, **kwargs: Any) -> None: ...
-def whatisitc(*args: Any, **kwargs: Any) -> None: ...
-def breakpointc(*args: Any, **kwargs: Any) -> None: ...
+def infoc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...
+def debugc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...
+def alt_debugc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...
+def warningc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...
+def errorc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...
+def progressc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...
+def suggestionc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...
+def whatisitc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...
+def breakpointc(*args: Any, use_colored: bool = True, **kwargs: Any) -> None: ...

{stouputils-1.19.4.dist-info → stouputils-1.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stouputils
-Version: 1.19.4
+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.4.dist-info → stouputils-1.20.0.dist-info}/RECORD

@@ -145,18 +145,18 @@ stouputils/parallel/capturer.py,sha256=s4x_o8Awe-RYyyYxTzgQSm1N2shDjFhENkJBdW-WH
 stouputils/parallel/capturer.pyi,sha256=UdhhJFdyBsBUyEAltaG3Im13GvZlNXi-ScQDXezFI1Q,2141
 stouputils/parallel/common.py,sha256=niDcAiEX3flX0ow91gXOB4umlOrR8PIYvpcKPClJHfM,4910
 stouputils/parallel/common.pyi,sha256=jbyftOYHKP2qaA8YC1f1f12-BDBkhfsQsnPdsR4oet8,2493
-stouputils/parallel/multi.py,sha256=tHJgcQJwsI6QeKEHoGJC4tsVK_6t1Fazkb06i1u-W_8,12610
-stouputils/parallel/multi.pyi,sha256=DWolZn1UoXxOfuw7LqEJcU8aQJsN-_DRhPGJlJCA5pQ,8021
-stouputils/parallel/subprocess.py,sha256=LWbwwAmnz54dCz9TAcKNg1TOMCVSP0C-0GIXaS5nVx0,6728
-stouputils/parallel/subprocess.pyi,sha256=gzRtpTslvoENLtSNk79fe3Xz8lV3IwuopT9uMHW9BTU,3680
-stouputils/print.py,sha256=86Qjyyj_riU7w3RQdYIHTlPVICUzKsfEBF6NBwZc20g,26745
-stouputils/print.pyi,sha256=qu7Pr1c6let2fLcBvbfrrcfCg0s3rf_1jD8FDhR1bgk,11188
+stouputils/parallel/multi.py,sha256=aFcv0QwwptvHhMQSGZ3oDP9WtStgUug6d7yekc-m3rw,13574
+stouputils/parallel/multi.pyi,sha256=VocXgaZGQmpMu52_wYBbU8oacXgTM2tCA88sa3xT8iM,8563
+stouputils/parallel/subprocess.py,sha256=xkQmNfhXxbAzNwgtwDrTOehniDLFPLuV5F3sXPXlU6Y,6899
+stouputils/parallel/subprocess.pyi,sha256=oANLSRmmtWUXTmzhHheZE1uV7gL1zc6Dra9K2aPy73I,3975
+stouputils/print.py,sha256=za33LhqrWgWdeg7unzHRNoXaZbpETXliEN7erfFQ8LA,27036
+stouputils/print.pyi,sha256=iR5vcbf5-3H3kAkX84TMPtwI7_bylWWAKru4n2VMTwQ,12045
 stouputils/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
 stouputils/typing.py,sha256=9sj6-_lW9pyQFmxW2K1SinGCy7IWeRouUfWjPU2qDsk,2205
 stouputils/typing.pyi,sha256=XRKhGA7jWjcE-DtS2UznevBxBIFqj8IZI8-J48_3GQc,1341
 stouputils/version_pkg.py,sha256=Jsp-s03L14DkiZ94vQgrlQmaxApfn9DC8M_nzT1SJLk,7014
 stouputils/version_pkg.pyi,sha256=QPvqp1U3QA-9C_CC1dT9Vahv1hXEhstbM7x5uzMZSsQ,755
-stouputils-1.19.4.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
-stouputils-1.19.4.dist-info/entry_points.txt,sha256=tx0z9VOnE-sfkmbFbA93zaBMzV3XSsKEJa_BWIqUzxw,57
-stouputils-1.19.4.dist-info/METADATA,sha256=UdM9eb2MdkC1t42azf7_UT8603Nafg0m7T9i6gERTko,13931
-stouputils-1.19.4.dist-info/RECORD,,
+stouputils-1.20.0.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+stouputils-1.20.0.dist-info/entry_points.txt,sha256=tx0z9VOnE-sfkmbFbA93zaBMzV3XSsKEJa_BWIqUzxw,57
+stouputils-1.20.0.dist-info/METADATA,sha256=Cfc3uFEGai_NXMr3RTPp12Cj0fBsOLAuCbdtBOKo9Wk,13959
+stouputils-1.20.0.dist-info/RECORD,,