stouputils 1.2.19__tar.gz → 1.2.21__tar.gz

{stouputils-1.2.19 → stouputils-1.2.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.2.19
+Version: 1.2.21
 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.19 → stouputils-1.2.21}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.19"
+version = "1.2.21"
 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.19 → stouputils-1.2.21}/stouputils/ctx.py

@@ -2,7 +2,7 @@
 This module provides context managers for temporarily silencing output.
 
 - Muffle: Context manager that temporarily silences output (alternative to stouputils.decorators.silent())
-- LogToFile: Context manager to log to a file every calls to the print functions in stouputils.print
+- LogToFile: Context manager to log to a file every print call (with LINE_UP handling)
 
 .. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/ctx_module.gif
   :alt: stouputils ctx examples
@@ -12,7 +12,7 @@ This module provides context managers for temporarily silencing output.
 import os
 import sys
 from typing import IO, TextIO, Callable, Any
-from .print import remove_colors
+from .print import TeeMultiOutput
 from .io import super_open
 
 
@@ -55,53 +55,6 @@ class Muffle:
 			sys.stderr = self.original_stderr
 
 
-# TeeMultiOutput class to duplicate output to multiple file-like objects
-class TeeMultiOutput(object):
-	""" File-like object that duplicates output to multiple file objects.
-
-	Args:
-		*files        (IO[Any]):  One or more file-like objects that have write and flush methods
-		strip_colors  (bool):     Whether to strip ANSI color codes from output sent to non-stdout/stderr files
-
-	Examples:
-		>>> f = open("logfile.txt", "w")
-		>>> original_stdout = sys.stdout
-		>>> sys.stdout = TeeMultiOutput(sys.stdout, f)
-		>>> print("Hello World")  # Output goes to both console and file
-		>>> sys.stdout = original_stdout
-		>>> f.close()
-	"""
-	def __init__(self, *files: IO[Any], strip_colors: bool = True) -> None:
-		self.files: tuple[IO[Any], ...] = files
-		""" File-like objects to write to """
-		self.strip_colors: bool = strip_colors
-		""" Whether to strip ANSI color codes from output sent to non-stdout/stderr files """
-
-	def write(self, obj: str) -> None:
-		""" Write the object to all files while stripping colors if needed.
-
-		Args:
-			obj (str): String to write
-		"""
-		for i, f in enumerate(self.files):
-			if self.strip_colors and i != 0:
-				f.write(remove_colors(obj))
-			else:
-				f.write(obj)
-
-	def flush(self) -> None:
-		""" Flush all files. """
-		for f in self.files:
-			f.flush()
-
-	# Add other methods that might be expected from a file-like object
-	def isatty(self) -> bool:
-		""" Return whether the first file is connected to a tty-like device. """
-		return hasattr(self.files[0], 'isatty') and self.files[0].isatty()
-
-	def fileno(self) -> int:
-		""" Return the file descriptor of the first file. """
-		return self.files[0].fileno()
 
 # Context manager to log to a file
 class LogToFile:
@@ -116,6 +69,7 @@ class LogToFile:
 		encoding (str): Encoding to use for the file (default: "utf-8")
 		tee_stdout (bool): Whether to redirect stdout to the file (default: True)
 		tee_stderr (bool): Whether to redirect stderr to the file (default: True)
+		ignore_lineup (bool): Whether to ignore lines containing LINE_UP escape sequence in files (default: False)
 
 	Examples:
 		.. code-block:: python
@@ -131,7 +85,8 @@ class LogToFile:
 		mode: str = "w",
 		encoding: str = "utf-8",
 		tee_stdout: bool = True,
-		tee_stderr: bool = True
+		tee_stderr: bool = True,
+		ignore_lineup: bool = True
 	) -> None:
 		self.path: str = path
 		""" Attribute remembering path to the log file """
@@ -143,6 +98,8 @@ class LogToFile:
 		""" Whether to redirect stdout to the file """
 		self.tee_stderr: bool = tee_stderr
 		""" Whether to redirect stderr to the file """
+		self.ignore_lineup: bool = ignore_lineup
+		""" Whether to ignore lines containing LINE_UP escape sequence in files """
 		self.file: IO[Any] = super_open(self.path, mode=self.mode, encoding=self.encoding)
 		""" Attribute remembering opened file """
 		self.original_stdout: TextIO = sys.stdout
@@ -154,10 +111,10 @@ class LogToFile:
 		""" Enter context manager which opens the log file and redirects stdout/stderr """
 		# Redirect stdout and stderr if requested
 		if self.tee_stdout:
-			sys.stdout = TeeMultiOutput(self.original_stdout, self.file)
+			sys.stdout = TeeMultiOutput(self.original_stdout, self.file, ignore_lineup=self.ignore_lineup)
 
 		if self.tee_stderr:
-			sys.stderr = TeeMultiOutput(self.original_stderr, self.file)
+			sys.stderr = TeeMultiOutput(self.original_stderr, self.file, ignore_lineup=self.ignore_lineup)
 
 	def __exit__(self, exc_type: type[BaseException]|None, exc_val: BaseException|None, exc_tb: Any|None) -> None:
 		""" Exit context manager which closes the log file and restores stdout/stderr """

{stouputils-1.2.19 → stouputils-1.2.21}/stouputils/parallel.py

@@ -15,7 +15,7 @@ from .print import MAGENTA, RESET
 from .decorators import handle_error, LogLevels
 from multiprocessing import Pool, cpu_count
 from typing import Callable, TypeVar
-from tqdm import tqdm
+from tqdm.auto import tqdm
 from tqdm.contrib.concurrent import process_map # type: ignore
 from concurrent.futures import ThreadPoolExecutor
 import time
@@ -123,7 +123,7 @@ def multiprocessing(func: Callable[[T], R], args: list[T], use_starmap: bool = F
 	# Do multiprocessing only if there is more than 1 argument and more than 1 CPU
 	if max_workers > 1 and len(args) > 1:
 		if verbose > 0:
-			return list(process_map(func, args, max_workers=max_workers, chunksize=chunksize, desc=desc, bar_format=BAR_FORMAT)) # type: ignore
+			return list(process_map(func, args, max_workers=max_workers, chunksize=chunksize, desc=desc, bar_format=BAR_FORMAT, ascii=False)) # type: ignore
 		else:
 			with Pool(max_workers) as pool:
 				return list(pool.map(func, args, chunksize=chunksize))	# type: ignore
@@ -131,7 +131,7 @@ def multiprocessing(func: Callable[[T], R], args: list[T], use_starmap: bool = F
 	# Single process execution
 	else:
 		if verbose > 0:
-			return [func(arg) for arg in tqdm(args, total=len(args), desc=desc, bar_format=BAR_FORMAT)]
+			return [func(arg) for arg in tqdm(args, total=len(args), desc=desc, bar_format=BAR_FORMAT, ascii=False)]
 		else:
 			return [func(arg) for arg in args]
 
@@ -176,7 +176,7 @@ def multithreading(func: Callable[[T], R], args: list[T], use_starmap: bool = Fa
 	if max_workers > 1 and len(args) > 1:
 		if verbose > 0:
 			with ThreadPoolExecutor(max_workers) as executor:
-				return list(tqdm(executor.map(func, args), total=len(args), desc=desc, bar_format=BAR_FORMAT))
+				return list(tqdm(executor.map(func, args), total=len(args), desc=desc, bar_format=BAR_FORMAT, ascii=False))
 		else:
 			with ThreadPoolExecutor(max_workers) as executor:
 				return list(executor.map(func, args))
@@ -184,7 +184,7 @@ def multithreading(func: Callable[[T], R], args: list[T], use_starmap: bool = Fa
 	# Single process execution
 	else:
 		if verbose > 0:
-			return [func(arg) for arg in tqdm(args, total=len(args), desc=desc, bar_format=BAR_FORMAT)]
+			return [func(arg) for arg in tqdm(args, total=len(args), desc=desc, bar_format=BAR_FORMAT, ascii=False)]
 		else:
 			return [func(arg) for arg in args]
 

{stouputils-1.2.19 → stouputils-1.2.21}/stouputils/print.py

@@ -10,7 +10,7 @@ If a message is printed multiple times, it will be displayed as "(xN) message" w
 # Imports
 import sys
 import time
-from typing import Callable, TextIO, Any
+from typing import Callable, IO, TextIO, Any
 
 # Colors constants
 RESET: str   = "\033[0m"
@@ -224,7 +224,79 @@ def breakpoint(*values: Any, print_function: Callable[..., None] = warning, **pr
 		sys.exit(1)
 
 
+# TeeMultiOutput class to duplicate output to multiple file-like objects
+class TeeMultiOutput(object):
+	""" File-like object that duplicates output to multiple file-like objects.
 
+	Args:
+		*files        (IO[Any]):  One or more file-like objects that have write and flush methods
+		strip_colors  (bool):     Whether to strip ANSI color codes from output sent to non-stdout/stderr files
+		ascii_only    (bool):     Whether to replace non-ASCII characters with their ASCII equivalents for non-stdout/stderr files
+		ignore_lineup (bool):     Whether to ignore lines containing LINE_UP escape sequence in non-terminal outputs
+
+	Examples:
+		>>> f = open("logfile.txt", "w")
+		>>> original_stdout = sys.stdout
+		>>> sys.stdout = TeeMultiOutput(sys.stdout, f)
+		>>> print("Hello World")  # Output goes to both console and file
+		>>> sys.stdout = original_stdout
+		>>> f.close()
+	"""
+	def __init__(self, *files: IO[Any], strip_colors: bool = True, ascii_only: bool = True, ignore_lineup: bool = True) -> None:
+		self.files: tuple[IO[Any], ...] = files
+		""" File-like objects to write to """
+		self.strip_colors: bool = strip_colors
+		""" Whether to strip ANSI color codes from output sent to non-stdout/stderr files """
+		self.ascii_only: bool = ascii_only
+		""" Whether to replace non-ASCII characters with their ASCII equivalents for non-stdout/stderr files """
+		self.ignore_lineup: bool = ignore_lineup
+		""" Whether to ignore lines containing LINE_UP escape sequence in non-terminal outputs """
+
+	def write(self, obj: str) -> None:
+		""" Write the object to all files while stripping colors if needed.
+
+		Args:
+			obj (str): String to write
+		"""
+		for i, f in enumerate(self.files):
+			try:
+				content = obj
+				if i != 0:
+					# First file (i = 0) (often stdout/stderr) gets the original content
+					# Other files (i != 0) get processed content
+
+					# Skip content if it contains LINE_UP and ignore_lineup is True
+					if self.ignore_lineup and (LINE_UP in content or "\r" in content):
+						continue
+
+					# Strip colors if needed
+					if self.strip_colors:
+						content = remove_colors(content)
+
+					# Replace Unicode block characters with ASCII equivalents
+					# Replace other problematic Unicode characters as needed
+					if self.ascii_only:
+						content = content.replace('█', '#')
+						content = ''.join(c if ord(c) < 128 else '?' for c in content)
+
+				# Write content to file
+				f.write(content)
+
+			except Exception:
+				pass
+
+	def flush(self) -> None:
+		""" Flush all files. """
+		for f in self.files:
+			if hasattr(f, 'flush'):
+				try:
+					f.flush()
+				except Exception:
+					pass
+
+	def fileno(self) -> int:
+		""" Return the file descriptor of the first file. """
+		return self.files[0].fileno() if hasattr(self.files[0], "fileno") else 0