jeka/kiauh
1
0
Fork 0
mirror of https://github.com/dw-0/kiauh.git synced 2025-12-25 16:53:36 +05:00
Code Issues Packages Projects Releases Wiki Activity

refactor: further menu refactoring

Browse Source 
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
This commit is contained in:
dw-0
2024-03-31 17:28:16 +02:00
parent 39f0bd8b0a
commit 417180f724
16 changed files with 119 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
kiauh/core/menus/__init__.py
View File

@@ -21,3 +21,11 @@ NAVI_OPTIONS = {
FooterType.BACK: ["b"],
FooterType.BACK_HELP: ["b", "h"],
}
class ExitAppException(Exception):
pass
class GoBackException(Exception):
pass

8
kiauh/core/menus/advanced_menu.py
View File

@@ -18,15 +18,17 @@ from utils.constants import COLOR_YELLOW, RESET_FORMAT
class AdvancedMenu(BaseMenu):
def __init__(self):
def __init__(self, previous_menu: BaseMenu):
super().__init__()
self.previous_menu: BaseMenu = previous_menu
self.options = {
"1": None,
"2": None,
"3": None,
"4": KlipperFlashMethodMenu,
"4": lambda: KlipperFlashMethodMenu(previous_menu=self).run(),
"5": None,
"6": KlipperSelectMcuConnectionMenu,
"6": lambda: KlipperSelectMcuConnectionMenu(previous_menu=self).run(),
}
def print_menu(self):

4
kiauh/core/menus/backup_menu.py
View File

@@ -27,8 +27,10 @@ from utils.constants import COLOR_CYAN, RESET_FORMAT, COLOR_YELLOW
# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class BackupMenu(BaseMenu):
def __init__(self):
def __init__(self, previous_menu: BaseMenu):
super().__init__()
self.previous_menu: BaseMenu = previous_menu
self.options = {
"1": self.backup_klipper,
"2": self.backup_moonraker,

69
kiauh/core/menus/base_menu.py
View File

@@ -15,7 +15,7 @@ import textwrap
from abc import abstractmethod, ABC
from typing import Dict, Union, Callable, Type
from core.menus import FooterType, NAVI_OPTIONS
from core.menus import FooterType, NAVI_OPTIONS, ExitAppException, GoBackException
from utils.constants import (
COLOR_GREEN,
COLOR_YELLOW,
@@ -92,16 +92,15 @@ def print_back_help_footer():
print(footer, end="")
Option = Union[Callable, Type["BaseMenu"], "BaseMenu"]
Options = Dict[str, Option]
Options = Dict[str, Callable]
class BaseMenu(ABC):
options: Options = None
options: Options = {}
options_offset: int = 0
default_option: Union[Option, None] = None
default_option: Union[Callable, None] = None
input_label_txt: str = "Perform action"
header: bool = True
header: bool = False
previous_menu: Union[Type[BaseMenu], BaseMenu] = None
footer_type: FooterType = FooterType.BACK
@@ -130,7 +129,7 @@ class BaseMenu(ABC):
self.print_menu()
self.print_footer()
def validate_user_input(self, usr_input: str) -> Union[Option, str, None]:
def validate_user_input(self, usr_input: str) -> Callable:
"""
Validate the user input and either return an Option, a string or None
:param usr_input: The user input in form of a string
@@ -144,26 +143,27 @@ class BaseMenu(ABC):
is_valid_navigation = self.footer_type in NAVI_OPTIONS
user_navigated = usr_input in NAVI_OPTIONS[self.footer_type]
if is_valid_navigation and user_navigated:
return usr_input
if usr_input == "q":
raise ExitAppException()
elif usr_input == "b":
raise GoBackException()
elif usr_input == "h":
return option
# if usr_input is None or an empty string, we execute the menues default option if specified
if option is None or option == "" and self.default_option is not None:
if usr_input == "" and self.default_option is not None:
return self.default_option
# user selected a regular option
if option is not None:
return option
return option
return None
def handle_user_input(self) -> Union[Option, str]:
def handle_user_input(self) -> Callable:
"""Handle the user input, return the validated input or print an error."""
while True:
print(f"{COLOR_CYAN}###### {self.input_label_txt}: {RESET_FORMAT}", end="")
usr_input = input().lower()
validated_input = self.validate_user_input(usr_input)
if validated_input is not None:
if (validated_input := self.validate_user_input(usr_input)) is not None:
return validated_input
else:
Logger.print_error("Invalid input!", False)
@@ -171,36 +171,11 @@ class BaseMenu(ABC):
def run(self) -> None:
"""Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
while True:
self.display_menu()
choice = self.handle_user_input()
if choice == "q":
try:
self.display_menu()
self.handle_user_input()()
except GoBackException:
return
except ExitAppException:
Logger.print_ok("###### Happy printing!", False)
sys.exit(0)
elif choice == "b":
return
else:
self.execute_option(choice)
def execute_option(self, option: Option) -> None:
if option is None:
raise NotImplementedError(f"No implementation for {option}")
if isinstance(option, type) and issubclass(option, BaseMenu):
self.navigate_to_menu(option, True)
elif isinstance(option, BaseMenu):
self.navigate_to_menu(option, False)
elif callable(option):
option()
def navigate_to_menu(self, menu, instantiate: bool) -> None:
"""
Method for handling the actual menu switch. Can either take in a menu type or an already
instantiated menu class. Use instantiated menu classes only if the menu requires specific input parameters
:param menu: A menu type or menu instance
:param instantiate: Specify if the menu requires instantiation
:return: None
"""
menu = menu() if instantiate else menu
menu.previous_menu = self
menu.run()

17
kiauh/core/menus/extensions_menu.py
View File

@@ -22,12 +22,12 @@ from utils.constants import RESET_FORMAT, COLOR_CYAN, COLOR_YELLOW
# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class ExtensionsMenu(BaseMenu):
def __init__(self):
def __init__(self, previous_menu: BaseMenu):
super().__init__()
self.header = False
self.options: Options = self.get_options()
self.previous_menu: BaseMenu = previous_menu
self.extensions = self.discover_extensions()
self.options: Options = self.get_options(self.extensions)
def discover_extensions(self) -> List[BaseExtension]:
extensions = []
@@ -56,11 +56,11 @@ class ExtensionsMenu(BaseMenu):
return sorted(extensions, key=lambda ex: ex.metadata.get("index"))
def get_options(self) -> Options:
def get_options(self, extensions: List[BaseExtension]) -> Options:
options: Options = {}
for extension in self.extensions:
for extension in extensions:
index = extension.metadata.get("index")
options[f"{index}"] = ExtensionSubmenu(extension)
options[f"{index}"] = lambda: ExtensionSubmenu(self, extension).run()
return options
@@ -90,9 +90,10 @@ class ExtensionsMenu(BaseMenu):
# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class ExtensionSubmenu(BaseMenu):
def __init__(self, extension: BaseExtension):
def __init__(self, previous_menu: BaseMenu, extension: BaseExtension):
super().__init__()
self.header = False
self.previous_menu = previous_menu
self.options = {
"1": extension.install_extension,
"2": extension.remove_extension,

4
kiauh/core/menus/install_menu.py
View File

@@ -21,8 +21,10 @@ from utils.constants import COLOR_GREEN, RESET_FORMAT
# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class InstallMenu(BaseMenu):
def __init__(self):
def __init__(self, previous_menu: BaseMenu):
super().__init__()
self.previous_menu: BaseMenu = previous_menu
self.options = {
"1": self.install_klipper,
"2": self.install_moonraker,

19
kiauh/core/menus/main_menu.py
View File

@@ -40,16 +40,19 @@ from utils.constants import (
class MainMenu(BaseMenu):
def __init__(self):
super().__init__()
self.options = {
"0": LogUploadMenu,
"1": InstallMenu,
"2": UpdateMenu,
"3": RemoveMenu,
"4": AdvancedMenu,
"5": BackupMenu,
"e": ExtensionsMenu,
"s": SettingsMenu,
"0": lambda: LogUploadMenu(previous_menu=self).run(),
"1": lambda: InstallMenu(previous_menu=self).run(),
"2": lambda: UpdateMenu(previous_menu=self).run(),
"3": lambda: RemoveMenu(previous_menu=self).run(),
"4": lambda: AdvancedMenu(previous_menu=self).run(),
"5": lambda: BackupMenu(previous_menu=self).run(),
"6": None,
"e": lambda: ExtensionsMenu(previous_menu=self).run(),
"s": lambda: SettingsMenu(previous_menu=self).run(),
}
self.header = True
self.footer_type = FooterType.QUIT
self.kl_status = ""

16
kiauh/core/menus/remove_menu.py
View File

@@ -22,13 +22,19 @@ from utils.constants import COLOR_RED, RESET_FORMAT
# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class RemoveMenu(BaseMenu):
def __init__(self):
def __init__(self, previous_menu: BaseMenu):
super().__init__()
self.previous_menu: BaseMenu = previous_menu
self.options = {
"1": KlipperRemoveMenu,
"2": MoonrakerRemoveMenu,
"3": ClientRemoveMenu(client=load_client_data("mainsail")),
"4": ClientRemoveMenu(client=load_client_data("fluidd")),
"1": lambda: KlipperRemoveMenu(previous_menu=self).run(),
"2": lambda: MoonrakerRemoveMenu(previous_menu=self).run(),
"3": lambda: ClientRemoveMenu(
previous_menu=self, client=load_client_data("mainsail")
).run(),
"4": lambda: ClientRemoveMenu(
previous_menu=self, client=load_client_data("fluidd")
).run(),
"5": None,
"6": None,
"7": None,

4
kiauh/core/menus/settings_menu.py
View File

@@ -12,9 +12,11 @@ from core.menus.base_menu import BaseMenu
# noinspection PyMethodMayBeStatic
class SettingsMenu(BaseMenu):
def __init__(self):
def __init__(self, previous_menu: BaseMenu):
super().__init__()
self.previous_menu: BaseMenu = previous_menu
def print_menu(self):
print("self")

4
kiauh/core/menus/update_menu.py
View File

@@ -38,8 +38,10 @@ from utils.constants import (
# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class UpdateMenu(BaseMenu):
def __init__(self):
def __init__(self, previous_menu):
super().__init__()
self.previous_menu: BaseMenu = previous_menu
self.options = {
"0": self.update_all,
"1": self.update_klipper,