fix(klipper): handle file access exception for dietpi version file (#658)

Signed-off-by: Dominik Willner <th33xitus@gmail.com>

kiauh/components/klipper/klipper_remove.py

@@ -1,117 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-from typing import List
-
-from components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR
-from components.klipper.klipper import Klipper
-from components.klipper.klipper_dialogs import print_instance_overview
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
-from core.services.message_service import Message
-from core.types.color import Color
-from utils.fs_utils import run_remove_routines
-from utils.input_utils import get_selection_input
-from utils.instance_utils import get_instances
-from utils.sys_utils import unit_file_exists
-
-
-def run_klipper_removal(
-    remove_service: bool,
-    remove_dir: bool,
-    remove_env: bool,
-) -> Message:
-    completion_msg = Message(
-        title="Klipper Removal Process completed",
-        color=Color.GREEN,
-    )
-    klipper_instances: List[Klipper] = get_instances(Klipper)
-
-    if remove_service:
-        Logger.print_status("Removing Klipper instances ...")
-        if klipper_instances:
-            instances_to_remove = select_instances_to_remove(klipper_instances)
-            remove_instances(instances_to_remove)
-            instance_names = [i.service_file_path.stem for i in instances_to_remove]
-            txt = f"● Klipper instances removed: {', '.join(instance_names)}"
-            completion_msg.text.append(txt)
-        else:
-            Logger.print_info("No Klipper Services installed! Skipped ...")
-
-    if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
-        completion_msg.text = [
-            "Some Klipper services are still installed:",
-            f"● '{KLIPPER_DIR}' was not removed, even though selected for removal.",
-            f"● '{KLIPPER_ENV_DIR}' was not removed, even though selected for removal.",
-        ]
-    else:
-        if remove_dir:
-            Logger.print_status("Removing Klipper local repository ...")
-            if run_remove_routines(KLIPPER_DIR):
-                completion_msg.text.append("● Klipper local repository removed")
-        if remove_env:
-            Logger.print_status("Removing Klipper Python environment ...")
-            if run_remove_routines(KLIPPER_ENV_DIR):
-                completion_msg.text.append("● Klipper Python environment removed")
-
-    if completion_msg.text:
-        completion_msg.text.insert(0, "The following actions were performed:")
-    else:
-        completion_msg.color = Color.YELLOW
-        completion_msg.centered = True
-        completion_msg.text = ["Nothing to remove."]
-
-    return completion_msg
-
-
-def select_instances_to_remove(instances: List[Klipper]) -> List[Klipper] | None:
-    start_index = 1
-    options = [str(i + start_index) for i in range(len(instances))]
-    options.extend(["a", "b"])
-    instance_map = {options[i]: instances[i] for i in range(len(instances))}
-
-    print_instance_overview(
-        instances,
-        start_index=start_index,
-        show_index=True,
-        show_select_all=True,
-    )
-    selection = get_selection_input("Select Klipper instance to remove", options)
-
-    instances_to_remove = []
-    if selection == "b":
-        return None
-    elif selection == "a":
-        instances_to_remove.extend(instances)
-    else:
-        instances_to_remove.append(instance_map[selection])
-
-    return instances_to_remove
-
-
-def remove_instances(
-    instance_list: List[Klipper] | None,
-) -> None:
-    if not instance_list:
-        return
-
-    for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
-        InstanceManager.remove(instance)
-        delete_klipper_env_file(instance)
-
-
-def delete_klipper_env_file(instance: Klipper):
-    Logger.print_status(f"Remove '{instance.env_file}'")
-    if not instance.env_file.exists():
-        msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
-        Logger.print_info(msg)
-        return
-    run_remove_routines(instance.env_file)

kiauh/components/klipper/klipper_setup.py

@@ -1,242 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-from pathlib import Path
-from typing import Dict, List, Tuple
-
-from components.klipper import (
-    EXIT_KLIPPER_SETUP,
-    KLIPPER_DIR,
-    KLIPPER_ENV_DIR,
-    KLIPPER_INSTALL_SCRIPT,
-    KLIPPER_REQ_FILE,
-)
-from components.klipper.klipper import Klipper
-from components.klipper.klipper_dialogs import (
-    print_select_custom_name_dialog,
-)
-from components.klipper.klipper_utils import (
-    assign_custom_name,
-    backup_klipper_dir,
-    check_user_groups,
-    create_example_printer_cfg,
-    get_install_count,
-    handle_disruptive_system_packages,
-)
-from components.moonraker.moonraker import Moonraker
-from components.webui_client.client_utils import (
-    get_existing_clients,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import DialogType, Logger
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    cmd_sysctl_manage,
-    cmd_sysctl_service,
-    create_python_venv,
-    install_python_requirements,
-    parse_packages_from_file,
-)
-
-
-def install_klipper() -> None:
-    Logger.print_status("Installing Klipper ...")
-
-    klipper_list: List[Klipper] = get_instances(Klipper)
-    moonraker_list: List[Moonraker] = get_instances(Moonraker)
-    match_moonraker: bool = False
-
-    # if there are more moonraker instances than klipper instances, ask the user to
-    # match the klipper instance count to the count of moonraker instances with the same suffix
-    if len(moonraker_list) > len(klipper_list):
-        is_confirmed = display_moonraker_info(moonraker_list)
-        if not is_confirmed:
-            Logger.print_status(EXIT_KLIPPER_SETUP)
-            return
-        match_moonraker = True
-
-    install_count, name_dict = get_install_count_and_name_dict(
-        klipper_list, moonraker_list
-    )
-
-    if install_count == 0:
-        Logger.print_status(EXIT_KLIPPER_SETUP)
-        return
-
-    is_multi_install = install_count > 1 or (len(name_dict) >= 1 and install_count >= 1)
-    if not name_dict and install_count == 1:
-        name_dict = {0: ""}
-    elif is_multi_install and not match_moonraker:
-        custom_names = use_custom_names_or_go_back()
-        if custom_names is None:
-            Logger.print_status(EXIT_KLIPPER_SETUP)
-            return
-
-        handle_instance_names(install_count, name_dict, custom_names)
-
-    create_example_cfg = get_confirm("Create example printer.cfg?")
-    # run the actual installation
-    try:
-        run_klipper_setup(klipper_list, name_dict, create_example_cfg)
-    except Exception as e:
-        Logger.print_error(e)
-        Logger.print_error("Klipper installation failed!")
-        return
-
-
-def run_klipper_setup(
-    klipper_list: List[Klipper], name_dict: Dict[int, str], create_example_cfg: bool
-) -> None:
-    if not klipper_list:
-        setup_klipper_prerequesites()
-
-    for i in name_dict:
-        # skip this iteration if there is already an instance with the name
-        if name_dict[i] in [n.suffix for n in klipper_list]:
-            continue
-
-        instance = Klipper(suffix=name_dict[i])
-        instance.create()
-        cmd_sysctl_service(instance.service_file_path.name, "enable")
-
-        if create_example_cfg:
-            # if a client-config is installed, include it in the new example cfg
-            clients = get_existing_clients()
-            create_example_printer_cfg(instance, clients)
-
-        cmd_sysctl_service(instance.service_file_path.name, "start")
-
-    cmd_sysctl_manage("daemon-reload")
-
-    # step 4: check/handle conflicting packages/services
-    handle_disruptive_system_packages()
-
-    # step 5: check for required group membership
-    check_user_groups()
-
-
-def handle_instance_names(
-    install_count: int, name_dict: Dict[int, str], custom_names: bool
-) -> None:
-    for i in range(install_count):  # 3
-        key: int = len(name_dict.keys()) + 1
-        if custom_names:
-            assign_custom_name(key, name_dict)
-        else:
-            name_dict[key] = str(len(name_dict) + 1)
-
-
-def get_install_count_and_name_dict(
-    klipper_list: List[Klipper], moonraker_list: List[Moonraker]
-) -> Tuple[int, Dict[int, str]]:
-    install_count: int | None
-    if len(moonraker_list) > len(klipper_list):
-        install_count = len(moonraker_list)
-        name_dict = {i: moonraker.suffix for i, moonraker in enumerate(moonraker_list)}
-    else:
-        install_count = get_install_count()
-        name_dict = {i: klipper.suffix for i, klipper in enumerate(klipper_list)}
-
-        if install_count is None:
-            Logger.print_status(EXIT_KLIPPER_SETUP)
-            return 0, {}
-
-    return install_count, name_dict
-
-
-def setup_klipper_prerequesites() -> None:
-    settings = KiauhSettings()
-    repo = settings.klipper.repo_url
-    branch = settings.klipper.branch
-
-    git_clone_wrapper(repo, KLIPPER_DIR, branch)
-
-    # install klipper dependencies and create python virtualenv
-    try:
-        install_klipper_packages()
-        if create_python_venv(KLIPPER_ENV_DIR):
-            install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
-    except Exception:
-        Logger.print_error("Error during installation of Klipper requirements!")
-        raise
-
-
-def install_klipper_packages() -> None:
-    script = KLIPPER_INSTALL_SCRIPT
-    packages = parse_packages_from_file(script)
-
-    # Add pkg-config for rp2040 build
-    packages.append("pkg-config")
-
-    # Add dbus requirement for DietPi distro
-    if Path("/boot/dietpi/.version").exists():
-        packages.append("dbus")
-
-    check_install_dependencies({*packages})
-
-
-def update_klipper() -> None:
-    Logger.print_dialog(
-        DialogType.WARNING,
-        [
-            "Do NOT continue if there are ongoing prints running!",
-            "All Klipper instances will be restarted during the update process and "
-            "ongoing prints WILL FAIL.",
-        ],
-    )
-
-    if not get_confirm("Update Klipper now?"):
-        return
-
-    settings = KiauhSettings()
-    if settings.kiauh.backup_before_update:
-        backup_klipper_dir()
-
-    instances = get_instances(Klipper)
-    InstanceManager.stop_all(instances)
-
-    git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
-
-    # install possible new system packages
-    install_klipper_packages()
-    # install possible new python dependencies
-    install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
-
-    InstanceManager.start_all(instances)
-
-
-def use_custom_names_or_go_back() -> bool | None:
-    print_select_custom_name_dialog()
-    _input: bool | None = get_confirm(
-        "Assign custom names?",
-        False,
-        allow_go_back=True,
-    )
-    return _input
-
-
-def display_moonraker_info(moonraker_list: List[Moonraker]) -> bool:
-    # todo: only show the klipper instances that are not already installed
-    Logger.print_dialog(
-        DialogType.INFO,
-        [
-            "Existing Moonraker instances detected:",
-            *[f"● {m.service_file_path.stem}" for m in moonraker_list],
-            "\n\n",
-            "The following Klipper instances will be installed:",
-            *[f"● klipper-{m.suffix}" for m in moonraker_list],
-        ],
-    )
-    _input: bool = get_confirm("Proceed with installation?")
-    return _input

kiauh/components/klipper/klipper_utils.py

@@ -11,6 +11,7 @@ from __future__ import annotations
 import grp
 import os
 import shutil
+from pathlib import Path
 from subprocess import CalledProcessError, run
 from typing import Dict, List
 
@@ -18,6 +19,7 @@ from components.klipper import (
     KLIPPER_BACKUP_DIR,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
+    KLIPPER_INSTALL_SCRIPT,
     MODULE_PATH,
 )
 from components.klipper.klipper import Klipper
@@ -37,10 +39,11 @@ from core.submodules.simple_config_parser.src.simple_config_parser.simple_config
     SimpleConfigParser,
 )
 from core.types.component_status import ComponentStatus
-from utils.common import get_install_status
+from utils.common import check_install_dependencies, get_install_status
+from utils.fs_utils import check_file_exist
 from utils.input_utils import get_confirm, get_number_input, get_string_input
 from utils.instance_utils import get_instances
-from utils.sys_utils import cmd_sysctl_service
+from utils.sys_utils import cmd_sysctl_service, parse_packages_from_file
 
 
 def get_klipper_status() -> ComponentStatus:
@@ -194,3 +197,17 @@ def backup_klipper_dir() -> None:
     bm = BackupManager()
     bm.backup_directory("klipper", source=KLIPPER_DIR, target=KLIPPER_BACKUP_DIR)
     bm.backup_directory("klippy-env", source=KLIPPER_ENV_DIR, target=KLIPPER_BACKUP_DIR)
+
+
+def install_klipper_packages() -> None:
+    script = KLIPPER_INSTALL_SCRIPT
+    packages = parse_packages_from_file(script)
+
+    # Add pkg-config for rp2040 build
+    packages.append("pkg-config")
+
+    # Add dbus requirement for DietPi distro
+    if check_file_exist(Path("/boot/dietpi/.version")):
+        packages.append("dbus")
+
+    check_install_dependencies({*packages})

kiauh/components/klipper/menus/klipper_remove_menu.py

@@ -11,7 +11,7 @@ from __future__ import annotations
 import textwrap
 from typing import Type
 
-from components.klipper import klipper_remove
+from components.klipper.services.klipper_setup_service import KlipperSetupService
 from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
 from core.types.color import Color
@@ -27,11 +27,13 @@ class KlipperRemoveMenu(BaseMenu):
         self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.footer_type = FooterType.BACK
 
-        self.remove_klipper_service = False
-        self.remove_klipper_dir = False
-        self.remove_klipper_env = False
+        self.rm_svc = False
+        self.rm_dir = False
+        self.rm_env = False
         self.select_state = False
 
+        self.klsvc = KlipperSetupService()
+
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
 
@@ -49,10 +51,10 @@ class KlipperRemoveMenu(BaseMenu):
     def print_menu(self) -> None:
         checked = f"[{Color.apply('x', Color.CYAN)}]"
         unchecked = "[ ]"
-        o1 = checked if self.remove_klipper_service else unchecked
-        o2 = checked if self.remove_klipper_dir else unchecked
-        o3 = checked if self.remove_klipper_env else unchecked
-        sel_state = f"{'Select'if not self.select_state else 'Deselect'} everything"
+        o1 = checked if self.rm_svc else unchecked
+        o2 = checked if self.rm_dir else unchecked
+        o3 = checked if self.rm_env else unchecked
+        sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
         menu = textwrap.dedent(
             f"""
             ╟───────────────────────────────────────────────────────╢
@@ -73,37 +75,28 @@ class KlipperRemoveMenu(BaseMenu):
 
     def toggle_all(self, **kwargs) -> None:
         self.select_state = not self.select_state
-        self.remove_klipper_service = self.select_state
-        self.remove_klipper_dir = self.select_state
-        self.remove_klipper_env = self.select_state
+        self.rm_svc = self.select_state
+        self.rm_dir = self.select_state
+        self.rm_env = self.select_state
 
     def toggle_remove_klipper_service(self, **kwargs) -> None:
-        self.remove_klipper_service = not self.remove_klipper_service
+        self.rm_svc = not self.rm_svc
 
     def toggle_remove_klipper_dir(self, **kwargs) -> None:
-        self.remove_klipper_dir = not self.remove_klipper_dir
+        self.rm_dir = not self.rm_dir
 
     def toggle_remove_klipper_env(self, **kwargs) -> None:
-        self.remove_klipper_env = not self.remove_klipper_env
+        self.rm_env = not self.rm_env
 
     def run_removal_process(self, **kwargs) -> None:
-        if (
-            not self.remove_klipper_service
-            and not self.remove_klipper_dir
-            and not self.remove_klipper_env
-        ):
+        if not self.rm_svc and not self.rm_dir and not self.rm_env:
             msg = "Nothing selected! Select options to remove first."
             print(Color.apply(msg, Color.RED))
             return
 
-        completion_msg = klipper_remove.run_klipper_removal(
-            self.remove_klipper_service,
-            self.remove_klipper_dir,
-            self.remove_klipper_env,
-        )
-        self.message_service.set_message(completion_msg)
+        self.klsvc.remove(self.rm_svc, self.rm_dir, self.rm_env)
 
-        self.remove_klipper_service = False
-        self.remove_klipper_dir = False
-        self.remove_klipper_env = False
+        self.rm_svc = False
+        self.rm_dir = False
+        self.rm_env = False
         self.select_state = False

kiauh/components/klipper/services/klipper_instance_service.py

@@ -0,0 +1,46 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from typing import List
+
+from components.klipper.klipper import Klipper
+from utils.instance_utils import get_instances
+
+
+class KlipperInstanceService:
+    __cls_instance = None
+    __instances: List[Klipper] = []
+
+    def __new__(cls) -> "KlipperInstanceService":
+        if cls.__cls_instance is None:
+            cls.__cls_instance = super(KlipperInstanceService, cls).__new__(cls)
+        return cls.__cls_instance
+
+    def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
+        if self.__initialized:
+            return
+        self.__initialized = True
+
+    def load_instances(self) -> None:
+        self.__instances = get_instances(Klipper)
+
+    def create_new_instance(self, suffix: str) -> Klipper:
+        instance = Klipper(suffix)
+        self.__instances.append(instance)
+        return instance
+
+    def get_all_instances(self) -> List[Klipper]:
+        return self.__instances
+
+    def get_instance_by_suffix(self, suffix: str) -> Klipper | None:
+        instances: List[Klipper] = [i for i in self.__instances if i.suffix == suffix]
+        return instances[0] if instances else None

kiauh/components/klipper/services/klipper_setup_service.py

@@ -0,0 +1,362 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from copy import copy
+from typing import Dict, List, Tuple
+
+from components.klipper import (
+    EXIT_KLIPPER_SETUP,
+    KLIPPER_DIR,
+    KLIPPER_ENV_DIR,
+    KLIPPER_REQ_FILE,
+)
+from components.klipper.klipper import Klipper
+from components.klipper.klipper_dialogs import (
+    print_instance_overview,
+    print_select_custom_name_dialog,
+)
+from components.klipper.klipper_utils import (
+    assign_custom_name,
+    backup_klipper_dir,
+    check_user_groups,
+    create_example_printer_cfg,
+    get_install_count,
+    handle_disruptive_system_packages,
+    install_klipper_packages,
+)
+from components.klipper.services.klipper_instance_service import KlipperInstanceService
+from components.moonraker.moonraker import Moonraker
+from components.moonraker.services.moonraker_instance_service import (
+    MoonrakerInstanceService,
+)
+from components.webui_client.client_utils import (
+    get_existing_clients,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.services.message_service import Message, MessageService
+from core.settings.kiauh_settings import KiauhSettings
+from core.types.color import Color
+from utils.fs_utils import run_remove_routines
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm, get_selection_input
+from utils.sys_utils import (
+    cmd_sysctl_manage,
+    create_python_venv,
+    install_python_requirements,
+    unit_file_exists,
+)
+
+
+# noinspection PyMethodMayBeStatic
+class KlipperSetupService:
+    __cls_instance = None
+
+    kisvc: KlipperInstanceService
+    misvc: MoonrakerInstanceService
+    msgsvc = MessageService
+
+    settings: KiauhSettings
+    klipper_list: List[Klipper]
+    moonraker_list: List[Moonraker]
+
+    def __new__(cls) -> "KlipperSetupService":
+        if cls.__cls_instance is None:
+            cls.__cls_instance = super(KlipperSetupService, cls).__new__(cls)
+        return cls.__cls_instance
+
+    def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
+        if self.__initialized:
+            return
+        self.__initialized = True
+        self.__init_state()
+
+    def __init_state(self) -> None:
+        self.settings = KiauhSettings()
+
+        self.kisvc = KlipperInstanceService()
+        self.kisvc.load_instances()
+        self.klipper_list = self.kisvc.get_all_instances()
+
+        self.misvc = MoonrakerInstanceService()
+        self.misvc.load_instances()
+        self.moonraker_list = self.misvc.get_all_instances()
+
+        self.msgsvc = MessageService()
+
+    def __refresh_state(self) -> None:
+        self.kisvc.load_instances()
+        self.klipper_list = self.kisvc.get_all_instances()
+
+        self.misvc.load_instances()
+        self.moonraker_list = self.misvc.get_all_instances()
+
+    def install(self) -> None:
+        Logger.print_status("Installing Klipper ...")
+
+        match_moonraker: bool = False
+
+        # if there are more moonraker instances than klipper instances, ask the user to
+        # match the klipper instance count to the count of moonraker instances with the same suffix
+        if len(self.moonraker_list) > len(self.klipper_list):
+            is_confirmed = self.__display_moonraker_info()
+            if not is_confirmed:
+                Logger.print_status(EXIT_KLIPPER_SETUP)
+                return
+            match_moonraker = True
+
+        install_count, name_dict = self.__get_install_count_and_name_dict()
+
+        if install_count == 0:
+            Logger.print_status(EXIT_KLIPPER_SETUP)
+            return
+
+        is_multi_install = install_count > 1 or (
+            len(name_dict) >= 1 and install_count >= 1
+        )
+        if not name_dict and install_count == 1:
+            name_dict = {0: ""}
+        elif is_multi_install and not match_moonraker:
+            custom_names = self.__use_custom_names_or_go_back()
+            if custom_names is None:
+                Logger.print_status(EXIT_KLIPPER_SETUP)
+                return
+
+            self.__handle_instance_names(install_count, name_dict, custom_names)
+
+        create_example_cfg = get_confirm("Create example printer.cfg?")
+        # run the actual installation
+        try:
+            self.__run_setup(name_dict, create_example_cfg)
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Klipper installation failed!")
+            return
+
+    def update(self) -> None:
+        Logger.print_dialog(
+            DialogType.WARNING,
+            [
+                "Do NOT continue if there are ongoing prints running!",
+                "All Klipper instances will be restarted during the update process and "
+                "ongoing prints WILL FAIL.",
+            ],
+        )
+
+        if not get_confirm("Update Klipper now?"):
+            return
+
+        self.__refresh_state()
+
+        if self.settings.kiauh.backup_before_update:
+            backup_klipper_dir()
+
+        InstanceManager.stop_all(self.klipper_list)
+        git_pull_wrapper(self.settings.klipper.repo_url, KLIPPER_DIR)
+        install_klipper_packages()
+        install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
+        InstanceManager.start_all(self.klipper_list)
+
+    def remove(
+        self,
+        remove_service: bool,
+        remove_dir: bool,
+        remove_env: bool,
+    ) -> None:
+        self.__refresh_state()
+
+        completion_msg = Message(
+            title="Klipper Removal Process completed",
+            color=Color.GREEN,
+        )
+
+        if remove_service:
+            Logger.print_status("Removing Klipper instances ...")
+            if self.klipper_list:
+                instances_to_remove = self.__get_instances_to_remove()
+                self.__remove_instances(instances_to_remove)
+                if instances_to_remove:
+                    instance_names = [
+                        i.service_file_path.stem for i in instances_to_remove
+                    ]
+                    txt = f"● Klipper instances removed: {', '.join(instance_names)}"
+                    completion_msg.text.append(txt)
+            else:
+                Logger.print_info("No Klipper Services installed! Skipped ...")
+
+        if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
+            completion_msg.text = [
+                "Some Klipper services are still installed:",
+                f"● '{KLIPPER_DIR}' was not removed, even though selected for removal.",
+                f"● '{KLIPPER_ENV_DIR}' was not removed, even though selected for removal.",
+            ]
+        else:
+            if remove_dir:
+                Logger.print_status("Removing Klipper local repository ...")
+                if run_remove_routines(KLIPPER_DIR):
+                    completion_msg.text.append("● Klipper local repository removed")
+            if remove_env:
+                Logger.print_status("Removing Klipper Python environment ...")
+                if run_remove_routines(KLIPPER_ENV_DIR):
+                    completion_msg.text.append("● Klipper Python environment removed")
+
+        if completion_msg.text:
+            completion_msg.text.insert(0, "The following actions were performed:")
+        else:
+            completion_msg.color = Color.YELLOW
+            completion_msg.centered = True
+            completion_msg.text = ["Nothing to remove."]
+
+        self.msgsvc.set_message(completion_msg)
+
+    def __get_install_count_and_name_dict(self) -> Tuple[int, Dict[int, str]]:
+        install_count: int | None
+        if len(self.moonraker_list) > len(self.klipper_list):
+            install_count = len(self.moonraker_list)
+            name_dict = {
+                i: moonraker.suffix for i, moonraker in enumerate(self.moonraker_list)
+            }
+        else:
+            install_count = get_install_count()
+            name_dict = {
+                i: klipper.suffix for i, klipper in enumerate(self.klipper_list)
+            }
+
+            if install_count is None:
+                Logger.print_status(EXIT_KLIPPER_SETUP)
+                return 0, {}
+
+        return install_count, name_dict
+
+    def __run_setup(self, name_dict: Dict[int, str], create_example_cfg: bool) -> None:
+        if not self.klipper_list:
+            self.__install_deps()
+
+        for i in name_dict:
+            # skip this iteration if there is already an instance with the name
+            if name_dict[i] in [n.suffix for n in self.klipper_list]:
+                continue
+
+            instance = Klipper(suffix=name_dict[i])
+            instance.create()
+            InstanceManager.enable(instance)
+
+            if create_example_cfg:
+                # if a client-config is installed, include it in the new example cfg
+                clients = get_existing_clients()
+                create_example_printer_cfg(instance, clients)
+
+            InstanceManager.start(instance)
+
+        cmd_sysctl_manage("daemon-reload")
+
+        # step 4: check/handle conflicting packages/services
+        handle_disruptive_system_packages()
+
+        # step 5: check for required group membership
+        check_user_groups()
+
+    def __install_deps(self) -> None:
+        repo = self.settings.klipper.repo_url
+        branch = self.settings.klipper.branch
+
+        git_clone_wrapper(repo, KLIPPER_DIR, branch)
+
+        try:
+            install_klipper_packages()
+            if create_python_venv(KLIPPER_ENV_DIR):
+                install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
+        except Exception:
+            Logger.print_error("Error during installation of Klipper requirements!")
+            raise
+
+    def __display_moonraker_info(self) -> bool:
+        # todo: only show the klipper instances that are not already installed
+        Logger.print_dialog(
+            DialogType.INFO,
+            [
+                "Existing Moonraker instances detected:",
+                *[f"● {m.service_file_path.stem}" for m in self.moonraker_list],
+                "\n\n",
+                "The following Klipper instances will be installed:",
+                *[f"● klipper-{m.suffix}" for m in self.moonraker_list],
+            ],
+        )
+        _input: bool = get_confirm("Proceed with installation?")
+        return _input
+
+    def __handle_instance_names(
+        self, install_count: int, name_dict: Dict[int, str], custom_names: bool
+    ) -> None:
+        for i in range(install_count):  # 3
+            key: int = len(name_dict.keys()) + 1
+            if custom_names:
+                assign_custom_name(key, name_dict)
+            else:
+                name_dict[key] = str(len(name_dict) + 1)
+
+    def __use_custom_names_or_go_back(self) -> bool | None:
+        print_select_custom_name_dialog()
+        _input: bool | None = get_confirm(
+            "Assign custom names?",
+            False,
+            allow_go_back=True,
+        )
+        return _input
+
+    def __get_instances_to_remove(self) -> List[Klipper] | None:
+        start_index = 1
+        curr_instances: List[Klipper] = self.klipper_list
+        instance_count = len(curr_instances)
+
+        options = [str(i + start_index) for i in range(instance_count)]
+        options.extend(["a", "b"])
+        instance_map = {options[i]: self.klipper_list[i] for i in range(instance_count)}
+
+        print_instance_overview(
+            self.klipper_list,
+            start_index=start_index,
+            show_index=True,
+            show_select_all=True,
+        )
+        selection = get_selection_input("Select Klipper instance to remove", options)
+
+        if selection == "b":
+            return None
+        elif selection == "a":
+            return copy(self.klipper_list)
+
+        return [instance_map[selection]]
+
+    def __remove_instances(
+        self,
+        instance_list: List[Klipper] | None,
+    ) -> None:
+        if not instance_list:
+            return
+
+        for instance in instance_list:
+            Logger.print_status(
+                f"Removing instance {instance.service_file_path.stem} ..."
+            )
+            InstanceManager.remove(instance)
+            self.__delete_klipper_env_file(instance)
+
+        self.__refresh_state()
+
+    def __delete_klipper_env_file(self, instance: Klipper):
+        Logger.print_status(f"Remove '{instance.env_file}'")
+        if not instance.env_file.exists():
+            msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
+            Logger.print_info(msg)
+            return
+        run_remove_routines(instance.env_file)

kiauh/components/moonraker/moonraker_dialogs.py

@@ -48,7 +48,7 @@ def print_moonraker_overview(
     for i, k in enumerate(instance_map):
         mr_name = instance_map.get(k)
         m = f"<-> {mr_name}" if mr_name != "" else ""
-        line = Color.apply(f"{f'{i+1})' if show_index else '●'} {k} {m}", Color.CYAN)
+        line = Color.apply(f"{f'{i + 1})' if show_index else '●'} {k} {m}", Color.CYAN)
         dialog += f"║ {line:<63}║\n"
 
     warn_l1 = Color.apply("PLEASE NOTE:", Color.YELLOW)

kiauh/components/moonraker/moonraker_setup.py

@@ -29,7 +29,7 @@ from components.moonraker.moonraker import Moonraker
 from components.moonraker.moonraker_dialogs import print_moonraker_overview
 from components.moonraker.services.moonraker_instance_service import (
     MoonrakerInstanceService,
-    )
+)
 from components.moonraker.utils.sysdeps_parser import SysDepsParser
 from components.moonraker.utils.utils import (
     backup_moonraker_dir,
@@ -100,8 +100,9 @@ def install_moonraker() -> None:
             return
 
         if selected_option == "a":
-            new_inst_list: List[Moonraker] = (
-                [instance_service.create_new_instance(k.suffix) for k in klipper_list])
+            new_inst_list: List[Moonraker] = [
+                instance_service.create_new_instance(k.suffix) for k in klipper_list
+            ]
             new_instances.extend(new_inst_list)
         else:
             klipper_instance: Klipper | None = options.get(selected_option)
@@ -138,13 +139,17 @@ def install_moonraker() -> None:
             enable_mainsail_remotemode()
 
         instance_service.load_instances()
-        new_instances = [instance_service.get_instance_by_suffix(i.suffix) for i in
-                         new_instances]
+        new_instances = [
+            instance_service.get_instance_by_suffix(i.suffix) for i in new_instances
+        ]
 
         ip: str = get_ipv4_addr()
         # noinspection HttpUrlsUsage
-        url_list = [f"● {i.service_file_path.stem}: http://{ip}:{i.port}" for i in
-               new_instances if i.port]
+        url_list = [
+            f"● {i.service_file_path.stem}: http://{ip}:{i.port}"
+            for i in new_instances
+            if i.port
+        ]
         dialog_content = []
         if url_list:
             dialog_content.append("You can access Moonraker via the following URL:")
@@ -154,8 +159,8 @@ def install_moonraker() -> None:
             DialogType.CUSTOM,
             custom_title="Moonraker successfully installed!",
             custom_color=Color.GREEN,
-            content=dialog_content)
-
+            content=dialog_content,
+        )
 
     except Exception as e:
         Logger.print_error(f"Error while installing Moonraker: {e}")
@@ -194,7 +199,8 @@ def install_moonraker_packages() -> None:
     moonraker_deps = []
     if MOONRAKER_DEPS_JSON_FILE.exists():
         Logger.print_info(
-            f"Parsing system dependencies from {MOONRAKER_DEPS_JSON_FILE.name} ...")
+            f"Parsing system dependencies from {MOONRAKER_DEPS_JSON_FILE.name} ..."
+        )
         parser = SysDepsParser()
         sysdeps = load_sysdeps_json(MOONRAKER_DEPS_JSON_FILE)
         moonraker_deps.extend(parser.parse_dependencies(sysdeps))
@@ -202,7 +208,8 @@ def install_moonraker_packages() -> None:
     elif MOONRAKER_INSTALL_SCRIPT.exists():
         Logger.print_warn(f"{MOONRAKER_DEPS_JSON_FILE.name} not found!")
         Logger.print_info(
-            f"Parsing system dependencies from {MOONRAKER_INSTALL_SCRIPT.name} ...")
+            f"Parsing system dependencies from {MOONRAKER_INSTALL_SCRIPT.name} ..."
+        )
         moonraker_deps = parse_packages_from_file(MOONRAKER_INSTALL_SCRIPT)
 
     if not moonraker_deps:

kiauh/components/moonraker/services/moonraker_instance_service.py

@@ -1,3 +1,11 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
 from __future__ import annotations
 
 from typing import Dict, List

kiauh/components/moonraker/utils/sysdeps_parser.py

@@ -34,19 +34,23 @@ def _get_distro_info() -> Dict[str, Any]:
     return dict(
         distro_id=release_info.get("ID", ""),
         distro_version=release_info.get("VERSION_ID", ""),
-        aliases=release_info.get("ID_LIKE", "").split()
+        aliases=release_info.get("ID_LIKE", "").split(),
     )
 
+
 def _convert_version(version: str) -> Tuple[str | int, ...]:
     version = version.strip()
     ver_match = re.match(r"\d+(\.\d+)*((?:-|\.).+)?", version)
     if ver_match is not None:
-        return tuple([
-            int(part) if part.isdigit() else part
-            for part in re.split(r"\.|-", version)
-        ])
+        return tuple(
+            [
+                int(part) if part.isdigit() else part
+                for part in re.split(r"\.|-", version)
+            ]
+        )
     return (version,)
 
+
 class SysDepsParser:
     def __init__(self, distro_info: Dict[str, Any] | None = None) -> None:
         if distro_info is None:
@@ -86,14 +90,16 @@ class SysDepsParser:
                 if logical_op not in ("and", "or"):
                     logging.info(
                         f"Invalid logical operator {logical_op} in requirement "
-                        f"specifier: {full_spec}")
+                        f"specifier: {full_spec}"
+                    )
                     return None
                 last_logical_op = logical_op
                 continue
             elif last_logical_op is None:
                 logging.info(
                     f"Requirement specifier contains two seqential expressions "
-                    f"without a logical operator: {full_spec}")
+                    f"without a logical operator: {full_spec}"
+                )
                 return None
             dep_parts = re.split(r"(==|!=|<=|>=|<|>)", exp.strip())
             req_var = dep_parts[0].strip().lower()
@@ -123,7 +129,7 @@ class SysDepsParser:
                     "==": lambda x, y: x == y,
                     "!=": lambda x, y: x != y,
                     ">=": lambda x, y: x >= y,
-                    "<=": lambda x, y: x <= y
+                    "<=": lambda x, y: x <= y,
                 }.get(operator, lambda x, y: False)
                 result = compfunc(left_op, right_op)
                 if last_logical_op == "and":

kiauh/components/moonraker/utils/utils.py

@@ -140,6 +140,7 @@ def backup_moonraker_db_dir() -> None:
             name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
         )
 
+
 def load_sysdeps_json(file: Path) -> Dict[str, List[str]]:
     try:
         sysdeps: Dict[str, List[str]] = json.loads(file.read_bytes())

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -57,7 +57,7 @@ class ClientRemoveMenu(BaseMenu):
         o1 = checked if self.remove_client else unchecked
         o2 = checked if self.remove_client_cfg else unchecked
         o3 = checked if self.backup_config_json else unchecked
-        sel_state = f"{'Select'if not self.select_state else 'Deselect'} everything"
+        sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
         menu = textwrap.dedent(
             f"""
             ╟───────────────────────────────────────────────────────╢

kiauh/core/backup_manager/backup_manager.py

@@ -86,7 +86,12 @@ class BackupManager:
             date = get_current_date().get("date")
             time = get_current_date().get("time")
             backup_target = target.joinpath(f"{name.lower()}-{date}-{time}")
-            shutil.copytree(source, backup_target, ignore=self.ignore_folders_func, ignore_dangling_symlinks=True)
+            shutil.copytree(
+                source,
+                backup_target,
+                ignore=self.ignore_folders_func,
+                ignore_dangling_symlinks=True,
+            )
             Logger.print_ok("Backup successful!")
 
             return backup_target

kiauh/core/logger.py

@@ -33,6 +33,7 @@ BORDER_TITLE: str = "┠──────────────────
 BORDER_LEFT: str = "┃"
 BORDER_RIGHT: str = "┃"
 
+
 class Logger:
     @staticmethod
     def print_info(msg, prefix=True, start="", end="\n") -> None:
@@ -99,12 +100,14 @@ class Logger:
             print(Color.apply(BORDER_TITLE, color))
 
         if content:
-            print(Logger.format_content(
-                content,
-                LINE_WIDTH,
-                color,
-                center_content,
-                ))
+            print(
+                Logger.format_content(
+                    content,
+                    LINE_WIDTH,
+                    color,
+                    center_content,
+                )
+            )
 
         print(Color.apply(BORDER_BOTTOM, color))
 

kiauh/core/menus/install_menu.py

@@ -12,7 +12,7 @@ import textwrap
 from typing import Type
 
 from components.crowsnest.crowsnest import install_crowsnest
-from components.klipper import klipper_setup
+from components.klipper.services.klipper_setup_service import KlipperSetupService
 from components.klipperscreen.klipperscreen import install_klipperscreen
 from components.moonraker import moonraker_setup
 from components.webui_client.client_config.client_config_setup import (
@@ -36,6 +36,7 @@ class InstallMenu(BaseMenu):
         self.title = "Installation Menu"
         self.title_color = Color.GREEN
         self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.klsvc = KlipperSetupService()
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
@@ -75,7 +76,7 @@ class InstallMenu(BaseMenu):
         print(menu, end="")
 
     def install_klipper(self, **kwargs) -> None:
-        klipper_setup.install_klipper()
+        self.klsvc.install()
 
     def install_moonraker(self, **kwargs) -> None:
         moonraker_setup.install_moonraker()

kiauh/core/menus/settings_menu.py

@@ -40,7 +40,6 @@ class SettingsMenu(BaseMenu):
         self._load_settings()
         print(self.klipper_status)
 
-
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
@@ -122,18 +121,24 @@ class SettingsMenu(BaseMenu):
             self.moonraker_status.owner = url_parts[-2]
             self.moonraker_status.branch = self.settings.moonraker.branch
 
-    def _gather_input(self, repo_name: Literal["klipper", "moonraker"], repo_dir: Path) -> Tuple[str, str]:
+    def _gather_input(
+        self, repo_name: Literal["klipper", "moonraker"], repo_dir: Path
+    ) -> Tuple[str, str]:
         warn_msg = [
             "There is only basic input validation in place! "
-            "Make sure your the input is valid and has no typos or invalid characters!"]
+            "Make sure your the input is valid and has no typos or invalid characters!"
+        ]
 
         if repo_dir.exists():
-            warn_msg.extend([
-                "For the change to take effect, the new repository will be cloned. "
-                "A backup of the old repository will be created.",
-                "\n\n",
-                "Make sure you don't have any ongoing prints running, as the services "
-                "will be restarted during this process! You will loose any ongoing print!"])
+            warn_msg.extend(
+                [
+                    "For the change to take effect, the new repository will be cloned. "
+                    "A backup of the old repository will be created.",
+                    "\n\n",
+                    "Make sure you don't have any ongoing prints running, as the services "
+                    "will be restarted during this process! You will loose any ongoing print!",
+                ]
+            )
 
         Logger.print_dialog(DialogType.ATTENTION, warn_msg)
 
@@ -143,14 +148,14 @@ class SettingsMenu(BaseMenu):
             default=KLIPPER_REPO_URL if repo_name == "klipper" else MOONRAKER_REPO_URL,
         )
         branch = get_string_input(
-            "Enter new branch name",
-            regex=r"^.+$",
-            default="master"
+            "Enter new branch name", regex=r"^.+$", default="master"
         )
 
         return repo, branch
 
-    def _set_repo(self, repo_name: Literal["klipper", "moonraker"], repo_dir: Path) -> None:
+    def _set_repo(
+        self, repo_name: Literal["klipper", "moonraker"], repo_dir: Path
+    ) -> None:
         repo_url, branch = self._gather_input(repo_name, repo_dir)
         display_name = repo_name.capitalize()
         Logger.print_dialog(
@@ -180,11 +185,15 @@ class SettingsMenu(BaseMenu):
 
         self._switch_repo(repo_name, repo_dir)
 
-    def _switch_repo(self, name: Literal["klipper", "moonraker"], repo_dir: Path ) -> None:
+    def _switch_repo(
+        self, name: Literal["klipper", "moonraker"], repo_dir: Path
+    ) -> None:
         if not repo_dir.exists():
             return
 
-        Logger.print_status(f"Switching to {name.capitalize()}'s new source repository ...")
+        Logger.print_status(
+            f"Switching to {name.capitalize()}'s new source repository ..."
+        )
 
         repo: RepoSettings = self.settings[name]
         run_switch_repo_routine(name, repo)

kiauh/core/menus/update_menu.py

@@ -12,10 +12,10 @@ import textwrap
 from typing import Callable, List, Type
 
 from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
-from components.klipper.klipper_setup import update_klipper
 from components.klipper.klipper_utils import (
     get_klipper_status,
 )
+from components.klipper.services.klipper_setup_service import KlipperSetupService
 from components.klipperscreen.klipperscreen import (
     get_klipperscreen_status,
     update_klipperscreen,
@@ -193,7 +193,8 @@ class UpdateMenu(BaseMenu):
         self.upgrade_system_packages()
 
     def update_klipper(self, **kwargs) -> None:
-        self._run_update_routine("klipper", update_klipper)
+        klsvc = KlipperSetupService()
+        self._run_update_routine("klipper", klsvc.update)
 
     def update_moonraker(self, **kwargs) -> None:
         self._run_update_routine("moonraker", update_moonraker)

kiauh/core/services/message_service.py

@@ -6,6 +6,7 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 from dataclasses import dataclass, field
 from typing import List
@@ -23,12 +24,13 @@ class Message:
 
 
 class MessageService:
-    _instance = None
+    __cls_instance = None
+    __message: Message | None
 
     def __new__(cls) -> "MessageService":
-        if cls._instance is None:
-            cls._instance = super(MessageService, cls).__new__(cls)
-        return cls._instance
+        if cls.__cls_instance is None:
+            cls.__cls_instance = super(MessageService, cls).__new__(cls)
+        return cls.__cls_instance
 
     def __init__(self) -> None:
         if not hasattr(self, "__initialized"):
@@ -36,24 +38,24 @@ class MessageService:
         if self.__initialized:
             return
         self.__initialized = True
-        self.message = None
+        self.__message = None
 
     def set_message(self, message: Message) -> None:
-        self.message = message
+        self.__message = message
 
     def display_message(self) -> None:
-        if self.message is None:
+        if self.__message is None:
             return
 
         Logger.print_dialog(
             title=DialogType.CUSTOM,
-            content=self.message.text,
-            custom_title=self.message.title,
-            custom_color=self.message.color,
-            center_content=self.message.centered,
+            content=self.__message.text,
+            custom_title=self.__message.title,
+            custom_color=self.__message.color,
+            center_content=self.__message.centered,
         )
 
         self.__clear_message()
 
     def __clear_message(self) -> None:
-        self.message = None
+        self.__message = None

kiauh/extensions/klipper_backup/klipper_backup_extension.py

@@ -10,11 +10,11 @@
 # ======================================================================= #
 
 import os
-import shutil
 import subprocess
+from pathlib import Path
+
 from core.constants import SYSTEMD
 from core.logger import Logger
-from pathlib import Path
 from extensions.base_extension import BaseExtension
 from extensions.klipper_backup import (
     KLIPPERBACKUP_CONFIG_DIR,
@@ -29,7 +29,6 @@ from utils.sys_utils import cmd_sysctl_manage, remove_system_service, unit_file_
 
 
 class KlipperbackupExtension(BaseExtension):
-
     def remove_extension(self, **kwargs) -> None:
         if not check_file_exist(KLIPPERBACKUP_DIR):
             Logger.print_info("Extension does not seem to be installed! Skipping ...")
@@ -48,29 +47,44 @@ class KlipperbackupExtension(BaseExtension):
                     cmd_sysctl_manage("daemon-reload")
                     cmd_sysctl_manage("reset-failed")
                 else:
-                    Logger.print_error(f"Unknown unit type {unit_type} of {full_service_name}")
+                    Logger.print_error(
+                        f"Unknown unit type {unit_type} of {full_service_name}"
+                    )
             except:
                 Logger.print_error(f"Failed to remove {full_service_name}: {str(e)}")
 
         def check_crontab_entry(entry) -> bool:
             try:
-                crontab_content = subprocess.check_output(["crontab", "-l"], stderr=subprocess.DEVNULL, text=True)
+                crontab_content = subprocess.check_output(
+                    ["crontab", "-l"], stderr=subprocess.DEVNULL, text=True
+                )
             except subprocess.CalledProcessError:
                 return False
             return any(entry in line for line in crontab_content.splitlines())
 
         def remove_moonraker_entry():
             original_file_path = MOONRAKER_CONF
-            comparison_file_path = os.path.join(str(KLIPPERBACKUP_DIR), "install-files", "moonraker.conf")
-            if not (os.path.exists(original_file_path) and os.path.exists(comparison_file_path)):
+            comparison_file_path = os.path.join(
+                str(KLIPPERBACKUP_DIR), "install-files", "moonraker.conf"
+            )
+            if not (
+                os.path.exists(original_file_path)
+                and os.path.exists(comparison_file_path)
+            ):
                 return False
-            with open(original_file_path, "r") as original_file, open(comparison_file_path, "r") as comparison_file:
+            with open(original_file_path, "r") as original_file, open(
+                comparison_file_path, "r"
+            ) as comparison_file:
                 original_content = original_file.read()
                 comparison_content = comparison_file.read()
             if comparison_content in original_content:
                 Logger.print_status("Removing Klipper-Backup moonraker entry ...")
-                modified_content = original_content.replace(comparison_content, "").strip()
-                modified_content = "\n".join(line for line in modified_content.split("\n") if line.strip())
+                modified_content = original_content.replace(
+                    comparison_content, ""
+                ).strip()
+                modified_content = "\n".join(
+                    line for line in modified_content.split("\n") if line.strip()
+                )
                 with open(original_file_path, "w") as original_file:
                     original_file.write(modified_content)
                 Logger.print_ok("Klipper-Backup moonraker entry successfully removed!")
@@ -79,7 +93,11 @@ class KlipperbackupExtension(BaseExtension):
 
         if get_confirm("Do you really want to remove the extension?", True, False):
             # Remove systemd timer and services
-            service_names = ["klipper-backup-on-boot", "klipper-backup-filewatch", "klipper-backup"]
+            service_names = [
+                "klipper-backup-on-boot",
+                "klipper-backup-filewatch",
+                "klipper-backup",
+            ]
             unit_types = ["timer", "service"]
 
             for service_name in service_names:
@@ -91,10 +109,23 @@ class KlipperbackupExtension(BaseExtension):
             try:
                 if check_crontab_entry("/klipper-backup/script.sh"):
                     Logger.print_status("Removing Klipper-Backup crontab entry ...")
-                    crontab_content = subprocess.check_output(["crontab", "-l"], text=True)
-                    modified_content = "\n".join(line for line in crontab_content.splitlines() if "/klipper-backup/script.sh" not in line)
-                    subprocess.run(["crontab", "-"], input=modified_content + "\n", text=True, check=True)
-                    Logger.print_ok("Klipper-Backup crontab entry successfully removed!")
+                    crontab_content = subprocess.check_output(
+                        ["crontab", "-l"], text=True
+                    )
+                    modified_content = "\n".join(
+                        line
+                        for line in crontab_content.splitlines()
+                        if "/klipper-backup/script.sh" not in line
+                    )
+                    subprocess.run(
+                        ["crontab", "-"],
+                        input=modified_content + "\n",
+                        text=True,
+                        check=True,
+                    )
+                    Logger.print_ok(
+                        "Klipper-Backup crontab entry successfully removed!"
+                    )
             except subprocess.CalledProcessError:
                 Logger.print_error("Unable to remove the Klipper-Backup cron entry")
 
@@ -102,7 +133,9 @@ class KlipperbackupExtension(BaseExtension):
             try:
                 remove_moonraker_entry()
             except:
-                Logger.print_error("Unable to remove the Klipper-Backup moonraker entry")
+                Logger.print_error(
+                    "Unable to remove the Klipper-Backup moonraker entry"
+                )
 
             # Remove Klipper-backup extension
             Logger.print_status("Removing Klipper-Backup extension ...")
@@ -112,7 +145,7 @@ class KlipperbackupExtension(BaseExtension):
                     remove_with_sudo(KLIPPERBACKUP_CONFIG_DIR)
                 Logger.print_ok("Extension Klipper-Backup successfully removed!")
             except:
-                Logger.print_error(f"Unable to remove Klipper-Backup extension")
+                Logger.print_error("Unable to remove Klipper-Backup extension")
 
     def install_extension(self, **kwargs) -> None:
         if not KLIPPERBACKUP_DIR.exists():

kiauh/extensions/obico/moonraker_obico_extension.py

@@ -11,8 +11,8 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
-from core.instance_manager.instance_manager import InstanceManager
 from core.instance_manager.base_instance import SUFFIX_BLACKLIST
+from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
@@ -309,8 +309,12 @@ class ObicoExtension(BaseExtension):
     def _check_and_opt_link_instances(self) -> None:
         Logger.print_status("Checking link status of Obico instances ...")
 
-        suffix_blacklist: List[str] = [suffix for suffix in SUFFIX_BLACKLIST if suffix != 'obico']
-        ob_instances: List[MoonrakerObico] = get_instances(MoonrakerObico, suffix_blacklist=suffix_blacklist)
+        suffix_blacklist: List[str] = [
+            suffix for suffix in SUFFIX_BLACKLIST if suffix != "obico"
+        ]
+        ob_instances: List[MoonrakerObico] = get_instances(
+            MoonrakerObico, suffix_blacklist=suffix_blacklist
+        )
         unlinked_instances: List[MoonrakerObico] = [
             obico for obico in ob_instances if not obico.is_linked
         ]

kiauh/extensions/octoapp/octoapp.py

@@ -45,9 +45,7 @@ class Octoapp:
         self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
         self.base.log_file_name = self.log_file_name
 
-        self.service_file_path: Path = get_service_file_path(
-            Octoapp, self.suffix
-        )
+        self.service_file_path: Path = get_service_file_path(Octoapp, self.suffix)
         self.store_dir = self.base.data_dir.joinpath("store")
         self.cfg_file = self.base.cfg_dir.joinpath(OA_CFG_NAME)
         self.sys_cfg_file = self.base.cfg_dir.joinpath(OA_SYS_CFG_NAME)

kiauh/extensions/octoapp/octoapp_extension.py

@@ -9,8 +9,8 @@
 import json
 from typing import List
 
-from components.moonraker.moonraker import Moonraker
 from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
 from extensions.base_extension import BaseExtension
@@ -107,9 +107,7 @@ class OctoappExtension(BaseExtension):
             )
 
         except Exception as e:
-            Logger.print_error(
-                f"Error during OctoApp for Klipper installation:\n{e}"
-            )
+            Logger.print_error(f"Error during OctoApp for Klipper installation:\n{e}")
 
     def update_extension(self, **kwargs) -> None:
         Logger.print_status("Updating OctoApp for Klipper ...")
@@ -183,7 +181,6 @@ class OctoappExtension(BaseExtension):
 
         run_remove_routines(OA_DIR)
 
-
     def _remove_OA_store_dirs(self) -> None:
         Logger.print_status("Removing OctoApp for Klipper store directory ...")
 
@@ -197,7 +194,6 @@ class OctoappExtension(BaseExtension):
 
             run_remove_routines(store_dir)
 
-
     def _remove_OA_env(self) -> None:
         Logger.print_status("Removing OctoApp for Klipper environment ...")
 

kiauh/extensions/telegram_bot/moonraker_telegram_bot.py

@@ -116,10 +116,7 @@ class MoonrakerTelegramBot:
             "%TELEGRAM_BOT_DIR%",
             self.bot_dir.as_posix(),
         )
-        env_file_content = env_file_content.replace(
-            "%CFG%",
-            self.cfg_file.as_posix()
-        )
+        env_file_content = env_file_content.replace("%CFG%", self.cfg_file.as_posix())
         env_file_content = env_file_content.replace(
             "%LOG%",
             self.base.log_dir.joinpath(self.log_file_name).as_posix(),

kiauh/procedures/switch_repo.py

@@ -19,7 +19,7 @@ from components.klipper import (
     KLIPPER_REQ_FILE,
 )
 from components.klipper.klipper import Klipper
-from components.klipper.klipper_setup import install_klipper_packages
+from components.klipper.klipper_utils import install_klipper_packages
 from components.moonraker import (
     MOONRAKER_BACKUP_DIR,
     MOONRAKER_DIR,

kiauh/utils/common.py

@@ -192,5 +192,5 @@ def moonraker_exists(name: str = "") -> List[Moonraker]:
 
 def trunc_string(input_str: str, length: int) -> str:
     if len(input_str) > length:
-        return f"{input_str[:length - 3]}..."
+        return f"{input_str[: length - 3]}..."
     return input_str

kiauh/utils/fs_utils.py

@@ -10,6 +10,7 @@
 # ======================================================================= #
 from __future__ import annotations
 
+import os
 import re
 import shutil
 from pathlib import Path
@@ -29,15 +30,15 @@ def check_file_exist(file_path: Path, sudo=False) -> bool:
     :return: True, if file exists, otherwise False
     """
     if sudo:
+        command = ["sudo", "find", file_path.as_posix()]
         try:
-            command = ["sudo", "find", file_path.as_posix()]
             check_output(command, stderr=DEVNULL)
             return True
         except CalledProcessError:
             return False
     else:
-        if file_path.exists():
-            return True
+        if os.access(file_path, os.F_OK):
+            return file_path.exists()
         else:
             return False
 

kiauh/utils/git_utils.py

@@ -132,8 +132,10 @@ def get_local_tags(repo_path: Path, _filter: str | None = None) -> List[str]:
 
         tags: List[str] = result.split("\n")[:-1]
 
-        return sorted(tags, key=lambda x: [int(i) if i.isdigit() else i for i in
-                                                re.split(r'(\d+)', x)])
+        return sorted(
+            tags,
+            key=lambda x: [int(i) if i.isdigit() else i for i in re.split(r"(\d+)", x)],
+        )
 
     except CalledProcessError:
         return []

kiauh/utils/instance_utils.py

@@ -17,7 +17,9 @@ from core.instance_manager.base_instance import SUFFIX_BLACKLIST
 from utils.instance_type import InstanceType
 
 
-def get_instances(instance_type: type, suffix_blacklist: List[str] = SUFFIX_BLACKLIST) -> List[InstanceType]:
+def get_instances(
+    instance_type: type, suffix_blacklist: List[str] = SUFFIX_BLACKLIST
+) -> List[InstanceType]:
     from utils.common import convert_camelcase_to_kebabcase
 
     if not isinstance(instance_type, type):

pyproject.toml

@@ -5,12 +5,13 @@ requires-python = ">=3.8"
 dev=["ruff", "mypy"]
 
 [tool.ruff]
-required-version = ">=0.3.4"
+required-version = ">=0.9.10"
 respect-gitignore = true
-exclude = [".git",".github", "./docs"]
+exclude = [".git",".github", "./docs", "kiauh/core/submodules"]
 line-length = 88
 indent-width = 4
 output-format = "full"
+target-version = "py38"
 
 [tool.ruff.format]
 indent-style = "space"