Merge pull request #4 from Tracks12/dev

v0.1

Author: Tracks12

config.json

@@ -1,4 +1,5 @@
 {
+  "colors": false,
   "encoding": "utf-8",
   "splash": true
 }

core/__init__.py

@@ -18,15 +18,15 @@
 from traceback import format_exc
 
 from core.colors import Colors
-from core.config import Config
+from core.config import ACCEPT_ENCODING, Config, getConfig, setConfig
 from core.icons import Icons
 from core.tool import Tool
 
 INFO = dict[str, str]({
 	"author": "Florian Cardinal",
 	"github": "https://github.com/Tracks12/toolsManager.py",
 	"name": "toolsManager.py",
-	"version": "0.2",
+	"version": "0.1",
 })
 
 REGEX_ARGS	= str("\\s(?=(?:[^\"'`]*[\"'`][^\"'`]*[\"'`])*[^\"'`]*$)")

core/colors.py

@@ -9,10 +9,22 @@
 
 """
 
+from json import load
+from os.path import abspath
 from platform import system
 
+ENABLE_COLOR = bool(system() == "Linux")
+
+try:
+	with open(abspath("config.json"), "r", encoding="utf-8") as cfgFile:
+		_ = dict[str, str | bool](load(cfgFile))
+		ENABLE_COLOR = _["colors"]
+
+except:
+	pass
+
 class Colors:
-	if(system() == "Linux"):
+	if(ENABLE_COLOR):
 		bold	: str	= "\033[1m"
 		italic	: str	= "\033[3m"
 

core/config.py

@@ -9,14 +9,56 @@
 
 """
 
-from json import dump, load
+from json import JSONDecodeError, dump, load
 from os.path import abspath
+from traceback import format_exc
 
 from core.icons import Icons
 
+ACCEPT_ENCODING	: tuple[str] = ("ascii", "utf-8", "utf-16", "utf-32")
+
 class Config:
-	ACCEPT_ENCODING	: tuple[str] = ("ascii", "utf-8", "utf-16", "utf-32")
+	""" Configuration manager object for the program.
+
+		This class handles the loading, saving, and manipulation of a configuration file 
+		used by the program. It allows setting and retrieving parameters like CLI color usage, 
+		character encoding, and splash screen visibility.
+
+		Attributes:
+			loaded (bool): Indicates whether the configuration was successfully loaded at initialization.
+
+		Private Attributes:
+			__colors (bool): Whether colored output is enabled in the CLI.
+			__encoding (str): Encoding used for reading/writing the configuration file.
+			__path (str): Absolute path to the JSON configuration file.
+			__splash (bool): Whether the splash screen is enabled at startup.
+
+		Methods:
+			getColors() -> bool:
+				Returns the current state of CLI color output.
+
+			getEncoding() -> str:
+				Returns the currently set encoding.
+
+			getSplash() -> bool:
+				Returns whether the splash screen is enabled.
+
+			setColors(colors: bool = False) -> bool:
+				Updates the CLI color state and saves the configuration.
+
+			setEncoding(encoding: str = "utf-8") -> bool:
+				Updates the encoding value if it's allowed and saves the configuration.
 
+			setSplash(splash: bool = True) -> bool:
+				Updates the splash screen setting and saves the configuration.
+
+		Notes:
+			- The configuration file must be in JSON format with the keys: "colors", "encoding", and "splash".
+			- Accepted encodings are defined in the module-level constant `ACCEPT_ENCODING`.
+
+	"""
+
+	__colors	: bool	= False
 	__encoding	: str	= "utf-8"
 	__path		: str	= abspath("config.json")
 	__splash	: bool	= True
@@ -25,35 +67,60 @@ def __init__(self):
 		self.loaded		: bool	= self.__load()
 
 	def __load(self) -> bool:
+		""" Private method to load the configuration file
+
+			Returns the loading success statement, e.g. True or False.
+
+		"""
+
 		try:
 			with open(self.__path, "r", encoding=self.__encoding) as cfgFile:
 				_ = dict[str, str | bool](load(cfgFile))
 
+				self.__colors	= bool(_["colors"])
 				self.__encoding	= str(_["encoding"])
 				self.__splash	= bool(_["splash"])
 
-		except Exception:
+		except(FileNotFoundError):
+			print(f"{Icons.err}No config file found")
+			print(f"{Icons.info}Recreate config file with default settings")
+			self.__save()
+
+		except(JSONDecodeError, KeyError, Exception):
 			print(f"{Icons.err}Config file loading failed")
 			return(False)
 
 		return(True)
 
 	def __save(self) -> bool:
+		""" Private method to save the current configuration
+
+			Returns the saving success statement, e.g. True or False.
+
+		"""
+
 		try:
 			with open(self.__path, "w", encoding=self.__encoding) as cfgFile:
 				_ = dict({
+					"colors"	: self.__colors,
 					"encoding"	: self.__encoding,
 					"splash"	: self.__splash
 				})
 
 				dump(dict(_), cfgFile, sort_keys=True, indent=2)
 
-		except Exception:
+		except(Exception):
 			print(f"{Icons.err}Config file saving failed")
 			return(False)
 
 		return(True)
 
+	def getColors(self) -> bool:
+		""" Returns the colors display state, e.g. True or False.
+		"""
+
+		return(self.__colors)
+
 	def getEncoding(self) -> str:
 		""" Returns the encoding state, e.g. "ascii", "utf-8", "utf-16" or "utf-32"
 		"""
@@ -62,21 +129,133 @@ def getEncoding(self) -> str:
 
 	def getSplash(self) -> bool:
 		""" Returns the splash display state, e.g. True or False.
-    """
+		"""
 
 		return(self.__splash)
 
+	def setColors(self, colors: bool = False) -> bool:
+		""" Apply new colors state display on the whole cli
+
+			Parameters:
+
+				colors bool
+					the state between True or False
+
+			Return a bool to validate the updating
+
+		"""
+
+		self.__colors = bool(colors)
+		self.__save()
+
+		return(True)
+
 	def setEncoding(self, encoding: str = "utf-8") -> bool:
-		if(encoding.lower() in self.ACCEPT_ENCODING):
-			self.__encoding = encoding
+		""" Apply new encoding value on settings
+
+			Parameters:
+
+				encoding str
+					the string of the new encoding to use
+
+			Return a bool to validate the updating
+
+		"""
+
+		if(encoding.lower() in ACCEPT_ENCODING):
+			self.__encoding = str(encoding)
 			self.__save()
 
 			return(True)
 
 		return(False)
 
 	def setSplash(self, splash: bool = True) -> bool:
-		self.__splash = splash
+		""" Apply new splash state display on main prompt
+
+			Parameters:
+
+				splash bool
+					the state between True or False
+
+			Return a bool to validate the updating
+
+		"""
+
+		self.__splash = bool(splash)
 		self.__save()
 
 		return(True)
+
+def getConfig(cfg: Config, prop: str) -> bool:
+	""" Interface to get a config displayer
+
+		Parameters:
+
+			cfg Config
+				the config object instance
+
+			prop str
+				the string of property to show
+				can be "all" to display whole settings values
+
+		Return a bool to validate the output
+
+	"""
+
+	__output = list[str]([])
+	__gets = (
+		("colors", lambda:cfg.getColors()),
+		("encode", lambda:cfg.getEncoding()),
+		("splash", lambda:cfg.getSplash())
+	)
+
+	if(prop == "all"):
+		for r, g in __gets:
+			__output.append(f"{r}: {g()}")
+
+	elif(prop in [ r for r, g in __gets ]):
+		for r, g in __gets:
+			if(prop == r):
+				__output.append(g())
+
+	else:
+		__output.append(f"{Icons.warn}Uknown value was entered !"[1:-1])
+
+	print("\n".join([ f" {o}" for o in __output ]), end="\n"*2)
+	return(True)
+
+def setConfig(cfg: Config, prop: str, val: str) -> bool:
+	""" Interface to set a config property on config object
+
+		Parameters:
+
+			cfg Config
+				the config object instance
+
+			prop str
+				the string of property to update
+
+			val str
+				the new value of setting prop to update
+
+		Return a bool to validate the applied setting
+
+		Raise an Exception if the property doen't know
+
+	"""
+
+	__isApplied	= bool(False)
+	__sets		= (
+		("colors", lambda v:cfg.setColors(v.lower() == "true")),
+		("encode", lambda v:cfg.setEncoding(v)),
+		("splash", lambda v:cfg.setSplash(v.lower() == "true"))
+	)
+
+	for r, s in __sets:
+		if(prop == r):
+			__isApplied = s(val)
+			print(f'{Icons.info if(__isApplied) else Icons.err}new {prop} {"is" if(__isApplied) else "is not"} applied')
+			return(__isApplied)
+
+	raise(Exception("Uknown property !"))