stouputils 1.2.20__tar.gz → 1.2.22__tar.gz

{stouputils-1.2.20 → stouputils-1.2.22}/PKG-INFO

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

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.20"
+version = "1.2.22"
 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.20 → stouputils-1.2.22}/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
@@ -69,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
@@ -84,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 """
@@ -96,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
@@ -107,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.20 → stouputils-1.2.22}/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

{stouputils-1.2.20 → stouputils-1.2.22}/stouputils/print.py

@@ -226,13 +226,13 @@ def breakpoint(*values: Any, print_function: Callable[..., None] = warning, **pr
 
 # TeeMultiOutput class to duplicate output to multiple file-like objects
 class TeeMultiOutput(object):
-	""" File-like object that duplicates output to multiple file objects.
+	""" 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
-		force_tty     (bool):     Whether to force reporting as a TTY device (helps with tqdm)
 		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")
@@ -242,13 +242,27 @@ class TeeMultiOutput(object):
 		>>> sys.stdout = original_stdout
 		>>> f.close()
 	"""
-	def __init__(self, *files: IO[Any], strip_colors: bool = True, ascii_only: bool = True) -> None:
+	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 """
+
+	@property
+	def encoding(self) -> str:
+		""" Get the encoding of the first file, or "utf-8" as fallback.
+		
+		Returns:
+			str: The encoding, ex: "utf-8", "ascii", "latin1", etc.
+		"""
+		try:
+			return self.files[0].encoding	# type: ignore
+		except (IndexError, AttributeError):
+			return "utf-8"
 
 	def write(self, obj: str) -> None:
 		""" Write the object to all files while stripping colors if needed.
@@ -263,6 +277,10 @@ class TeeMultiOutput(object):
 					# 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)
@@ -282,11 +300,10 @@ class TeeMultiOutput(object):
 	def flush(self) -> None:
 		""" Flush all files. """
 		for f in self.files:
-			if hasattr(f, 'flush'):
-				try:
-					f.flush()
-				except Exception:
-					pass
+			try:
+				f.flush()
+			except Exception:
+				pass
 
 	def fileno(self) -> int:
 		""" Return the file descriptor of the first file. """