doc(global): add documentations code on modules to describes utilities and functions of these and update python declarations on python top file

Author: Tracks12

.gitignore

@@ -1,5 +1,7 @@
-/WSLBuilder/
-__pycache__/
+.vscode/
 
+__pycache__/
 *.pyc
+
+/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
 

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:

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
 
@@ -47,9 +55,15 @@ def __save(self) -> bool:
 		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,6 +1,14 @@
-#!/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:

core/tool.py

@@ -1,6 +1,15 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+r""" Base class for tool objects.
+
+	Defines the `Tool` class which serves as the foundational object for
+	creating individual tools compatible with the tools registry.
+	Provides core functionalities and interface methods to ensure
+	integration with the overall tool management system.
+
+"""
+
 from traceback import format_exc
 
 from core.icons import Icons

main.py

@@ -1,22 +1,34 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-from os import system as shell
-from platform import system
-from sys import argv, version_info
+try:
+	# --- Importation des dépendances internes ---
+	from os import system as shell
+	from platform import system
+	from sys import argv, version_info
 
-import re
+	if(version_info.major < 3):
+		raise(SystemError)
 
-if(system() == "Linux"):
-	import readline
+	import re
 
-if(version_info.major < 3):
+	if(system() == "Linux"): # Dépendances pour Linux
+		import readline
+
+	# --- Importation des dépendances internes ---
+	from core import INFO, REGEX_ARGS
+	from core import Colors, Config, Icons
+	from core import helper, launch, sortTools, splash, version
+
+	from tools import TOOLS
+
+except(SystemError):
 	print("/!\\ - Program must be run with Python 3")
 	exit()
 
-# Importation des dépendances internes
-from core import INFO, REGEX_ARGS, Colors, Config, Icons, helper, launch, sortTools, splash, version
-from tools import TOOLS
+except(ModuleNotFoundError) as e:
+	print(e)
+	exit()
 
 def arg() -> bool:
 	args = dict({

tools/__init__.py

@@ -1,6 +1,16 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+r""" Tool registry for `tools`.
+
+	This module registers the available tools by importing them and adding them to a central registry.
+	It ensures that all tools are accessible through the `tools` package.
+
+	Constants:
+	- TOOLS: A list of `Tool` instances representing all registered tools available in the package.
+
+"""
+
 from core.tool import Tool
 
 from tools.matrix import Matrix

tools/matrix.py

@@ -1,4 +1,4 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 from os import system as shell

tools/shell.py

@@ -1,4 +1,4 @@
-#!/bin/python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 from os import system as shell