stouputils 1.9.3__tar.gz → 1.9.4__tar.gz

{stouputils-1.9.3 → stouputils-1.9.4}/PKG-INFO

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

{stouputils-1.9.3 → stouputils-1.9.4}/pyproject.toml

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

{stouputils-1.9.3 → stouputils-1.9.4}/stouputils/__main__.py

@@ -8,13 +8,14 @@ import sys
 import argcomplete
 
 from .all_doctests import launch_tests
+from .archive import archive_cli
 from .backup import backup_cli
 from .decorators import handle_error
 from .print import CYAN, GREEN, RESET, show_version
 
 # Argument Parser Setup for Auto-Completion
 parser = argparse.ArgumentParser(prog="stouputils", add_help=False)
-parser.add_argument("command", nargs="?", choices=["--version", "-v", "all_doctests", "backup"])
+parser.add_argument("command", nargs="?", choices=["--version", "-v", "all_doctests", "archive", "backup"])
 parser.add_argument("args", nargs="*")
 argcomplete.autocomplete(parser)
 
@@ -33,6 +34,11 @@ def main() -> None:
 			sys.exit(1)
 		return
 
+	# Handle "archive" command
+	if second_arg == "archive":
+		sys.argv.pop(1)  # Remove "archive" from argv so archive_cli gets clean arguments
+		return archive_cli()
+
 	# Handle "backup" command
 	if second_arg == "backup":
 		sys.argv.pop(1)  # Remove "backup" from argv so backup_cli gets clean arguments
@@ -58,6 +64,7 @@ def main() -> None:
 	print(f"\n{CYAN}Available commands:{RESET}")
 	print(f"  {GREEN}--version, -v{RESET}       Show version information")
 	print(f"  {GREEN}all_doctests{RESET} [dir]  Run all doctests in the specified directory")
+	print(f"  {GREEN}archive{RESET} --help      Archive utilities (make, repair)")
 	print(f"  {GREEN}backup{RESET} --help       Backup utilities (delta, consolidate, limit)")
 	print(f"{CYAN}{separator}{RESET}")
 	return

{stouputils-1.9.3 → stouputils-1.9.4}/stouputils/archive.py

@@ -17,7 +17,7 @@ from zipfile import ZIP_DEFLATED, ZipFile, ZipInfo
 
 from .decorators import LogLevels, handle_error
 from .io import clean_path, super_copy
-from .print import debug, error, info
+from .print import CYAN, GREEN, RESET, debug, error, info
 
 
 # Function that repair a corrupted zip file (ignoring some of the errors)
@@ -267,6 +267,24 @@ def archive_cli() -> None:
 	import argparse
 	import sys
 
+	# Check for help or no command
+	if len(sys.argv) == 1 or (len(sys.argv) == 2 and sys.argv[1] in ("--help", "-h", "help")):
+		separator: str = "─" * 60
+		print(f"{CYAN}{separator}{RESET}")
+		print(f"{CYAN}stouputils {GREEN}archive {CYAN}utilities{RESET}")
+		print(f"{CYAN}{separator}{RESET}")
+		print(f"\n{CYAN}Usage:{RESET} stouputils archive <command> [options]")
+		print(f"\n{CYAN}Available commands:{RESET}")
+		print(f"  {GREEN}make{RESET} <source> <destination> [--ignore PATTERNS] [--create-dir]")
+		print("      Create a zip archive from source directory")
+		print(f"      {CYAN}--ignore{RESET}      Glob patterns to ignore (comma-separated)")
+		print(f"      {CYAN}--create-dir{RESET}  Create destination directory if needed")
+		print(f"\n  {GREEN}repair{RESET} <input_file> [output_file]")
+		print("      Repair a corrupted zip file")
+		print("      If output_file is omitted, adds '_repaired' suffix")
+		print(f"{CYAN}{separator}{RESET}")
+		return
+
 	parser = argparse.ArgumentParser(description="Archive utilities")
 	subparsers = parser.add_subparsers(dest="command", help="Available commands")
 

{stouputils-1.9.3 → stouputils-1.9.4}/stouputils/archive.pyi

@@ -1,6 +1,6 @@
 from .decorators import LogLevels as LogLevels, handle_error as handle_error
 from .io import clean_path as clean_path, super_copy as super_copy
-from .print import debug as debug, error as error, info as info
+from .print import CYAN as CYAN, GREEN as GREEN, RESET as RESET, debug as debug, error as error, info as info
 
 def repair_zip_file(file_path: str, destination: str) -> bool:
     ''' Try to repair a corrupted zip file by ignoring some of the errors

{stouputils-1.9.3 → stouputils-1.9.4}/stouputils/backup.py

@@ -50,6 +50,23 @@ def backup_cli() -> None:
 		python -m stouputils.backup limit 5 /path/to/backups
 	"""
 	import argparse
+	import sys
+
+	# Check for help or no command
+	if len(sys.argv) == 1 or (len(sys.argv) == 2 and sys.argv[1] in ("--help", "-h", "help")):
+		separator: str = "─" * 60
+		print(f"{CYAN}{separator}{RESET}")
+		print(f"{CYAN}Backup Utilities{RESET}")
+		print(f"{CYAN}{separator}{RESET}")
+		print(f"\n{CYAN}Usage:{RESET} stouputils backup <command> [options]")
+		print(f"\n{CYAN}Available commands:{RESET}")
+		print(f"  {GREEN}delta{RESET}         Create a new delta backup")
+		print(f"  {GREEN}consolidate{RESET}   Consolidate existing backups into one")
+		print(f"  {GREEN}limit{RESET}         Limit the number of delta backups")
+		print(f"\n{CYAN}For detailed help on a specific command:{RESET}")
+		print("  stouputils backup <command> --help")
+		print(f"{CYAN}{separator}{RESET}")
+		return
 
 	# Setup command line argument parser
 	parser: argparse.ArgumentParser = argparse.ArgumentParser(
@@ -82,21 +99,6 @@ def backup_cli() -> None:
 	# Parse arguments and execute appropriate command
 	args: argparse.Namespace = parser.parse_args()
 
-	# Show custom help if no command is provided
-	if not args.command:
-		separator: str = "─" * 60
-		print(f"{CYAN}{separator}{RESET}")
-		print(f"{CYAN}Backup Utilities{RESET}")
-		print(f"{CYAN}{separator}{RESET}")
-		print(f"\n{CYAN}Usage:{RESET} stouputils backup <command> [options]")
-		print(f"\n{CYAN}Available commands:{RESET}")
-		print(f"  {GREEN}delta{RESET}         Create a new delta backup")
-		print(f"  {GREEN}consolidate{RESET}   Consolidate existing backups into one")
-		print(f"  {GREEN}limit{RESET}         Limit the number of delta backups")
-		print(f"\n{CYAN}For detailed help on a specific command:{RESET}")
-		print("  stouputils backup <command> --help")
-		print(f"{CYAN}{separator}{RESET}")
-		return
 
 	if args.command == "delta":
 		create_delta_backup(args.source, args.destination, args.exclude)

{stouputils-1.9.3 → stouputils-1.9.4}/stouputils/collections.py

@@ -15,6 +15,7 @@ import atexit
 import os
 import shutil
 import tempfile
+from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any, Literal, TypeVar
 
 # Lazy imports for typing
@@ -28,14 +29,14 @@ if TYPE_CHECKING:
 T = TypeVar("T")
 
 # Functions
-def unique_list(list_to_clean: list[Any], method: Literal["id", "hash", "str"] = "str") -> list[Any]:
+def unique_list(list_to_clean: Iterable[T], method: Literal["id", "hash", "str"] = "str") -> list[T]:
 	""" Remove duplicates from the list while keeping the order using ids (default) or hash or str
 
 	Args:
-		list_to_clean	(list[Any]):					The list to clean
+		list_to_clean	(Iterable[T]):					The list to clean
 		method			(Literal["id", "hash", "str"]):	The method to use to identify duplicates
 	Returns:
-		list[Any]: The cleaned list
+		list[T]: The cleaned list
 
 	Examples:
 		>>> unique_list([1, 2, 3, 2, 1], method="id")
@@ -54,8 +55,8 @@ def unique_list(list_to_clean: list[Any], method: Literal["id", "hash", "str"] =
 		[{1, 2, 3}, {2, 3, 4}]
 	"""
 	# Initialize the seen ids set and the result list
-	seen: set[Any] = set()
-	result: list[Any] = []
+	seen: set[int | str] = set()
+	result: list[T] = []
 
 	# Iterate over each item in the list
 	for item in list_to_clean:

{stouputils-1.9.3 → stouputils-1.9.4}/stouputils/collections.pyi

@@ -1,18 +1,19 @@
 import polars as pl
 import zarr
+from collections.abc import Iterable
 from numpy.typing import NDArray as NDArray
 from typing import Any, Literal, TypeVar
 
 T = TypeVar('T')
 
-def unique_list(list_to_clean: list[Any], method: Literal['id', 'hash', 'str'] = 'str') -> list[Any]:
+def unique_list(list_to_clean: Iterable[T], method: Literal['id', 'hash', 'str'] = 'str') -> list[T]:
     ''' Remove duplicates from the list while keeping the order using ids (default) or hash or str
 
 \tArgs:
-\t\tlist_to_clean\t(list[Any]):\t\t\t\t\tThe list to clean
+\t\tlist_to_clean\t(Iterable[T]):\t\t\t\t\tThe list to clean
 \t\tmethod\t\t\t(Literal["id", "hash", "str"]):\tThe method to use to identify duplicates
 \tReturns:
-\t\tlist[Any]: The cleaned list
+\t\tlist[T]: The cleaned list
 
 \tExamples:
 \t\t>>> unique_list([1, 2, 3, 2, 1], method="id")