Refactor TPrint class; move color definitions to TPrintColors class

Author: DefinetlyNotAI

flasher.py

@@ -376,7 +376,7 @@ def __check_for_memory_address_conflicts(self, bin_files: list[str]) -> list[str
         tprint.warning("Please don't exit the program in this way, use 'exit' instead.")
     except Exception as err:
         print()
-        handler.exception(msg=err, exit_script=True)
+        handler.exception(msg=err)
     finally:
         tprint.info("Exiting...")
         print()

utils/tprint/__init__.py

@@ -1,47 +1,6 @@
 from __future__ import annotations
 import datetime
-
-
-# TPrintColors contains the ANSI color codes and additional highlights for text styling.
-class TPrintColors:
-    """
-    This class defines a set of ANSI escape sequences for text color formatting.
-    It includes basic colors, bright colors, background colors, and text styles.
-    """
-    # Basic Colors
-    WHITE = '\033[97m'
-    BLACK = '\033[30m'
-    RED = '\033[91m'
-    GREEN = '\033[92m'
-    YELLOW = '\033[93m'
-    BLUE = '\033[94m'
-    MAGENTA = '\033[95m'
-    CYAN = '\033[96m'
-    _RESET = '\033[0m'
-
-    # Bright Colors
-    BRIGHT_BLACK = '\033[30;1m'
-    BRIGHT_RED = '\033[91;1m'
-    BRIGHT_GREEN = '\033[92;1m'
-    BRIGHT_YELLOW = '\033[93;1m'
-    BRIGHT_BLUE = '\033[94;1m'
-    BRIGHT_MAGENTA = '\033[95;1m'
-    BRIGHT_CYAN = '\033[96;1m'
-
-    # Background Colors
-    BG_WHITE = '\033[47m'
-    BG_BLACK = '\033[40m'
-    BG_RED = '\033[41m'
-    BG_GREEN = '\033[42m'
-    BG_YELLOW = '\033[43m'
-    BG_BLUE = '\033[44m'
-    BG_MAGENTA = '\033[45m'
-    BG_CYAN = '\033[46m'
-
-    # Text Styles
-    BOLD = '\033[1m'
-    UNDERLINE = '\033[4m'
-    REVERSED = '\033[7m'
+from .colors import TPrintColors
 
 
 # TPrint class handles the printing and logging mechanism with customizable color schemes.
@@ -58,7 +17,7 @@ def __init__(self,
                  debug_mode: bool = False,
                  log_file: str | None = None,
                  use_timestamps: bool = False,
-                 purge_old_logs: bool = False
+                 purge_old_logs: bool = False,
                  ):
         """
         Initializes the TPrint instance with optional custom color schemes and logging options.
@@ -81,9 +40,10 @@ def __init__(self,
         }
 
         # Validate the color_scheme dictionary
-        unknown_keys = set(color_scheme) - set(self.default_colors)
-        if unknown_keys:
-            raise ValueError(f"Unknown keys in color_scheme: {unknown_keys}")
+        if color_scheme is not None and isinstance(color_scheme, dict):
+            unknown_keys = set(color_scheme) - set(self.default_colors)
+            if unknown_keys:
+                raise ValueError(f"Unknown keys in color_scheme: {unknown_keys}")
 
         # Use user-supplied scheme or merge it with defaults
         self.color_scheme = {**self.default_colors, **(color_scheme or {})}
@@ -92,7 +52,6 @@ def __init__(self,
         self.use_timestamps = use_timestamps
         self.purge_old_logs = purge_old_logs
 
-    # noinspection PyProtectedMember
     @staticmethod
     def __print_message(message, color: TPrintColors, symbol: str, timestamp: str = None, style=None):
         """
@@ -109,9 +68,9 @@ def __print_message(message, color: TPrintColors, symbol: str, timestamp: str =
         styled_message = f"{style}{message}" if style else message
         # Print the formatted message with the correct color and timestamp
         if timestamp:
-            print(f"{color}[{symbol}][{timestamp}] {styled_message}{TPrintColors._RESET}")
+            print(f"{color}[{symbol}] [{timestamp}] {styled_message}{TPrintColors.RESET}")
         else:
-            print(f"{color}[{symbol}] {styled_message}{TPrintColors._RESET}")
+            print(f"{color}[{symbol}] {styled_message}{TPrintColors.RESET}")
 
     def __log_message(self, message, symbol: str, timestamp=None):
         """
@@ -126,177 +85,168 @@ def __log_message(self, message, symbol: str, timestamp=None):
         if self.log_file:
             with open(self.log_file, 'a', encoding='utf-8') as log:
                 if timestamp:
-                    log.write(f"[{symbol}][{timestamp}] {message}\n")
+                    log.write(f"[{symbol}] [{timestamp}] {message}\n")
                 else:
                     log.write(f"[{symbol}] {message}\n")
 
     # Log levels
-    def info(self, message, log: bool = None, style: TPrintColors = None):
+    def info(self, message, log_to_file: bool = None, style: TPrintColors = None):
         """
         Logs an informational message.
 
         Args:
             message (str): The message to log.
-            log (bool): Whether to log the message to a file (default: None).
+            log_to_file (bool): Whether to log the message to a file (default: None).
             style (str): The style to apply to the message (default: None).
         """
-        if log is None:
-            log = self.log_file
+        if log_to_file is None:
+            log_to_file = self.log_file
         timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') if self.use_timestamps else None
         self.__print_message(message, self.color_scheme['info'], "*", timestamp, style)
-        if log:
+        if log_to_file:
             self.__log_message(message, "*", timestamp)
 
-    def warning(self, message, log: bool = False, style: TPrintColors = None):
+    def warning(self, message, log_to_file: bool = None, style: TPrintColors = None):
         """
         Logs a warning message.
 
         Args:
             message (str): The message to log.
-            log (bool): Whether to log the message to a file (default: False).
+            log_to_file (bool): Whether to log the message to a file (default: False).
             style (str): The style to apply to the message (default: None).
         """
-        if log is None:
-            log = self.log_file
+        if log_to_file is None:
+            log_to_file = self.log_file
         timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') if self.use_timestamps else None
         self.__print_message(message, self.color_scheme['warning'], "!", timestamp, style)
-        if log:
+        if log_to_file:
             self.__log_message(message, "!", timestamp)
 
-    def error(self, message, log: bool = False, style: TPrintColors = None):
+    def error(self, message, log_to_file: bool = None, style: TPrintColors = None):
         """
         Logs an error message.
 
         Args:
             message (str): The message to log.
-            log (bool): Whether to log the message to a file (default: False).
+            log_to_file (bool): Whether to log the message to a file (default: False).
             style (str): The style to apply to the message (default: None).
         """
-        if log is None:
-            log = self.log_file
+        if log_to_file is None:
+            log_to_file = self.log_file
         timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') if self.use_timestamps else None
         self.__print_message(message, self.color_scheme['error'], "x", timestamp, style)
-        if log:
+        if log_to_file:
             self.__log_message(message, "x", timestamp)
 
-    def debug(self, message, log: bool = False, style: TPrintColors = None):
+    def debug(self, message, log_to_file: bool = None, style: TPrintColors = None):
         """
         Logs a debug message if debug mode is enabled.
 
         Args:
             message (str): The message to log.
-            log (bool): Whether to log the message to a file (default: False).
+            log_to_file (bool): Whether to log the message to a file (default: False).
             style (str): The style to apply to the message (default: None).
         """
-        if log is None:
-            log = self.log_file
+        if log_to_file is None:
+            log_to_file = self.log_file
         if self.debug_mode:  # Only print debug messages if debug mode is enabled
             timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') if self.use_timestamps else None
             self.__print_message(message, self.color_scheme['debug'], "-", timestamp, style)
-            if log:
+            if log_to_file:
                 self.__log_message(message, "-", timestamp)
 
-    def critical(self, message, log: bool = False, style: TPrintColors = None):
+    def critical(self, message, log_to_file: bool = None, style: TPrintColors = None):
         """
         Logs a critical message.
 
         Args:
             message (str): The message to log.
-            log (bool): Whether to log the message to a file (default: False).
+            log_to_file (bool): Whether to log the message to a file (default: False).
             style (str): The style to apply to the message (default: None).
         """
-        if log is None:
-            log = self.log_file
+        if log_to_file is None:
+            log_to_file = self.log_file
         timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') if self.use_timestamps else None
         self.__print_message(message, self.color_scheme['critical'], "x", timestamp, style)
-        if log:
+        if log_to_file:
             self.__log_message(message, "x", timestamp)
 
-    def success(self, message, log: bool = False, style: TPrintColors = None):
+    def success(self, message, log_to_file: bool = None, style: TPrintColors = None):
         """
         Logs a success message.
 
         Args:
             message (str): The message to log.
-            log (bool): Whether to log the message to a file (default: False).
+            log_to_file (bool): Whether to log the message to a file (default: False).
             style (str): The style to apply to the message (default: None).
         """
-        if log is None:
-            log = self.log_file
+        if log_to_file is None:
+            log_to_file = self.log_file
         timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') if self.use_timestamps else None
         self.__print_message(message, self.color_scheme['success'], "✓", timestamp, style)
-        if log:
+        if log_to_file:
             self.__log_message(message, "✓", timestamp)
 
-    def input(self, message) -> str:
+    def input(self, message, log_to_file: bool = None) -> str:
         """
         Prompts the user for input with a colored message.
 
         Args:
             message (str): The message to display when prompting for input.
+            log_to_file (bool): Whether to log the message to a file (default: False).
 
         Returns:
             str: The user's input.
         """
-        return input(f"{self.color_scheme['input']}[?] {message}")
+        answer = input(f"{self.color_scheme['input']}[?] {message}")
+        if log_to_file is None:
+            log_to_file = self.log_file
 
-    # Setting dynamic updates
-    def set_color_scheme(self, color_scheme: dict[str, str]):
-        """
-        Dynamically updates the color scheme.
+        if log_to_file:
+            timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') if self.use_timestamps else None
+            self.__log_message(message, "?", timestamp)
+            self.__log_message(answer, ">", timestamp)
 
-        Args:
-            color_scheme (dict): The new color scheme.
-        """
-        # Allows for dynamic color updates
-        self.color_scheme.update(color_scheme)
-        unknown_keys = set(color_scheme) - set(self.default_colors)
-        if unknown_keys:
-            raise ValueError(f"Unknown keys in color_scheme: {unknown_keys}")
+        return answer
 
-    def set_debug_mode(self, debug_mode: bool):
+    # Setting dynamic updates
+    def formatter(self,
+                  color_scheme: dict[str, str] = None,
+                  debug_mode: bool = None,
+                  use_timestamps: bool = None,
+                  log_file: str | None = None,
+                  purge_old_logs: bool = None
+                  ):
         """
-        Enables or disables debug mode dynamically.
+        Modify previously set settings dynamically.
 
         Args:
             debug_mode (bool): The new debug mode flag.
-        """
-        self.debug_mode = debug_mode
-
-    def set_timestamp_usage(self, use_timestamps: bool):
-        """
-        Enables or disables the usage of timestamps dynamically.
-
-        Args:
+            color_scheme (dict): The new color scheme.
             use_timestamps (bool): The new timestamp flag.
-        """
-        self.use_timestamps = use_timestamps
-
-    def set_log_file(self, log_file: str | None):
-        """
-        Dynamically changes the log file name or disables logging.
-
-        Args:
             log_file (str | None): The new log file path or None to disable logging.
-        """
-        self.log_file = log_file
+            purge_old_logs (bool): The new purge flag.
 
-    def set_purge_old_logs(self, purge_old_logs: bool):
         """
-        Enables or disables old log purging dynamically.
+        # Allows for dynamic color updates
+        if color_scheme:
+            self.color_scheme.update(color_scheme)
+            unknown_keys = set(color_scheme) - set(self.default_colors)
+            if unknown_keys:
+                raise ValueError(f"Unknown keys in color_scheme: {unknown_keys}")
 
-        Args:
-            purge_old_logs (bool): The new purge flag.
-        """
-        self.purge_old_logs = purge_old_logs
+        self.use_timestamps = use_timestamps if use_timestamps is not None else self.use_timestamps
+        self.log_file = log_file if log_file is not None else self.log_file
+        self.purge_old_logs = purge_old_logs if purge_old_logs is not None else self.purge_old_logs
+        self.debug_mode = debug_mode if debug_mode is not None else self.debug_mode
 
 
-# noinspection PyProtectedMember
-def separator(title):
+def separator(title, color: TPrintColors = TPrintColors.MAGENTA):
     """
-    Prints a separator with a title in bold and magenta.
+    Prints a separator with a title in bold and specified color.
 
     Args:
         title (str): The title to display in the separator.
+        color (TPrintColors): The color to use - defaults to magenta.
     """
-    print(f"{TPrintColors.BOLD}{TPrintColors.MAGENTA}--- {title} ---{TPrintColors._RESET}")
+    print(f"{TPrintColors.BOLD}{color}--- {title} ---{TPrintColors.RESET}")

utils/tprint/colors.py

@@ -0,0 +1,40 @@
+# TPrintColors contains the ANSI color codes and additional highlights for text styling.
+class TPrintColors:
+    """
+    This class defines a set of ANSI escape sequences for text color formatting.
+    It includes basic colors, bright colors, background colors, and text styles.
+    """
+    # Basic Colors
+    WHITE = '\033[97m'
+    BLACK = '\033[30m'
+    RED = '\033[91m'
+    GREEN = '\033[92m'
+    YELLOW = '\033[93m'
+    BLUE = '\033[94m'
+    MAGENTA = '\033[95m'
+    CYAN = '\033[96m'
+    RESET = '\033[0m'
+
+    # Bright Colors
+    BRIGHT_BLACK = '\033[30;1m'
+    BRIGHT_RED = '\033[91;1m'
+    BRIGHT_GREEN = '\033[92;1m'
+    BRIGHT_YELLOW = '\033[93;1m'
+    BRIGHT_BLUE = '\033[94;1m'
+    BRIGHT_MAGENTA = '\033[95;1m'
+    BRIGHT_CYAN = '\033[96;1m'
+
+    # Background Colors
+    BG_WHITE = '\033[47m'
+    BG_BLACK = '\033[40m'
+    BG_RED = '\033[41m'
+    BG_GREEN = '\033[42m'
+    BG_YELLOW = '\033[43m'
+    BG_BLUE = '\033[44m'
+    BG_MAGENTA = '\033[45m'
+    BG_CYAN = '\033[46m'
+
+    # Text Styles
+    BOLD = '\033[1m'
+    UNDERLINE = '\033[4m'
+    REVERSED = '\033[7m'