Merge pull request #3 from Tracks12:dev

Final version of builder tool & libs optimizations process

Author: Tracks12

.gitignore

@@ -1,5 +1,8 @@
-/WSLBuilder/
-__pycache__/
+.vscode/
 
+__pycache__/
 *.pyc
+
+/libs/wslbuilder
+/WSLBuilder/
 *.vhdx

core/__init__.py

@@ -1,6 +1,19 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+r""" Package initialization for `core`.
+
+	This module initializes the `core` package by defining essential functions and variables,
+	such as `get_config()` for loading configurations and `initialize_logger()` for setting up logging.
+	It ensures that the core components are ready for use when the package is imported.
+
+	Constants:
+	- INFO: Contains application information such as version, git commit hash, and other metadata.
+	- REGEX_ARGS: A regular expression pattern used to parse and split argument strings into lists.
+	- UNITS: Units of measurement for bytes, including KB, MB, GB, TB, etc., to facilitate size conversions.
+
+"""
+
 from time import sleep
 from traceback import format_exc
 
@@ -10,45 +23,48 @@
 from core.tool import Tool
 
 INFO = dict[str, str]({
+	"author": "Florian Cardinal",
+	"github": "https://github.com/Tracks12/toolsManager.py",
 	"name": "toolsManager.py",
-	"version": "0.1"
+	"version": "0.2",
 })
 
 REGEX_ARGS	= str("\\s(?=(?:[^\"'`]*[\"'`][^\"'`]*[\"'`])*[^\"'`]*$)")
 UNITS		= tuple[str](("o", "ko", "Mo", "Go", "To"))
 
 def helper(commands: tuple) -> None:
 	colors	= tuple[str]((Colors.cyan, Colors.yellow, Colors.red))
-	screen	= list[str]([ " List of commands:\n" ])
+	screen	= list[str]([ "List of commands:\n" ])
 
 	for i, command in enumerate(commands):
 		c	= int(1 if(i in range((len(commands)-4), (len(commands)-1))) else 0)
 		c	= int(2 if(i in range((len(commands)-1), (len(commands)))) else c)
 		sep	= str('\n' if(i in (len(commands)-5, len(commands)-2)) else '')
 
-		command = str(f" {colors[c]}{command[1]}{Colors.end}{sep}")
+		command = str(f"{colors[c]}{command[1]}{Colors.end}{sep}")
 
 		screen.append(command)
 
-	print(("\n").join(screen), end="\n\n")
+	print(("\n").join([ f" {s}" for s in screen ]), end="\n\n")
 
 def launch(tool: Tool, args: list[str]) -> bool:
 	try:
 		print(f'{Icons.play}Starting "{tool.name}" ...')
 		tool(args)
-	
-	except Exception:
-		print(f"{Icons.warn}{format_exc()}")
+
+	except(Exception):
+		print(f"{Icons.err}{format_exc()}")
 
 	finally:
 		print()
 		return(True)
 
 def sortTools(tools: list[Tool]) -> list[Tool]:
-	print(f"\n {' '*1}*  Name{' '*(12-len('Name'))}Command{' '*(16-len('Command'))}Path")
+	table = list[str]([ f" *  Name{' '*(14-len('Name'))}Command{' '*(16-len('Command'))}Path" ])
 	for i, tool in enumerate(tools, start=1):
-		print(f" {' '*(2-len(str(i)))}{i}. {tool.name}{' '*(12-len(tool.name))}{tool.command[1]}{' '*(16-len(tool.command[1]))}{tool.path}", end="\n"*(2 if(i == len(tools)) else 1))
+		table.append(f"{' '*(2-len(str(i)))}{Colors.green}{i}{Colors.end}. {tool.name}{' '*(14-len(tool.name))}{Colors.cyan}{tool.command[1]}{Colors.end}{' '*(16-len(tool.command[1]))}{Colors.yellow}{tool.path}{Colors.end}")
 
+	print(f"\n{'\n'.join([f" {t}" for t in table])}", end="\n"*2)
 	return(tools)
 
 def splash(spacing: int = 2) -> None:
@@ -64,6 +80,17 @@ def splash(spacing: int = 2) -> None:
 		print(f"{' '*spacing}{row}", end="\n"*(2 if(i == 6) else 1))
 		sleep(.025)
 
+def stringSize(size: int) -> str:
+	size = [size, UNITS[0]]
+
+	for i in range(1, len(UNITS)):
+		size[0] /= 1000
+		size[1] = UNITS[i]
+		if(size[0] < 1024):
+			break
+
+	return(f"{round(size[0], 2)} {size[1]}")
+
 def version() -> dict[str, str]:
 	print(f" {INFO['name']} {INFO['version']}", end="\n"*2)
 	return(INFO)

core/colors.py

@@ -1,6 +1,14 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+r""" Abstract base class for color handling.
+
+	Defines abstract classes and interfaces to standardize color management
+	across tools. It provides a foundation for implementing color schemes
+	and palettes compatible with different output formats.
+
+"""
+
 from platform import system
 
 class Colors:
@@ -20,4 +28,4 @@ class Colors:
 
 	else:
 		bold = italic = end = str("")
-		red = green = yellow = blue = purple = cyan = white = str("")
+		red = green = yellow = blue = purple = cyan = white = str("")

core/config.py

@@ -1,6 +1,14 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+r""" Configuration management for tools.
+
+	This module provides functions to load, validate, and access configuration parameters essential
+	for the proper operation of tools. It supports various configuration formats and allows centralized
+	management of settings.
+
+"""
+
 from json import dump, load
 from os.path import abspath
 
@@ -25,7 +33,7 @@ def __load(self) -> bool:
 				self.__splash	= bool(_["splash"])
 
 		except Exception:
-			print(f"{Icons.warn}Config file loading failed")
+			print(f"{Icons.err}Config file loading failed")
 			return(False)
 
 		return(True)
@@ -41,15 +49,21 @@ def __save(self) -> bool:
 				dump(dict(_), cfgFile, sort_keys=True, indent=2)
 
 		except Exception:
-			print(f"{Icons.warn}Config file saving failed")
+			print(f"{Icons.err}Config file saving failed")
 			return(False)
 
 		return(True)
 
 	def getEncoding(self) -> str:
+		""" Returns the encoding state, e.g. "ascii", "utf-8", "utf-16" or "utf-32"
+		"""
+
 		return(self.__encoding)
 
 	def getSplash(self) -> bool:
+		""" Returns the splash display state, e.g. True or False.
+    """
+
 		return(self.__splash)
 
 	def setEncoding(self, encoding: str = "utf-8") -> bool:

core/icons.py

@@ -1,10 +1,19 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+r""" Abstract base class for icon handling.
+
+	Defines abstract classes to represent icons used in tools.
+	Provides a structure for consistent icon management and allows
+	extension for various icon sets or formats.
+
+"""
+
 from core.colors import Colors
 
 class Icons:
-	warn: str = f" {Colors.bold}{Colors.red}[!]{Colors.end} - "
+	err: str = f" {Colors.bold}{Colors.red}[!]{Colors.end} - "
+	warn: str = f" {Colors.bold}{Colors.yellow}/!\\{Colors.end} - "
 	info: str = f" {Colors.bold}{Colors.blue}(i){Colors.end} - "
 	tips: str = f" {Colors.bold}{Colors.green}(?){Colors.end} - "
 	play: str = f" {Colors.bold}{Colors.green}(>){Colors.end} - "