From ea8621af0cf3f73c0a3d21a986cb2a8a605687fd Mon Sep 17 00:00:00 2001 From: dw-0 Date: Sat, 29 Mar 2025 16:49:08 +0100 Subject: [PATCH] refactor(git_utils): remove unnecessary url parameter in `git_pull_wrapper` Signed-off-by: Dominik Willner --- kiauh/components/crowsnest/crowsnest.py | 4 ++-- kiauh/components/klipper/services/klipper_setup_service.py | 2 +- kiauh/components/klipperscreen/klipperscreen.py | 2 +- kiauh/components/moonraker/moonraker_setup.py | 2 +- .../webui_client/client_config/client_config_setup.py | 2 +- kiauh/extensions/mobileraker/mobileraker_extension.py | 2 +- kiauh/extensions/obico/moonraker_obico_extension.py | 2 +- kiauh/extensions/pretty_gcode/pretty_gcode_extension.py | 2 +- .../telegram_bot/moonraker_telegram_bot_extension.py | 2 +- kiauh/utils/git_utils.py | 7 ++----- 10 files changed, 12 insertions(+), 15 deletions(-) diff --git a/kiauh/components/crowsnest/crowsnest.py b/kiauh/components/crowsnest/crowsnest.py index bf8ae2e..516f63f 100644 --- a/kiauh/components/crowsnest/crowsnest.py +++ b/kiauh/components/crowsnest/crowsnest.py @@ -72,7 +72,7 @@ def install_crowsnest() -> None: Logger.print_info("Installer will prompt you for sudo password!") try: run( - f"sudo make install", + "sudo make install", cwd=CROWSNEST_DIR, shell=True, check=True, @@ -134,7 +134,7 @@ def update_crowsnest() -> None: target=CROWSNEST_BACKUP_DIR, ) - git_pull_wrapper(CROWSNEST_REPO, CROWSNEST_DIR) + git_pull_wrapper(CROWSNEST_DIR) deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT) check_install_dependencies({*deps}) diff --git a/kiauh/components/klipper/services/klipper_setup_service.py b/kiauh/components/klipper/services/klipper_setup_service.py index a475fca..d390b86 100644 --- a/kiauh/components/klipper/services/klipper_setup_service.py +++ b/kiauh/components/klipper/services/klipper_setup_service.py @@ -162,7 +162,7 @@ class KlipperSetupService: backup_klipper_dir() InstanceManager.stop_all(self.klipper_list) - git_pull_wrapper("", KLIPPER_DIR) + git_pull_wrapper(KLIPPER_DIR) install_klipper_packages() install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE) InstanceManager.start_all(self.klipper_list) diff --git a/kiauh/components/klipperscreen/klipperscreen.py b/kiauh/components/klipperscreen/klipperscreen.py index 0ba3883..a73f87a 100644 --- a/kiauh/components/klipperscreen/klipperscreen.py +++ b/kiauh/components/klipperscreen/klipperscreen.py @@ -126,7 +126,7 @@ def update_klipperscreen() -> None: if settings.kiauh.backup_before_update: backup_klipperscreen_dir() - git_pull_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR) + git_pull_wrapper(KLIPPERSCREEN_DIR) install_python_requirements(KLIPPERSCREEN_ENV_DIR, KLIPPERSCREEN_REQ_FILE) diff --git a/kiauh/components/moonraker/moonraker_setup.py b/kiauh/components/moonraker/moonraker_setup.py index 283df45..8752486 100644 --- a/kiauh/components/moonraker/moonraker_setup.py +++ b/kiauh/components/moonraker/moonraker_setup.py @@ -261,7 +261,7 @@ def update_moonraker() -> None: instances = get_instances(Moonraker) InstanceManager.stop_all(instances) - git_pull_wrapper("", target_dir=MOONRAKER_DIR) + git_pull_wrapper(MOONRAKER_DIR) # install possible new system packages install_moonraker_packages() diff --git a/kiauh/components/webui_client/client_config/client_config_setup.py b/kiauh/components/webui_client/client_config/client_config_setup.py index f1f46cd..9d31fdb 100644 --- a/kiauh/components/webui_client/client_config/client_config_setup.py +++ b/kiauh/components/webui_client/client_config/client_config_setup.py @@ -106,7 +106,7 @@ def update_client_config(client: BaseWebClient) -> None: if settings.kiauh.backup_before_update: backup_client_config_data(client) - git_pull_wrapper(client_config.repo_url, client_config.config_dir) + git_pull_wrapper(client_config.config_dir) Logger.print_ok(f"Successfully updated {client_config.display_name}.") Logger.print_info("Restart Klipper to reload the configuration!") diff --git a/kiauh/extensions/mobileraker/mobileraker_extension.py b/kiauh/extensions/mobileraker/mobileraker_extension.py index 8095ddc..a584105 100644 --- a/kiauh/extensions/mobileraker/mobileraker_extension.py +++ b/kiauh/extensions/mobileraker/mobileraker_extension.py @@ -104,7 +104,7 @@ class MobilerakerExtension(BaseExtension): if settings.kiauh.backup_before_update: self._backup_mobileraker_dir() - git_pull_wrapper(MOBILERAKER_REPO, MOBILERAKER_DIR) + git_pull_wrapper(MOBILERAKER_DIR) install_python_requirements(MOBILERAKER_ENV_DIR, MOBILERAKER_REQ_FILE) diff --git a/kiauh/extensions/obico/moonraker_obico_extension.py b/kiauh/extensions/obico/moonraker_obico_extension.py index e0bd009..82f92b2 100644 --- a/kiauh/extensions/obico/moonraker_obico_extension.py +++ b/kiauh/extensions/obico/moonraker_obico_extension.py @@ -145,7 +145,7 @@ class ObicoExtension(BaseExtension): instances = get_instances(MoonrakerObico) InstanceManager.stop_all(instances) - git_pull_wrapper(OBICO_REPO, OBICO_DIR) + git_pull_wrapper(OBICO_DIR) self._install_dependencies() InstanceManager.start_all(instances) diff --git a/kiauh/extensions/pretty_gcode/pretty_gcode_extension.py b/kiauh/extensions/pretty_gcode/pretty_gcode_extension.py index 45ab1af..732b013 100644 --- a/kiauh/extensions/pretty_gcode/pretty_gcode_extension.py +++ b/kiauh/extensions/pretty_gcode/pretty_gcode_extension.py @@ -78,7 +78,7 @@ class PrettyGcodeExtension(BaseExtension): def update_extension(self, **kwargs) -> None: Logger.print_status("Updating PrettyGCode for Klipper ...") try: - git_pull_wrapper(PGC_REPO, PGC_DIR) + git_pull_wrapper(PGC_DIR) except Exception as e: Logger.print_error(f"Error during PrettyGCode for Klipper update: {e}") diff --git a/kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py b/kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py index 7793325..458b3e8 100644 --- a/kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py +++ b/kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py @@ -135,7 +135,7 @@ class TelegramBotExtension(BaseExtension): instances = get_instances(MoonrakerTelegramBot) InstanceManager.stop_all(instances) - git_pull_wrapper(TG_BOT_REPO, TG_BOT_DIR) + git_pull_wrapper(TG_BOT_DIR) self._install_dependencies() InstanceManager.start_all(instances) diff --git a/kiauh/utils/git_utils.py b/kiauh/utils/git_utils.py index 2f49a1c..857c0ad 100644 --- a/kiauh/utils/git_utils.py +++ b/kiauh/utils/git_utils.py @@ -58,17 +58,14 @@ def git_clone_wrapper( raise GitException(f"Error removing existing repository: {e.strerror}") -# !todo: remove url parameter, as it is not really required. may be a reason to remove this function completely -def git_pull_wrapper(url: str, target_dir: Path) -> None: +def git_pull_wrapper(target_dir: Path) -> None: """ A function that updates a repository using git pull. - :param url: The repo url - only used for logging. :param target_dir: The directory of the repository. :return: None """ - _repo = f"'{url}'" if url else "" - Logger.print_status(f"Updating repository {_repo}...") + Logger.print_status("Updating repository ...") try: git_cmd_pull(target_dir) except CalledProcessError: