stouputils 1.18.2__tar.gz → 1.18.4__tar.gz

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

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

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

@@ -76,7 +76,7 @@ def measure_time(
 			def wrapper(*args: tuple[Any, ...], **kwargs: dict[str, Any]) -> Any:
 				with MeasureTime(print_func=printer, message=new_msg, perf_counter=perf_counter):
 					return func(*args, **kwargs)
-		wrapper.__name__ = _get_wrapper_name("stouputils.decorators.measure_time", func)
+		_set_wrapper_name(wrapper, _get_wrapper_name("stouputils.decorators.measure_time", func))
 		return wrapper
 
 	# Handle both @measure_time and @measure_time(printer=..., message=..., perf_counter=..., is_generator=...)
@@ -160,7 +160,7 @@ def handle_error(
 				# Sleep for the specified time, only if the error_log is not ERROR_TRACEBACK (because it's blocking)
 				if sleep_time > 0.0 and error_log != LogLevels.ERROR_TRACEBACK:
 					time.sleep(sleep_time)
-		wrapper.__name__ = _get_wrapper_name("stouputils.decorators.handle_error", func)
+		_set_wrapper_name(wrapper, _get_wrapper_name("stouputils.decorators.handle_error", func))
 		return wrapper
 
 	# Handle both @handle_error and @handle_error(exceptions=..., message=..., error_log=...)
@@ -277,7 +277,7 @@ def timeout(
 			if result_container:
 				return result_container[0]
 
-		wrapper.__name__ = _get_wrapper_name("stouputils.decorators.timeout", func)
+		_set_wrapper_name(wrapper, _get_wrapper_name("stouputils.decorators.timeout", func))
 		return wrapper
 
 	# Handle both @timeout and @timeout(seconds=..., message=...)
@@ -352,7 +352,7 @@ def retry(
 					time.sleep(current_delay)
 					current_delay *= backoff
 
-		wrapper.__name__ = _get_wrapper_name("stouputils.decorators.retry", func)
+		_set_wrapper_name(wrapper, _get_wrapper_name("stouputils.decorators.retry", func))
 		return wrapper
 
 	# Handle both @retry and @retry(exceptions=..., max_attempts=..., delay=...)
@@ -427,7 +427,7 @@ def simple_cache(
 				return result
 
 		# Return the wrapper
-		wrapper.__name__ = _get_wrapper_name("stouputils.decorators.simple_cache", func)
+		_set_wrapper_name(wrapper, _get_wrapper_name("stouputils.decorators.simple_cache", func))
 		return wrapper
 
 	# Handle both @simple_cache and @simple_cache(method=...)
@@ -477,10 +477,10 @@ def abstract(
 
 		@wraps(func)
 		@handle_error(exceptions=NotImplementedError, error_log=error_log)
-		def wrapper(*args: tuple[Any, ...], **kwargs: dict[str, Any]) -> Any:
+		def not_implemented_error(*args: tuple[Any, ...], **kwargs: dict[str, Any]) -> Any:
 			raise NotImplementedError(message)
-		wrapper.__name__ = _get_wrapper_name("stouputils.decorators.abstract", func)
-		return wrapper
+		_set_wrapper_name(not_implemented_error, _get_wrapper_name("stouputils.decorators.abstract", func))
+		return not_implemented_error
 
 	# Handle both @abstract and @abstract(error_log=...)
 	if func is None:
@@ -541,7 +541,7 @@ def deprecated(
 
 			# Call the original function
 			return func(*args, **kwargs)
-		wrapper.__name__ = _get_wrapper_name("stouputils.decorators.deprecated", func)
+		_set_wrapper_name(wrapper, _get_wrapper_name("stouputils.decorators.deprecated", func))
 		return wrapper
 
 	# Handle both @deprecated and @deprecated(message=..., error_log=...)
@@ -582,7 +582,7 @@ def silent(
 			# Use Muffle context manager to silence output
 			with Muffle(mute_stderr=mute_stderr):
 				return func(*args, **kwargs)
-		wrapper.__name__ = _get_wrapper_name("stouputils.decorators.silent", func)
+		_set_wrapper_name(wrapper, _get_wrapper_name("stouputils.decorators.silent", func))
 		return wrapper
 
 	# Handle both @silent and @silent(mute_stderr=...)
@@ -613,7 +613,31 @@ def _get_wrapper_name(decorator_name: str, func: Callable[..., Any]) -> str:
 
 	# Remove "stouputils.decorators.*" prefix if present
 	if func_name.startswith("stouputils.decorators."):
-		func_name = ".".join(func_name.split(".")[3:])
+		func_name = func_name.split(".", 2)[-1]
 
 	return f"{decorator_name}@{func_name}"
 
+
+def _set_wrapper_name(wrapper: Callable[..., Any], name: str) -> None:
+	""" Set the wrapper function's visible name, qualname and code object name for clearer tracebacks.
+
+	Args:
+		wrapper	(Callable[..., Any]):	Wrapper function to update
+		name	(str):					New name to set
+	"""
+	# __name__ affects repr and some introspection
+	wrapper.__name__ = name
+
+	# __qualname__ helps when using nested scopes and in some introspection tools
+	try:
+		wrapper.__qualname__ = name
+	except Exception:
+		pass
+
+	# Update the code object's co_name so tracebacks show the new name
+	try:
+		wrapper.__code__ = wrapper.__code__.replace(co_name=name)
+	except Exception:
+		# If code.replace isn't available, ignore silently
+		pass
+

{stouputils-1.18.2 → stouputils-1.18.4}/stouputils/decorators.pyi

@@ -250,3 +250,10 @@ def _get_wrapper_name(decorator_name: str, func: Callable[..., Any]) -> str:
 \tReturns:
 \t\tstr: Combined name for the wrapper function (e.g., "stouputils.decorators.handle_error@function_name")
 \t'''
+def _set_wrapper_name(wrapper: Callable[..., Any], name: str) -> None:
+    """ Set the wrapper function's visible name, qualname and code object name for clearer tracebacks.
+
+\tArgs:
+\t\twrapper\t(Callable[..., Any]):\tWrapper function to update
+\t\tname\t(str):\t\t\t\t\tNew name to set
+\t"""

{stouputils-1.18.2 → stouputils-1.18.4}/stouputils/print.py

@@ -328,39 +328,39 @@ def info(
 		else:
 			print(message, *values, RESET, file=file, **print_kwargs)
 
-def debug(*values: Any, **print_kwargs: Any) -> None:
+def debug(*values: Any, flush: bool = True, **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, **print_kwargs)
+	info(*values, flush=flush, **print_kwargs)
 
-def alt_debug(*values: Any, **print_kwargs: Any) -> None:
+def alt_debug(*values: Any, flush: bool = True, **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, **print_kwargs)
+	info(*values, flush=flush, **print_kwargs)
 
-def suggestion(*values: Any, **print_kwargs: Any) -> None:
+def suggestion(*values: Any, flush: bool = True, **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, **print_kwargs)
+	info(*values, flush=flush, **print_kwargs)
 
-def progress(*values: Any, **print_kwargs: Any) -> None:
+def progress(*values: Any, flush: bool = True, **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, **print_kwargs)
+	info(*values, flush=flush, **print_kwargs)
 
-def warning(*values: Any, **print_kwargs: Any) -> None:
+def warning(*values: Any, flush: bool = True, **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
@@ -368,9 +368,9 @@ def warning(*values: Any, **print_kwargs: Any) -> None:
 		print_kwargs["text"] = "WARNING"
 	if "color" not in print_kwargs:
 		print_kwargs["color"] = YELLOW
-	info(*values, **print_kwargs)
+	info(*values, flush=flush, **print_kwargs)
 
-def error(*values: Any, exit: bool = False, **print_kwargs: Any) -> None:
+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)
 	and optionally ask the user to continue or stop the program.
 
@@ -390,7 +390,7 @@ def error(*values: Any, exit: bool = False, **print_kwargs: Any) -> None:
 		print_kwargs["text"] = "ERROR"
 	if "color" not in print_kwargs:
 		print_kwargs["color"] = RED
-	info(*values, **print_kwargs)
+	info(*values, flush=flush, **print_kwargs)
 	if exit:
 		try:
 			print("Press enter to ignore error and continue, or 'CTRL+C' to stop the program... ", file=file)
@@ -402,6 +402,7 @@ def error(*values: Any, exit: bool = False, **print_kwargs: Any) -> None:
 def whatisit(
 	*values: Any,
 	print_function: Callable[..., None] = debug,
+	flush: bool = True,
 	max_length: int = 250,
 	color: str = CYAN,
 	**print_kwargs: Any,
@@ -473,11 +474,11 @@ def whatisit(
 
 	# Print the values
 	if len(values) > 1:
-		print_function("".join(f"\n  {_internal(value)}" for value in values), **print_kwargs)
+		print_function("".join(f"\n  {_internal(value)}" for value in values), flush=flush, **print_kwargs)
 	elif len(values) == 1:
-		print_function(_internal(values[0]), **print_kwargs)
+		print_function(_internal(values[0]), flush=flush, **print_kwargs)
 
-def breakpoint(*values: Any, print_function: Callable[..., None] = warning, **print_kwargs: Any) -> None:
+def breakpoint(*values: Any, print_function: Callable[..., None] = warning, flush: bool = True, **print_kwargs: Any) -> None:
 	""" Breakpoint function, pause the program and print the values.
 
 	Args:
@@ -493,7 +494,7 @@ def breakpoint(*values: Any, print_function: Callable[..., None] = warning, **pr
 			file = cast(TextIO, print_kwargs["file"][0])
 		else:
 			file = print_kwargs["file"]
-	whatisit(*values, print_function=print_function, **print_kwargs)
+	whatisit(*values, print_function=print_function, flush=flush, **print_kwargs)
 	try:
 		input()
 	except (KeyboardInterrupt, EOFError):

{stouputils-1.18.2 → stouputils-1.18.4}/stouputils/print.pyi

@@ -125,17 +125,17 @@ 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, **print_kwargs: Any) -> None:
+def debug(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
     ''' Print a debug message looking like "[DEBUG HH:MM:SS] message" in cyan by default. '''
-def alt_debug(*values: Any, **print_kwargs: Any) -> None:
+def alt_debug(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
     ''' Print a debug message looking like "[DEBUG HH:MM:SS] message" in blue by default. '''
-def suggestion(*values: Any, **print_kwargs: Any) -> None:
+def suggestion(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
     ''' Print a suggestion message looking like "[SUGGESTION HH:MM:SS] message" in cyan by default. '''
-def progress(*values: Any, **print_kwargs: Any) -> None:
+def progress(*values: Any, flush: bool = True, **print_kwargs: Any) -> None:
     ''' Print a progress message looking like "[PROGRESS HH:MM:SS] message" in magenta by default. '''
-def warning(*values: Any, **print_kwargs: Any) -> None:
+def warning(*values: Any, flush: bool = True, **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, **print_kwargs: Any) -> None:
+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)
 \tand optionally ask the user to continue or stop the program.
 
@@ -145,7 +145,7 @@ def error(*values: Any, exit: bool = False, **print_kwargs: Any) -> None:
 \t\t\tfalse to ignore the error automatically and continue
 \t\tprint_kwargs\t(dict):\t\tKeyword arguments to pass to the print function
 \t"""
-def whatisit(*values: Any, print_function: Callable[..., None] = ..., max_length: int = 250, color: str = ..., **print_kwargs: Any) -> None:
+def whatisit(*values: Any, print_function: Callable[..., None] = ..., flush: bool = True, max_length: int = 250, color: str = ..., **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"
@@ -157,7 +157,7 @@ def whatisit(*values: Any, print_function: Callable[..., None] = ..., max_length
 \t\tcolor\t\t\t(str):\t\tColor of the message (default: CYAN)
 \t\tprint_kwargs\t(dict):\t\tKeyword arguments to pass to the print function
 \t'''
-def breakpoint(*values: Any, print_function: Callable[..., None] = ..., **print_kwargs: Any) -> None:
+def breakpoint(*values: Any, print_function: Callable[..., None] = ..., flush: bool = True, **print_kwargs: Any) -> None:
     """ Breakpoint function, pause the program and print the values.
 
 \tArgs: