stouputils 1.4.0__tar.gz → 1.4.1__tar.gz

{stouputils-1.4.0 → stouputils-1.4.1}/.gitignore

@@ -7,6 +7,7 @@ uv.lock
 __temporary__/
 output.log
 logfile.txt
+.vscode
 
 # Documentation
 docs/source/_static/

{stouputils-1.4.0 → stouputils-1.4.1}/PKG-INFO

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

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.4.0"
+version = "1.4.1"
 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"
@@ -23,6 +23,9 @@ email = "stoupy51@gmail.com"
 Homepage = "https://github.com/Stoupy51/stouputils"
 Issues = "https://github.com/Stoupy51/stouputils/issues"
 
+[project.scripts]
+stouputils = "stouputils.__main__:main"
+
 [tool.pyright]
 typeCheckingMode = "strict"
 

{stouputils-1.4.0 → stouputils-1.4.1}/stouputils/__init__.py

@@ -16,6 +16,9 @@ Key Features:
 """
 # ruff: noqa: F403
 
+# Version (handle case where the package is not installed)
+from importlib.metadata import PackageNotFoundError, version
+
 # Imports
 from .all_doctests import *
 from .archive import *
@@ -31,11 +34,8 @@ from .io import *
 from .parallel import *
 from .print import *
 
-# Version (handle case where the package is not installed)
-import importlib.metadata
-
 try:
-	__version__: str = importlib.metadata.version("stouputils")
-except importlib.metadata.PackageNotFoundError:
+	__version__: str = version("stouputils")
+except PackageNotFoundError:
 	__version__: str = "0.0.0-dev"
 

stouputils-1.4.1/stouputils/__main__.py

@@ -0,0 +1,35 @@
+
+
+# Imports
+import sys
+
+from .all_doctests import launch_tests
+from .decorators import handle_error
+from .print import show_version
+
+
+@handle_error(message="Error while running 'stouputils'")
+def main():
+	second_arg: str = sys.argv[1].lower() if len(sys.argv) >= 2 else ""
+	if not second_arg:
+		# TODO
+		return
+
+	# Print the version of stouputils and its dependencies
+	if second_arg in ("--version","-v"):
+		return show_version()
+
+	# Handle "all_doctests" command
+	if second_arg == "all_doctests":
+		if launch_tests("." if len(sys.argv) == 2 else sys.argv[2]) > 0:
+			sys.exit(1)
+		return
+
+	# Check if the command is any package name
+	if second_arg in (): # type: ignore
+		return
+
+
+if __name__ == "__main__":
+	main()
+

{stouputils-1.4.0 → stouputils-1.4.1}/stouputils/all_doctests.py

@@ -1,6 +1,9 @@
 """
 This module is used to run all the doctests for all the modules in a given directory.
 
+- launch_tests: Main function to launch tests for all modules in the given directory.
+- test_module_with_progress: Test a module with testmod and measure the time taken with progress printing.
+
 .. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/all_doctests_module.gif
   :alt: stouputils all_doctests examples
 """
@@ -14,24 +17,17 @@ from doctest import TestResults, testmod
 from types import ModuleType
 
 from . import decorators
-from .decorators import LogLevels, measure_time
-from .print import error, info, progress, warning
+from .decorators import measure_time
 from .io import clean_path, relative_path
+from .print import error, info, progress, warning
 
 
-def test_module_with_progress(module: ModuleType, separator: str) -> TestResults:
-	@measure_time(progress, message=f"Testing module '{module.__name__}' {separator}took")
-	def internal() -> TestResults:
-		return testmod(m=module)
-	return internal()
-
 # Main program
-def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_TRACEBACK, strict: bool = True) -> int:
+def launch_tests(root_dir: str, strict: bool = True) -> int:
 	""" Main function to launch tests for all modules in the given directory.
 
 	Args:
 		root_dir				(str):			Root directory to search for modules
-		importing_errors		(LogLevels):	Log level for the errors when importing modules
 		strict					(bool):			Modify the force_raise_exception variable to True in the decorators module
 
 	Returns:
@@ -61,7 +57,7 @@ def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_
 		old_value: bool = strict
 		decorators.force_raise_exception = True
 		strict = old_value
-	
+
 	# Get the path of the directory to check modules from
 	working_dir: str = clean_path(os.getcwd())
 	root_dir = clean_path(os.path.abspath(root_dir))
@@ -108,7 +104,7 @@ def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_
 		def internal(a: str = module_path, b: str = separator) -> None:
 			modules.append(importlib.import_module(a))
 			separators.append(b)
-		
+
 		try:
 			internal()
 		except Exception as e:
@@ -135,3 +131,18 @@ def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_
 	# Return the number of failed tests
 	return nb_failed_tests
 
+
+def test_module_with_progress(module: ModuleType, separator: str) -> TestResults:
+	""" Test a module with testmod and measure the time taken with progress printing.
+
+	Args:
+		module		(ModuleType):	Module to test
+		separator	(str):			Separator string for alignment in output
+	Returns:
+		TestResults: The results of the tests
+	"""
+	@measure_time(progress, message=f"Testing module '{module.__name__}' {separator}took")
+	def internal() -> TestResults:
+		return testmod(m=module)
+	return internal()
+

{stouputils-1.4.0 → stouputils-1.4.1}/stouputils/applications/upscaler/image.py

@@ -36,8 +36,8 @@ from PIL import Image
 
 from ...installer import check_executable
 from ...io import clean_path
-from ...parallel import colored_for_loop, multithreading
-from ...print import debug, info
+from ...parallel import multithreading
+from ...print import colored_for_loop, debug, info
 from .config import WAIFU2X_NCNN_VULKAN_RELEASES, Config
 
 

{stouputils-1.4.0 → stouputils-1.4.1}/stouputils/applications/upscaler/video.py

@@ -46,8 +46,8 @@ from PIL import Image
 
 from ...installer import check_executable
 from ...io import clean_path
-from ...parallel import colored_for_loop, multithreading
-from ...print import debug, error, info, warning
+from ...parallel import multithreading
+from ...print import colored_for_loop, debug, error, info, warning
 from .config import FFMPEG_RELEASES, YOUTUBE_BITRATE_RECOMMENDATIONS, Config
 from .image import convert_frame, get_all_files, upscale_folder
 

{stouputils-1.4.0 → stouputils-1.4.1}/stouputils/archive.py

@@ -1,8 +1,9 @@
 """
 This module provides functions for creating and managing archives.
 
-- make_archive: Create a zip archive from a source directory with consistent file timestamps.
 - repair_zip_file: Try to repair a corrupted zip file by ignoring some of the errors
+- make_archive: Create a zip archive from a source directory with consistent file timestamps.
+- archive_cli: Main entry point for command line usage
 
 .. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/archive_module.gif
   :alt: stouputils archive examples
@@ -16,107 +17,7 @@ from zipfile import ZIP_DEFLATED, ZipFile, ZipInfo
 
 from .decorators import LogLevels, handle_error
 from .io import clean_path, super_copy
-
-
-# Function that makes an archive with consistency (same zip file each time)
-@handle_error()
-def make_archive(
-	source: str,
-	destinations: list[str] | str | None = None,
-	override_time: None | tuple[int, int, int, int, int, int] = None,
-	create_dir: bool = False,
-	ignore_patterns: str | None = None,
-) -> bool:
-	""" Create a zip archive from a source directory with consistent file timestamps.
-	(Meaning deterministic zip file each time)
-
-	Creates a zip archive from the source directory and copies it to one or more destinations.
-	The archive will have consistent file timestamps across runs if override_time is specified.
-	Uses maximum compression level (9) with ZIP_DEFLATED algorithm.
-
-	Args:
-		source				(str):						The source folder to archive
-		destinations		(list[str]|str):			The destination folder(s) or file(s) to copy the archive to
-		override_time		(None | tuple[int, ...]):	The constant time to use for the archive
-			(e.g. (2024, 1, 1, 0, 0, 0) for 2024-01-01 00:00:00)
-		create_dir			(bool):						Whether to create the destination directory if it doesn't exist
-		ignore_patterns		(str | None):				Glob pattern(s) to ignore files. Can be a single pattern or comma-separated patterns (e.g. "*.pyc" or "*.pyc,__pycache__,*.log")
-	Returns:
-		bool: Always returns True unless any strong error
-	Examples:
-
-	.. code-block:: python
-
-		> make_archive("/path/to/source", "/path/to/destination.zip")
-		> make_archive("/path/to/source", ["/path/to/destination.zip", "/path/to/destination2.zip"])
-		> make_archive("src", "hello_from_year_2085.zip", override_time=(2085,1,1,0,0,0))
-		> make_archive("src", "output.zip", ignore_patterns="*.pyc")
-		> make_archive("src", "output.zip", ignore_patterns="__pycache__")
-		> make_archive("src", "output.zip", ignore_patterns="*.pyc,__pycache__,*.log")
-	"""
-	# Fix copy_destinations type if needed
-	if destinations is None:
-		destinations = []
-	if destinations and isinstance(destinations, str):
-		destinations = [destinations]
-	if not destinations:
-		raise ValueError("destinations must be a list of at least one destination")
-
-	# Create directories if needed
-	if create_dir:
-		for dest_file in destinations:
-			dest_file = clean_path(dest_file)
-			parent_dir = os.path.dirname(dest_file)
-			if parent_dir and not os.path.exists(parent_dir):
-				os.makedirs(parent_dir, exist_ok=True)
-
-	# Create the archive
-	destination: str = clean_path(destinations[0])
-	destination = destination if ".zip" in destination else destination + ".zip"
-
-	# Parse ignore patterns (can be a single pattern or comma-separated patterns)
-	ignore_pattern_list: list[str] = []
-	if ignore_patterns:
-		ignore_pattern_list = [pattern.strip() for pattern in ignore_patterns.split(',')]
-
-	def should_ignore(path: str) -> bool:
-		"""Check if a file or directory path should be ignored based on patterns."""
-		if not ignore_pattern_list:
-			return False
-		for pattern in ignore_pattern_list:
-			if fnmatch.fnmatch(os.path.basename(path), pattern) or fnmatch.fnmatch(path, pattern):
-				return True
-		return False
-
-	with ZipFile(destination, "w", compression=ZIP_DEFLATED, compresslevel=9) as zip:
-		for root, dirs, files in os.walk(source):
-			# Filter out ignored directories in-place to prevent walking into them
-			dirs[:] = [d for d in dirs if not should_ignore(d)]
-
-			for file in files:
-				file_path: str = clean_path(os.path.join(root, file))
-				rel_path = os.path.relpath(file_path, source)
-
-				# Skip files that match any ignore pattern
-				if should_ignore(file) or should_ignore(rel_path):
-					continue
-
-				info: ZipInfo = ZipInfo(rel_path)
-				info.compress_type = ZIP_DEFLATED
-				if override_time:
-					info.date_time = override_time
-				with open(file_path, "rb") as f:
-					zip.writestr(info, f.read())
-
-	# Copy the archive to the destination(s)
-	for dest_file in destinations[1:]:
-		@handle_error(Exception, message=f"Unable to copy '{destination}' to '{dest_file}'", error_log=LogLevels.WARNING)
-		def internal(src: str, dest: str) -> None:
-			super_copy(src, dest, create_dir=create_dir)
-		internal(destination, clean_path(dest_file))
-
-	return True
-
+from .print import debug, error, info
 
 
 # Function that repair a corrupted zip file (ignoring some of the errors)
@@ -246,9 +147,123 @@ def repair_zip_file(file_path: str, destination: str) -> bool:
 
 	return True
 
+# Function that makes an archive with consistency (same zip file each time)
+@handle_error()
+def make_archive(
+	source: str,
+	destinations: list[str] | str | None = None,
+	override_time: None | tuple[int, int, int, int, int, int] = None,
+	create_dir: bool = False,
+	ignore_patterns: str | None = None,
+) -> bool:
+	""" Create a zip archive from a source directory with consistent file timestamps.
+	(Meaning deterministic zip file each time)
 
-# CLI functionality
-if __name__ == "__main__":
+	Creates a zip archive from the source directory and copies it to one or more destinations.
+	The archive will have consistent file timestamps across runs if override_time is specified.
+	Uses maximum compression level (9) with ZIP_DEFLATED algorithm.
+
+	Args:
+		source				(str):						The source folder to archive
+		destinations		(list[str]|str):			The destination folder(s) or file(s) to copy the archive to
+		override_time		(None | tuple[int, ...]):	The constant time to use for the archive
+			(e.g. (2024, 1, 1, 0, 0, 0) for 2024-01-01 00:00:00)
+		create_dir			(bool):						Whether to create the destination directory if it doesn't exist
+		ignore_patterns		(str | None):				Glob pattern(s) to ignore files. Can be a single pattern or comma-separated patterns (e.g. "*.pyc" or "*.pyc,__pycache__,*.log")
+	Returns:
+		bool: Always returns True unless any strong error
+	Examples:
+
+	.. code-block:: python
+
+		> make_archive("/path/to/source", "/path/to/destination.zip")
+		> make_archive("/path/to/source", ["/path/to/destination.zip", "/path/to/destination2.zip"])
+		> make_archive("src", "hello_from_year_2085.zip", override_time=(2085,1,1,0,0,0))
+		> make_archive("src", "output.zip", ignore_patterns="*.pyc")
+		> make_archive("src", "output.zip", ignore_patterns="__pycache__")
+		> make_archive("src", "output.zip", ignore_patterns="*.pyc,__pycache__,*.log")
+	"""
+	# Fix copy_destinations type if needed
+	if destinations is None:
+		destinations = []
+	if destinations and isinstance(destinations, str):
+		destinations = [destinations]
+	if not destinations:
+		raise ValueError("destinations must be a list of at least one destination")
+
+	# Create directories if needed
+	if create_dir:
+		for dest_file in destinations:
+			dest_file = clean_path(dest_file)
+			parent_dir = os.path.dirname(dest_file)
+			if parent_dir and not os.path.exists(parent_dir):
+				os.makedirs(parent_dir, exist_ok=True)
+
+	# Create the archive
+	destination: str = clean_path(destinations[0])
+	destination = destination if ".zip" in destination else destination + ".zip"
+
+	# Parse ignore patterns (can be a single pattern or comma-separated patterns)
+	ignore_pattern_list: list[str] = []
+	if ignore_patterns:
+		ignore_pattern_list = [pattern.strip() for pattern in ignore_patterns.split(',')]
+
+	def should_ignore(path: str) -> bool:
+		"""Check if a file or directory path should be ignored based on patterns."""
+		if not ignore_pattern_list:
+			return False
+		for pattern in ignore_pattern_list:
+			if fnmatch.fnmatch(os.path.basename(path), pattern) or fnmatch.fnmatch(path, pattern):
+				return True
+		return False
+
+	with ZipFile(destination, "w", compression=ZIP_DEFLATED, compresslevel=9) as zip:
+		for root, dirs, files in os.walk(source):
+			# Filter out ignored directories in-place to prevent walking into them
+			dirs[:] = [d for d in dirs if not should_ignore(d)]
+
+			for file in files:
+				file_path: str = clean_path(os.path.join(root, file))
+				rel_path = os.path.relpath(file_path, source)
+
+				# Skip files that match any ignore pattern
+				if should_ignore(file) or should_ignore(rel_path):
+					continue
+
+				info: ZipInfo = ZipInfo(rel_path)
+				info.compress_type = ZIP_DEFLATED
+				if override_time:
+					info.date_time = override_time
+				with open(file_path, "rb") as f:
+					zip.writestr(info, f.read())
+
+	# Copy the archive to the destination(s)
+	for dest_file in destinations[1:]:
+		@handle_error(Exception, message=f"Unable to copy '{destination}' to '{dest_file}'", error_log=LogLevels.WARNING)
+		def internal(src: str, dest: str) -> None:
+			super_copy(src, dest, create_dir=create_dir)
+		internal(destination, clean_path(dest_file))
+
+	return True
+
+
+# Main entry point for command line usage
+def archive_cli():
+	""" Main entry point for command line usage.
+
+	Examples:
+
+	.. code-block:: bash
+
+		# Repair a corrupted zip file
+		python -m stouputils.archive repair /path/to/corrupted.zip /path/to/repaired.zip
+
+		# Create a zip archive
+		python -m stouputils.archive make /path/to/source /path/to/destination.zip
+
+		# Create a zip archive with ignore patterns
+		python -m stouputils.archive make /path/to/source /path/to/destination.zip --ignore "*.pyc,__pycache__"
+	"""
 	import argparse
 	import sys
 
@@ -278,16 +293,16 @@ if __name__ == "__main__":
 			base, ext = os.path.splitext(input_file)
 			output_file = f"{base}_repaired{ext}"
 
-		print(f"Repairing '{input_file}' to '{output_file}'...")
+		debug(f"Repairing '{input_file}' to '{output_file}'...")
 		try:
 			repair_zip_file(input_file, output_file)
-			print(f"Successfully repaired zip file: {output_file}")
+			info(f"Successfully repaired zip file: {output_file}")
 		except Exception as e:
-			print(f"Error repairing zip file: {e}", file=sys.stderr)
+			error(f"Error repairing zip file: {e}", exit=False)
 			sys.exit(1)
 
 	elif args.command == "make":
-		print(f"Creating archive from '{args.source}' to '{args.destination}'...")
+		debug(f"Creating archive from '{args.source}' to '{args.destination}'...")
 		try:
 			make_archive(
 				source=args.source,
@@ -295,9 +310,9 @@ if __name__ == "__main__":
 				create_dir=args.create_dir,
 				ignore_patterns=args.ignore
 			)
-			print(f"Successfully created archive: {args.destination}")
+			info(f"Successfully created archive: {args.destination}")
 		except Exception as e:
-			print(f"Error creating archive: {e}", file=sys.stderr)
+			error(f"Error creating archive: {e}", exit=False)
 			sys.exit(1)
 
 	else:
@@ -305,3 +320,7 @@ if __name__ == "__main__":
 		sys.exit(1)
 
 
+if __name__ == "__main__":
+	archive_cli()
+
+