stouputils 1.2.1__tar.gz → 1.2.3__tar.gz

{stouputils-1.2.1 → stouputils-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.2.1
+Version: 1.2.3
 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.
 Project-URL: Homepage, https://github.com/Stoupy51/stouputils
 Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues

{stouputils-1.2.1 → stouputils-1.2.3}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.1"
+version = "1.2.3"
 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"
 requires-python = ">=3.10"

{stouputils-1.2.1 → stouputils-1.2.3}/stouputils/io.py

@@ -16,7 +16,6 @@ This module provides utilities for file management.
 import shutil
 import json
 import os
-import io
 from typing import IO, Any
 
 # Function that replace the "~" by the user's home directory
@@ -173,13 +172,13 @@ def super_json_load(file_path: str) -> Any:
 
 
 # JSON dump with indentation for levels
-def super_json_dump(data: Any, file: io.TextIOWrapper|None = None, max_level: int = 2, indent: str = '\t') -> str:
+def super_json_dump(data: Any, file: IO[Any]|None = None, max_level: int = 2, indent: str = '\t') -> str:
 	""" Writes the provided data to a JSON file with a specified indentation depth.
 	For instance, setting max_level to 2 will limit the indentation to 2 levels.
 
 	Args:
 		data (Any): 				The data to dump (usually a dict or a list)
-		file (io.TextIOWrapper): 	The file to dump the data to, if None, the data is returned as a string
+		file (IO[Any]): 			The file to dump the data to, if None, the data is returned as a string
 		max_level (int):			The depth of indentation to stop at (-1 for infinite)
 		indent (str):				The indentation character (default: '\t')
 	Returns:

{stouputils-1.2.1 → stouputils-1.2.3}/stouputils/print.py

@@ -83,15 +83,23 @@ def info(*values: Any, color: str = GREEN, text: str = "INFO ", prefix: str = ""
 				print(remove_colors(message), *(remove_colors(str(v)) for v in values), file=log_file, **print_kwargs)
 
 def debug(*values: Any, **print_kwargs: Any) -> None:
-	""" Print a debug message looking like "[DEBUG HH:MM:SS] message" """
+	""" 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)
 
+def alt_debug(*values: Any, **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)
+
 def suggestion(*values: Any, **print_kwargs: Any) -> None:
-	""" Print a suggestion message looking like "[SUGGESTION HH:MM:SS] message" """
+	""" 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:
@@ -99,7 +107,7 @@ def suggestion(*values: Any, **print_kwargs: Any) -> None:
 	info(*values, **print_kwargs)
 
 def progress(*values: Any, **print_kwargs: Any) -> None:
-	""" Print a progress message looking like "[PROGRESS HH:MM:SS] message" """
+	""" 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:
@@ -107,7 +115,7 @@ def progress(*values: Any, **print_kwargs: Any) -> None:
 	info(*values, **print_kwargs)
 
 def warning(*values: Any, **print_kwargs: Any) -> None:
-	""" Print a warning message looking like "[WARNING HH:MM:SS] message" in sys.stderr """
+	""" 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:
@@ -117,7 +125,7 @@ def warning(*values: Any, **print_kwargs: Any) -> None:
 	info(*values, **print_kwargs)
 
 def error(*values: Any, exit: bool = True, **print_kwargs: Any) -> None:
-	""" Print an error message (in sys.stderr) and optionally ask the user to continue or stop the program
+	""" Print an error message (in sys.stderr and in red by default) and optionally ask the user to continue or stop the program.
 
 	Args:
 		values			(Any):		Values to print (like the print function)
@@ -144,7 +152,7 @@ def error(*values: Any, exit: bool = True, **print_kwargs: Any) -> None:
 			print(file=file)
 			sys.exit(1)
 
-def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_length: int = 250, **print_kwargs: Any) -> None:
+def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_length: int = 250, color: str = CYAN, **print_kwargs: Any) -> None:
 	""" Print the type of each value and the value itself, with its id and length/shape.
 
 	The output format is: "type, <id id_number>:	(length/shape) value"
@@ -153,10 +161,13 @@ def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_leng
 		values			(Any):		Values to print
 		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)
 		print_kwargs	(dict):		Keyword arguments to pass to the print function
 	"""
 	def _internal(value: Any) -> str:
 		""" Get the string representation of the value, with length or shape instead of length if shape is available """
+
+		# Get the length or shape of the value
 		length: str = ""
 		try:
 			length = f"(length: {len(value)}) "
@@ -166,14 +177,22 @@ def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_leng
 			length = f"(shape: {value.shape}) "
 		except (AttributeError, TypeError):
 			pass
+
+		# Get the string representation of the value
 		value_str: str = str(value)
 		if len(value_str) > max_length:
 			value_str = value_str[:max_length] + "..."
 		if "\n" in value_str:
-			length = "\n" + length	# Add a newline before the length if there is a newline in the value.
+			value_str = "\n" + value_str	# Add a newline before the value if there is a newline in it.
+
+		# Return the formatted string
 		return f"{type(value)}, <id {id(value)}>: {length}{value_str}"
 
-	# Print
+	# Add the color to the message
+	if "color" not in print_kwargs:
+		print_kwargs["color"] = color
+
+	# Print the values
 	if len(values) > 1:
 		print_function("(What is it?)", **print_kwargs)
 		for value in values: