stouputils 1.12.1__tar.gz → 1.12.2__tar.gz

{stouputils-1.12.1 → stouputils-1.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stouputils
-Version: 1.12.1
+Version: 1.12.2
 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.
 Keywords: utilities,tools,helpers,development,python
 Author: Stoupy51
@@ -25,7 +25,6 @@ Requires-Dist: mlflow ; extra == 'data-science'
 Requires-Dist: tensorflow ; extra == 'data-science'
 Requires-Dist: scikit-learn ; extra == 'data-science'
 Requires-Dist: pywavelets ; extra == 'data-science'
-Requires-Dist: mypy ; extra == 'docs'
 Requires-Dist: m2r2 ; extra == 'docs'
 Requires-Dist: myst-parser ; extra == 'docs'
 Requires-Dist: sphinx-copybutton ; extra == 'docs'

{stouputils-1.12.1 → stouputils-1.12.2}/pyproject.toml

@@ -10,7 +10,7 @@ ignore-vcs = true
 
 [project]
 name = "stouputils"
-version = "1.12.1"
+version = "1.12.2"
 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"
 keywords = ["utilities", "tools", "helpers", "development", "python"]
@@ -38,7 +38,6 @@ authors = [
 
 [project.optional-dependencies]
 docs = [
-    "mypy",
     "m2r2",
     "myst_parser",
     "sphinx_copybutton",

{stouputils-1.12.1 → stouputils-1.12.2}/stouputils/__init__.py

@@ -14,10 +14,9 @@ Key Features:
 - Doctests utilities
 
 """
-# ruff: noqa: F403
-
 # Version (handle case where the package is not installed)
-from importlib.metadata import PackageNotFoundError, version
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as importlib_version
 
 # Imports
 from ._deprecated import *
@@ -32,9 +31,10 @@ from .image import *
 from .io import *
 from .parallel import *
 from .print import *
+from .version_pkg import *
 
 try:
-	__version__: str = version("stouputils")
+	__version__: str = importlib_version("stouputils")
 except PackageNotFoundError:
 	__version__: str = "0.0.0-dev"
 

{stouputils-1.12.1 → stouputils-1.12.2}/stouputils/__init__.pyi

@@ -10,5 +10,6 @@ from .image import *
 from .io import *
 from .parallel import *
 from .print import *
+from .version_pkg import *
 
 __version__: str

{stouputils-1.12.1 → stouputils-1.12.2}/stouputils/__main__.py

@@ -11,7 +11,8 @@ 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
+from .print import CYAN, GREEN, RESET
+from .version_pkg import show_version_cli
 
 # Argument Parser Setup for Auto-Completion
 parser = argparse.ArgumentParser(prog="stouputils", add_help=False)
@@ -28,9 +29,7 @@ def main() -> None:
 
 	# Print the version of stouputils and its dependencies
 	if second_arg in ("--version", "-v", "version", "show_version"):
-		if len(sys.argv) >= 3:
-			return show_version(sys.argv[2])
-		return show_version()
+		return show_version_cli()
 
 	# Handle "all_doctests" command
 	if second_arg == "all_doctests":
@@ -68,7 +67,8 @@ def main() -> None:
 {CYAN}Usage:{RESET} stouputils <command> [options]
 
 {CYAN}Available commands:{RESET}
-  {GREEN}--version, -v{RESET} [pkg]  Show version information (optionally for a specific package)
+  {GREEN}--version, -v{RESET} [pkg] [-t <depth>]
+        Show version information (optionally for a specific package)
   {GREEN}all_doctests{RESET} [dir]   Run all doctests in the specified directory
   {GREEN}archive{RESET} --help       Archive utilities (make, repair)
   {GREEN}backup{RESET} --help        Backup utilities (delta, consolidate, limit)

{stouputils-1.12.1 → stouputils-1.12.2}/stouputils/print.py

@@ -432,64 +432,6 @@ def current_time() -> str:
 		return time.strftime("%H:%M:%S")
 
 
-def show_version(main_package: str = "stouputils", primary_color: str = CYAN, secondary_color: str = GREEN) -> None:
-	""" Print the version of the main package and its dependencies.
-
-	Used by the "stouputils --version" command.
-
-	Args:
-		main_package			(str):			Name of the main package to show version for
-		primary_color			(str):			Color to use for the primary package name
-		secondary_color			(str):			Color to use for the secondary package names
-	"""
-	# Imports
-	from importlib.metadata import requires, version
-	def ver(package_name: str) -> str:
-		try:
-			return version(package_name)
-		except Exception:
-			return ""
-
-	# Get dependencies dynamically and extract package names from requirements (e.g., "tqdm>=4.0.0" -> "tqdm")
-	deps: list[str] = requires(main_package) or []
-	dep_names: list[str] = sorted([
-		dep
-			.split(">")[0]
-			.split("<")[0]
-			.split("=")[0]
-			.split("[")[0]
-		for dep in deps
-	])
-	all_deps: list[tuple[str, str]] = [
-		(x, ver(x).split("version: ")[-1])
-		for x in (main_package, *dep_names)
-	]
-	all_deps = [pair for pair in all_deps if pair[1]]  # Filter out packages with no version found
-	longest_name_length: int = max(len(name) for name, _ in all_deps)
-	longest_version_length: int = max(len(ver) for _, ver in all_deps)
-
-	# Get Python version
-	python_version: str = f" Python {sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro} "
-	minimum_separator_length: int = len(python_version) + 10	# Always at least 5 dashes on each side
-	separator_length: int = max(minimum_separator_length, longest_name_length + longest_version_length + 4)
-	python_text_length: int = len(python_version)
-	left_dashes: int = (separator_length - python_text_length) // 2
-	right_dashes: int = separator_length - python_text_length - left_dashes
-	separator_with_python: str = "─" * left_dashes + python_version + "─" * right_dashes
-	separator: str = "─" * separator_length
-
-	for pkg, v in all_deps:
-		pkg_spacing: str = " " * (longest_name_length - len(pkg))
-
-		# Highlight the main package with a different style
-		if pkg == main_package:
-			print(f"{primary_color}{separator_with_python}{RESET}")
-			print(f"{primary_color}{pkg}{pkg_spacing}  {secondary_color}v{v}{RESET}")
-			print(f"{primary_color}{separator}{RESET}")
-		else:
-			print(f"{primary_color}{pkg}{pkg_spacing}  {secondary_color}v{v}{RESET}")
-	return
-
 # Test the print functions
 if __name__ == "__main__":
 	info("Hello", "World")

{stouputils-1.12.1 → stouputils-1.12.2}/stouputils/print.pyi

@@ -134,13 +134,3 @@ def is_same_print(*args: Any, **kwargs: Any) -> bool:
     """ Checks if the current print call is the same as the previous one. """
 def current_time() -> str:
     ''' Get the current time as "HH:MM:SS" if less than 24 hours since import, else "YYYY-MM-DD HH:MM:SS" '''
-def show_version(main_package: str = 'stouputils', primary_color: str = ..., secondary_color: str = ...) -> None:
-    ''' Print the version of the main package and its dependencies.
-
-\tUsed by the "stouputils --version" command.
-
-\tArgs:
-\t\tmain_package\t\t\t(str):\t\t\tName of the main package to show version for
-\t\tprimary_color\t\t\t(str):\t\t\tColor to use for the primary package name
-\t\tsecondary_color\t\t\t(str):\t\t\tColor to use for the secondary package names
-\t'''

stouputils-1.12.2/stouputils/version_pkg.py

@@ -0,0 +1,189 @@
+"""
+This module provides utility functions for printing package version information
+in a structured format, including the main package and its dependencies.
+
+Functions:
+- show_version: Print the version of the main package and its dependencies.
+"""
+
+# Imports
+import sys
+
+from .print import CYAN, GREEN, RESET, YELLOW
+
+
+# Show version function
+def show_version(main_package: str = "stouputils", primary_color: str = CYAN, secondary_color: str = GREEN, max_depth: int = 2) -> None:
+	""" Print the version of the main package and its dependencies.
+
+	Used by the "stouputils --version" command.
+
+	Args:
+		main_package	(str):	Name of the main package to show version for
+		primary_color	(str):	Color to use for the primary package name
+		secondary_color	(str):	Color to use for the secondary package names
+		max_depth		(int):	Maximum depth for dependency tree (<= 2 for flat, >=3 for tree)
+	"""
+	# Imports
+	from importlib.metadata import requires, version
+	def ver(package_name: str) -> str:
+		try:
+			return version(package_name)
+		except Exception:
+			return ""
+
+	def get_deps(package_name: str) -> list[str]:
+		""" Get the list of dependency names for a package """
+		try:
+			deps: list[str] = requires(package_name) or []
+			# Remove duplicates while preserving order, then sort
+			unique_deps: list[str] = list(dict.fromkeys([
+				dep
+					.split(">")[0]
+					.split("<")[0]
+					.split("=")[0]
+					.split("[")[0]
+					.split(";")[0]
+					.strip()
+				for dep in deps
+			]))
+			return sorted(unique_deps)
+		except Exception:
+			return []
+
+	def print_tree(package_name: str, prefix: str = "", is_last: bool = True, visited: set[str] | None = None, fully_displayed: set[str] | None = None, depth: int = 0, max_depth: int = 3) -> None:
+		""" Recursively print the dependency tree """
+		if visited is None:
+			visited = set()
+		if fully_displayed is None:
+			fully_displayed = set()
+
+		# Prevent infinite recursion and limit depth
+		if package_name in visited or depth > max_depth:
+			return
+		visited.add(package_name)
+
+		# Get version
+		v: str = ver(package_name).split("version: ")[-1]
+		if not v:
+			return
+
+		# Determine the tree characters
+		connector: str = "└── " if is_last else "├── "
+
+		# Check if this package was already fully displayed
+		already_shown: bool = package_name in fully_displayed
+
+		# Print current package
+		if depth == 0:
+			print(f"{primary_color}{package_name}  {secondary_color}v{v}{RESET}")
+		else:
+			if already_shown:
+				print(f"{prefix}{connector}{primary_color}{package_name}  {secondary_color}v{v} {YELLOW}[Already shown ^]{RESET}")
+				# Still mark as fully displayed even when already shown
+				fully_displayed.add(package_name)
+				return
+			else:
+				print(f"{prefix}{connector}{primary_color}{package_name}  {secondary_color}v{v}{RESET}")
+
+		# Get dependencies
+		deps: list[str] = get_deps(package_name)
+
+		# Filter dependencies that will actually be displayed (have a version)
+		valid_deps: list[str] = [dep for dep in deps if ver(dep)]
+
+		# Print dependencies recursively
+		for i, dep in enumerate(valid_deps):
+			# Determine if this is the last element to display
+			is_last_dep: bool = (i == len(valid_deps) - 1)
+
+			# Extension is based on whether the CURRENT node is last, not the child
+			extension: str = "    " if is_last else "│   "
+			new_prefix: str = prefix + extension if depth > 0 else ""
+			print_tree(dep, new_prefix, is_last_dep, visited.copy(), fully_displayed, depth + 1, max_depth)
+
+		# Mark this package as fully displayed (with all its dependencies)
+		fully_displayed.add(package_name)
+
+	# Get Python version header
+	python_version: str = f" Python {sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro} "
+
+	if max_depth >= 3:
+		# Display as tree structure
+		minimum_separator_length: int = len(python_version) + 10
+		separator_length: int = minimum_separator_length
+		python_text_length: int = len(python_version)
+		left_dashes: int = (separator_length - python_text_length) // 2
+		right_dashes: int = separator_length - python_text_length - left_dashes
+		separator_with_python: str = "─" * left_dashes + python_version + "─" * right_dashes
+		separator: str = "─" * separator_length
+
+		print(f"{primary_color}{separator_with_python}{RESET}")
+		print_tree(main_package, max_depth=max_depth - 1)
+		print(f"{primary_color}{separator}{RESET}")
+	else:
+		# Display as flat list (original behavior)
+		deps: list[str] = requires(main_package) or []
+		dep_names: list[str] = sorted([
+			dep
+				.split(">")[0]
+				.split("<")[0]
+				.split("=")[0]
+				.split("[")[0]
+			for dep in deps
+		])
+		all_deps: list[tuple[str, str]] = [
+			(x, ver(x).split("version: ")[-1])
+			for x in (main_package, *dep_names)
+		]
+		all_deps = [pair for pair in all_deps if pair[1]]  # Filter out packages with no version found
+		longest_name_length: int = max(len(name) for name, _ in all_deps)
+		longest_version_length: int = max(len(ver) for _, ver in all_deps)
+
+		minimum_separator_length: int = len(python_version) + 10	# Always at least 5 dashes on each side
+		separator_length: int = max(minimum_separator_length, longest_name_length + longest_version_length + 4)
+		python_text_length: int = len(python_version)
+		left_dashes: int = (separator_length - python_text_length) // 2
+		right_dashes: int = separator_length - python_text_length - left_dashes
+		separator_with_python: str = "─" * left_dashes + python_version + "─" * right_dashes
+		separator: str = "─" * separator_length
+
+		for pkg, v in all_deps:
+			pkg_spacing: str = " " * (longest_name_length - len(pkg))
+
+			# Highlight the main package with a different style
+			if pkg == main_package:
+				print(f"{primary_color}{separator_with_python}{RESET}")
+				print(f"{primary_color}{pkg}{pkg_spacing}  {secondary_color}v{v}{RESET}")
+				print(f"{primary_color}{separator}{RESET}")
+			else:
+				print(f"{primary_color}{pkg}{pkg_spacing}  {secondary_color}v{v}{RESET}")
+	return
+
+# Show version cli
+def show_version_cli() -> None:
+	""" Handle the "stouputils --version" CLI command """
+	# Determine max depth (flat or tree structure)
+	max_depth: int = 2  # Flat by default
+
+	# Check for tree argument
+	if "--tree" in sys.argv or "-t" in sys.argv:
+		# Find position of tree argument
+		pos: int = sys.argv.index("--tree") if "--tree" in sys.argv else sys.argv.index("-t")
+
+		# Check for depth argument
+		if pos + 1 < len(sys.argv):
+			try:
+				max_depth = int(sys.argv[pos + 1])
+				sys.argv.pop(pos + 1)  # Remove depth argument
+			except ValueError:
+				pass  # Keep default if conversion fails
+		sys.argv.pop(pos)  # Remove the --tree/-t argument
+
+	# Handle specific package argument
+	if len(sys.argv) >= 3 and not sys.argv[2].startswith("-"):
+		return show_version(sys.argv[2], max_depth=max_depth)
+
+	# Else, show default package version
+	return show_version(max_depth=max_depth)
+

stouputils-1.12.2/stouputils/version_pkg.pyi

@@ -0,0 +1,15 @@
+from .print import CYAN as CYAN, GREEN as GREEN, RESET as RESET, YELLOW as YELLOW
+
+def show_version(main_package: str = 'stouputils', primary_color: str = ..., secondary_color: str = ..., max_depth: int = 2) -> None:
+    ''' Print the version of the main package and its dependencies.
+
+\tUsed by the "stouputils --version" command.
+
+\tArgs:
+\t\tmain_package\t(str):\tName of the main package to show version for
+\t\tprimary_color\t(str):\tColor to use for the primary package name
+\t\tsecondary_color\t(str):\tColor to use for the secondary package names
+\t\tmax_depth\t\t(int):\tMaximum depth for dependency tree (<= 2 for flat, >=3 for tree)
+\t'''
+def show_version_cli() -> None:
+    ''' Handle the "stouputils --version" CLI command '''