refactor: overhaul color mechanics

Signed-off-by: Dominik Willner <th33xitus@gmail.com>
2025-12-27 17:53:35 +05:00 · 2024-10-26 00:02:37 +02:00
parent 106bf7675f
commit e63d9d67ec
35 changed files with 377 additions and 423 deletions
--- a/kiauh/components/klipper_firmware/menus/klipper_build_menu.py
+++ b/kiauh/components/klipper_firmware/menus/klipper_build_menu.py
@@ -17,10 +17,10 @@ from components.klipper_firmware.firmware_utils import (
    run_make_clean,
    run_make_menuconfig,
 )
-from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_RED, RESET_FORMAT
 from core.logger import Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
+from core.types.color import Color
 from utils.sys_utils import (
    check_package_install,
    install_system_packages,
@@ -33,6 +33,8 @@ from utils.sys_utils import (
 class KlipperBuildFirmwareMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title = "Build Firmware Menu"
+        self.title_color = Color.CYAN
        self.previous_menu: Type[BaseMenu] | None = previous_menu
        self.deps: Set[str] = {"build-essential", "dpkg-dev", "make"}
        self.missing_deps: List[str] = check_package_install(self.deps)
@@ -53,13 +55,8 @@ class KlipperBuildFirmwareMenu(BaseMenu):
            self.default_option = Option(method=self.install_missing_deps)

    def print_menu(self) -> None:
-        header = " [ Build Firmware Menu ] "
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
        menu = textwrap.dedent(
-            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            """
            ╟───────────────────────────────────────────────────────╢
            ║ The following dependencies are required:              ║
            ║                                                       ║
@@ -67,20 +64,22 @@ class KlipperBuildFirmwareMenu(BaseMenu):
        )[1:]

        for d in self.deps:
-            status_ok = f"{COLOR_GREEN}*INSTALLED*{RESET_FORMAT}"
-            status_missing = f"{COLOR_RED}*MISSING*{RESET_FORMAT}"
+            status_ok = Color.apply("*INSTALLED*", Color.GREEN)
+            status_missing = Color.apply("*MISSING*", Color.RED)
            status = status_missing if d in self.missing_deps else status_ok
            padding = 39 - len(d) + len(status) + (len(status_ok) - len(status))
-            d = f" {COLOR_CYAN}● {d}{RESET_FORMAT}"
+            d = Color.apply(f"● {d}", Color.CYAN)
            menu += f"║ {d}{status:>{padding}} ║\n"
        menu += "║                                                       ║\n"

-        if len(self.missing_deps) == 0:
-            line = f"{COLOR_GREEN}All dependencies are met!{RESET_FORMAT}"
-        else:
-            line = f"{COLOR_RED}Dependencies are missing!{RESET_FORMAT}"
+        color = Color.GREEN if len(self.missing_deps) == 0 else Color.RED
+        txt = (
+            "All dependencies are met!"
+            if len(self.missing_deps) == 0
+            else "Dependencies are missing!"
+        )

-        menu += f"║ {line:<62} ║\n"
+        menu += f"║ {Color.apply(txt, color):<62} ║\n"
        menu += "╟───────────────────────────────────────────────────────╢\n"

        print(menu, end="")
--- a/kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py
+++ b/kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py
@@ -12,9 +12,9 @@ import textwrap
 from typing import Type

 from components.klipper_firmware.flash_options import FlashMethod, FlashOptions
-from core.constants import COLOR_RED, RESET_FORMAT
 from core.menus import FooterType, Option
-from core.menus.base_menu import BaseMenu
+from core.menus.base_menu import BaseMenu, MenuTitleStyle
+from core.types.color import Color


 # noinspection PyUnusedLocal
@@ -22,6 +22,9 @@ from core.menus.base_menu import BaseMenu
 class KlipperNoFirmwareErrorMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title = "!!! NO FIRMWARE FILE FOUND !!!"
+        self.title_color = Color.RED
+        self.title_style = MenuTitleStyle.PLAIN
        self.previous_menu: Type[BaseMenu] | None = previous_menu

        self.flash_options = FlashOptions()
@@ -35,16 +38,11 @@ class KlipperNoFirmwareErrorMenu(BaseMenu):
        self.default_option = Option(method=self.go_back)

    def print_menu(self) -> None:
-        header = "!!! NO FIRMWARE FILE FOUND !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        line1 = f"{color}Unable to find a compiled firmware file!{RESET_FORMAT}"
+        line1 = "Unable to find a compiled firmware file!"
        menu = textwrap.dedent(
            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
            ╟───────────────────────────────────────────────────────╢
-            ║ {line1:<62} ║
+            ║ {Color.apply(line1, Color.RED):<62} ║
            ║                                                       ║
            ║ Make sure, that:                                      ║
            ║ ● the folder '~/klipper/out' and its content exist    ║
@@ -71,6 +69,9 @@ class KlipperNoFirmwareErrorMenu(BaseMenu):
 class KlipperNoBoardTypesErrorMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title = "!!! ERROR GETTING BOARD LIST !!!"
+        self.title_color = Color.RED
+        self.title_style = MenuTitleStyle.PLAIN
        self.previous_menu: Type[BaseMenu] | None = previous_menu
        self.footer_type = FooterType.BLANK
        self.input_label_txt = "Press ENTER to go back to [Main Menu]"
@@ -82,16 +83,11 @@ class KlipperNoBoardTypesErrorMenu(BaseMenu):
        self.default_option = Option(method=self.go_back)

    def print_menu(self) -> None:
-        header = "!!! ERROR GETTING BOARD LIST !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        line1 = f"{color}Reading the list of supported boards failed!{RESET_FORMAT}"
+        line1 = "Reading the list of supported boards failed!"
        menu = textwrap.dedent(
            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
            ╟───────────────────────────────────────────────────────╢
-            ║ {line1:<62} ║
+            ║ {Color.apply(line1, Color.RED):<62} ║
            ║                                                       ║
            ║ Make sure, that:                                      ║
            ║ ● the folder '~/klipper' and all its content exist    ║
--- a/kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py
+++ b/kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py
@@ -9,16 +9,21 @@
 from __future__ import annotations

 import textwrap
-from typing import Type
+from typing import Tuple, Type

-from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
-from core.menus.base_menu import BaseMenu
+from core.menus.base_menu import BaseMenu, MenuTitleStyle
+from core.types.color import Color
+
+
+def __title_config__() -> Tuple[str, Color, MenuTitleStyle]:
+    return "< ? > Help: Flash MCU < ? >", Color.YELLOW, MenuTitleStyle.PLAIN


 # noinspection DuplicatedCode
 class KlipperFlashMethodHelpMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title, self.title_color, self.title_style = __title_config__()
        self.previous_menu: Type[BaseMenu] | None = previous_menu

    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -34,15 +39,10 @@ class KlipperFlashMethodHelpMenu(BaseMenu):
        pass

    def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}Regular flashing method:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}Updating via SD-Card Update:{RESET_FORMAT}"
+        subheader1 = Color.apply("Regular flashing method:", Color.CYAN)
+        subheader2 = Color.apply("Updating via SD-Card Update:", Color.CYAN)
        menu = textwrap.dedent(
            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
            ╟───────────────────────────────────────────────────────╢
            ║ {subheader1:<62} ║
            ║ The default method to flash controller boards which   ║
@@ -77,6 +77,7 @@ class KlipperFlashMethodHelpMenu(BaseMenu):
 class KlipperFlashCommandHelpMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title, self.title_color, self.title_style = __title_config__()
        self.previous_menu: Type[BaseMenu] | None = previous_menu

    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -92,15 +93,10 @@ class KlipperFlashCommandHelpMenu(BaseMenu):
        pass

    def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}make flash:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}make serialflash:{RESET_FORMAT}"
+        subheader1 = Color.apply("make flash:", Color.CYAN)
+        subheader2 = Color.apply("make serialflash:", Color.CYAN)
        menu = textwrap.dedent(
            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
            ╟───────────────────────────────────────────────────────╢
            ║ {subheader1:<62} ║
            ║ The default command to flash controller board, it     ║
@@ -121,6 +117,7 @@ class KlipperFlashCommandHelpMenu(BaseMenu):
 class KlipperMcuConnectionHelpMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title, self.title_color, self.title_style = __title_config__()
        self.previous_menu: Type[BaseMenu] | None = previous_menu

    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -138,17 +135,12 @@ class KlipperMcuConnectionHelpMenu(BaseMenu):
        pass

    def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}USB:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}UART:{RESET_FORMAT}"
-        subheader3 = f"{COLOR_CYAN}USB DFU:{RESET_FORMAT}"
-        subheader4 = f"{COLOR_CYAN}USB RP2040 Boot:{RESET_FORMAT}"
+        subheader1 = Color.apply("USB:", Color.CYAN)
+        subheader2 = Color.apply("UART:", Color.CYAN)
+        subheader3 = Color.apply("USB DFU:", Color.CYAN)
+        subheader4 = Color.apply("USB RP2040 Boot:", Color.CYAN)
        menu = textwrap.dedent(
            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
            ╟───────────────────────────────────────────────────────╢
            ║ {subheader1:<62} ║
            ║ Selecting USB as the connection method will scan the  ║
--- a/kiauh/components/klipper_firmware/menus/klipper_flash_menu.py
+++ b/kiauh/components/klipper_firmware/menus/klipper_flash_menu.py
@@ -36,10 +36,10 @@ from components.klipper_firmware.menus.klipper_flash_help_menu import (
    KlipperFlashMethodHelpMenu,
    KlipperMcuConnectionHelpMenu,
 )
-from core.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
 from core.logger import DialogType, Logger
 from core.menus import FooterType, Option
-from core.menus.base_menu import BaseMenu
+from core.menus.base_menu import BaseMenu, MenuTitleStyle
+from core.types.color import Color
 from utils.input_utils import get_number_input


@@ -48,6 +48,8 @@ from utils.input_utils import get_number_input
 class KlipperFlashMethodMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title = "MCU Flash Menu"
+        self.title_color = Color.CYAN
        self.help_menu = KlipperFlashMethodHelpMenu
        self.input_label_txt = "Select flash method"
        self.footer_type = FooterType.BACK_HELP
@@ -67,17 +69,13 @@ class KlipperFlashMethodMenu(BaseMenu):
        }

    def print_menu(self) -> None:
-        header = " [ MCU Flash Menu ] "
-        subheader = f"{COLOR_YELLOW}ATTENTION:{RESET_FORMAT}"
-        subline1 = f"{COLOR_YELLOW}Make sure to select the correct method for the  MCU!{RESET_FORMAT}"
-        subline2 = f"{COLOR_YELLOW}Not all MCUs support both methods!{RESET_FORMAT}"
-
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
+        subheader = Color.apply("ATTENTION:", Color.YELLOW)
+        subline1 = Color.apply(
+            "Make sure to select the correct method for the MCU!", Color.YELLOW
+        )
+        subline2 = Color.apply("Not all MCUs support both methods!", Color.YELLOW)
        menu = textwrap.dedent(
            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
            ╟───────────────────────────────────────────────────────╢
            ║ Select the flash method for flashing the MCU.         ║
            ║                                                       ║
@@ -112,6 +110,9 @@ class KlipperFlashMethodMenu(BaseMenu):
 class KlipperFlashCommandMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title = "Which flash command to use for flashing the MCU?"
+        self.title_style = MenuTitleStyle.PLAIN
+        self.title_color = Color.YELLOW
        self.help_menu = KlipperFlashCommandHelpMenu
        self.input_label_txt = "Select flash command"
        self.footer_type = FooterType.BACK_HELP
@@ -132,8 +133,6 @@ class KlipperFlashCommandMenu(BaseMenu):
    def print_menu(self) -> None:
        menu = textwrap.dedent(
            """
-            ╔═══════════════════════════════════════════════════════╗
-            ║ Which flash command to use for flashing the MCU?      ║
            ╟───────────────────────────────────────────────────────╢
            ║ 1) make flash (default)                               ║
            ║ 2) make serialflash (stm32flash)                      ║
@@ -161,6 +160,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
        self, previous_menu: Type[BaseMenu] | None = None, standalone: bool = False
    ):
        super().__init__()
+        self.title = "Make sure that the controller board is connected now!"
+        self.title_style = MenuTitleStyle.PLAIN
+        self.title_color = Color.YELLOW
        self.previous_menu: Type[BaseMenu] | None = previous_menu
        self.__standalone = standalone
        self.help_menu = KlipperMcuConnectionHelpMenu
@@ -182,13 +184,8 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
        }

    def print_menu(self) -> None:
-        header = "Make sure that the controller board is connected now!"
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
        menu = textwrap.dedent(
-            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
+            """
            ╟───────────────────────────────────────────────────────╢
            ║ How is the controller board connected to the host?    ║
            ╟───────────────────────────────────────────────────────╢
@@ -230,7 +227,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
            Logger.print_status("Identifying MCU connected via USB in DFU mode ...")
            self.flash_options.mcu_list = find_usb_dfu_device()
        elif conn_type is ConnectionType.USB_RP2040:
-            Logger.print_status("Identifying MCU connected via USB in RP2 Boot mode ...")
+            Logger.print_status(
+                "Identifying MCU connected via USB in RP2 Boot mode ..."
+            )
            self.flash_options.mcu_list = find_usb_rp2_boot_device()

        if len(self.flash_options.mcu_list) < 1:
@@ -241,7 +240,7 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
        if self.__standalone and len(self.flash_options.mcu_list) > 0:
            Logger.print_ok("The following MCUs were found:", prefix=False)
            for i, mcu in enumerate(self.flash_options.mcu_list):
-                print(f"   ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}")
+                print(f"   ● MCU #{i}: {Color.CYAN}{mcu}{Color.RST}")
            time.sleep(3)
            return

@@ -256,6 +255,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
 class KlipperSelectMcuIdMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title = "!!! ATTENTION !!!"
+        self.title_style = MenuTitleStyle.PLAIN
+        self.title_color = Color.RED
        self.flash_options = FlashOptions()
        self.mcu_list = self.flash_options.mcu_list
        self.input_label_txt = "Select MCU to flash"
@@ -274,14 +276,9 @@ class KlipperSelectMcuIdMenu(BaseMenu):
        }

    def print_menu(self) -> None:
-        header = "!!! ATTENTION !!!"
-        header2 = f"[{COLOR_CYAN}List of detected MCUs{RESET_FORMAT}]"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
+        header2 = f"[{Color.apply('List of detected MCUs', Color.CYAN)}]"
        menu = textwrap.dedent(
            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
            ╟───────────────────────────────────────────────────────╢
            ║ Make sure, to select the correct MCU!                 ║
            ║ ONLY flash a firmware created for the respective MCU! ║
@@ -293,7 +290,7 @@ class KlipperSelectMcuIdMenu(BaseMenu):

        for i, mcu in enumerate(self.mcu_list):
            mcu = mcu.split("/")[-1]
-            menu += f"║ {i}) {COLOR_CYAN}{mcu:<51}{RESET_FORMAT}║\n"
+            menu += f"║ {i}) {Color.apply(f'{mcu:<51}', Color.CYAN)}║\n"

        menu += textwrap.dedent(
            """
@@ -348,7 +345,6 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
        else:
            menu = textwrap.dedent(
                """
-                ╔═══════════════════════════════════════════════════════╗
                ║ Please select the type of board that corresponds to   ║
                ║ the currently selected MCU ID you chose before.       ║
                ║                                                       ║
@@ -400,6 +396,9 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
 class KlipperFlashOverviewMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
+        self.title = "!!! ATTENTION !!!"
+        self.title_style = MenuTitleStyle.PLAIN
+        self.title_color = Color.RED
        self.flash_options = FlashOptions()
        self.input_label_txt = "Perform action (default=Y)"

@@ -415,21 +414,16 @@ class KlipperFlashOverviewMenu(BaseMenu):
        self.default_option = Option(self.execute_flash)

    def print_menu(self) -> None:
-        header = "!!! ATTENTION !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-
        method = self.flash_options.flash_method.value
        command = self.flash_options.flash_command.value
        conn_type = self.flash_options.connection_type.value
        mcu = self.flash_options.selected_mcu.split("/")[-1]
        board = self.flash_options.selected_board
        baudrate = self.flash_options.selected_baudrate
-        subheader = f"[{COLOR_CYAN}Overview{RESET_FORMAT}]"
+        color = Color.CYAN
+        subheader = f"[{Color.apply('Overview', color)}]"
        menu = textwrap.dedent(
            f"""
-            ╔═══════════════════════════════════════════════════════╗
-            ║ {color}{header:^{count}}{RESET_FORMAT} ║
            ╟───────────────────────────────────────────────────────╢
            ║ Before contuining the flashing process, please check  ║
            ║ if all parameters were set correctly! Once you made   ║
@@ -443,18 +437,18 @@ class KlipperFlashOverviewMenu(BaseMenu):

        menu += textwrap.dedent(
            f"""
-            ║ MCU: {COLOR_CYAN}{mcu:<48}{RESET_FORMAT} ║
-            ║ Connection: {COLOR_CYAN}{conn_type:<41}{RESET_FORMAT} ║
-            ║ Flash method: {COLOR_CYAN}{method:<39}{RESET_FORMAT} ║
-            ║ Flash command: {COLOR_CYAN}{command:<38}{RESET_FORMAT} ║
+            ║ MCU: {Color.apply(f"{mcu:<48}", color)} ║
+            ║ Connection: {Color.apply(f"{conn_type:<41}", color)} ║
+            ║ Flash method: {Color.apply(f"{method:<39}", color)} ║
+            ║ Flash command: {Color.apply(f"{command:<38}", color)} ║
            """
        )[1:]

        if self.flash_options.flash_method is FlashMethod.SD_CARD:
            menu += textwrap.dedent(
                f"""
-                ║ Board type: {COLOR_CYAN}{board:<41}{RESET_FORMAT} ║
-                ║ Baudrate: {COLOR_CYAN}{baudrate:<43}{RESET_FORMAT} ║
+                ║ Board type: {Color.apply(f"{board:<41}", color)} ║
+                ║ Baudrate: {Color.apply(f"{baudrate:<43}", color)} ║
                """
            )[1:]