Improve logging and docstrings

Author: tsterbak

openandroidinstaller/openandroidinstaller.py

@@ -57,7 +57,6 @@
 
 
 PLATFORM = sys.platform
-logger.info(f"Running OpenAndroidInstaller on {PLATFORM}")
 # Define asset paths
 CONFIG_PATH = Path(__file__).parent.joinpath(Path("assets/configs")).resolve()
 IMAGE_PATH = Path(__file__).parent.joinpath(Path("assets/imgs")).resolve()
@@ -228,6 +227,7 @@ def search_devices(self, e):
                 # select a new path and load again
                 pass
         except CalledProcessError:
+            logger.info(f"Did not detect a device.")
             if DEVELOPMENT:
                 path = CONFIG_PATH.joinpath(Path(f"{DEVELOPMENT_CONFIG}.yaml"))
                 load_config_success = self.load_config(path)
@@ -344,7 +344,7 @@ def build(
 
 
 class MainView(UserControl):
-    def __init__(self, page: Page):
+    def __init__(self):
         super().__init__()
         self.config = None
         # initialize the progress bar indicator
@@ -427,22 +427,27 @@ def load_config(self, path: str):
         try:
             self.config = InstallerConfig.from_file(path)
             self.num_total_steps = len(self.config.steps)
+            logger.info(f"Loaded device config from {path}.")
+            logger.info(f"Config metadata: {self.config.metadata}.")
             return self.config.metadata.get("devicename", "No device name in config.")
         except FileNotFoundError:
+            logger.info(f"No device config found for {path}.")
             return False
 
     def pick_image_result(self, e: FilePickerResultEvent):
         self.selected_image.value = (
             ", ".join(map(lambda f: f.name, e.files)) if e.files else "Cancelled!"
         )
         self.image_path = e.files[0].path
+        logger.info(f"Selected image from {self.image_path}")
         self.selected_image.update()
 
     def pick_recovery_result(self, e: FilePickerResultEvent):
         self.selected_recovery.value = (
             ", ".join(map(lambda f: f.name, e.files)) if e.files else "Cancelled!"
         )
         self.recovery_path = e.files[0].path
+        logger.info(f"Selected recovery from {self.recovery_path}")
         self.selected_recovery.update()
 
 
@@ -500,7 +505,11 @@ def build(self):
         return self.view
 
     def call_to_phone(self, e, command: str):
-        # TODO: use proper windows paths
+        """
+        Run the command given on the phone.
+        
+        Some parts of the command are changed by placeholders.
+        """
         command = command.replace("adb", str(BIN_PATH.joinpath(Path("adb"))))
         command = command.replace("fastboot", str(BIN_PATH.joinpath(Path("fastboot"))))
         command = command.replace("heimdall", str(BIN_PATH.joinpath(Path("heimdall"))))
@@ -518,6 +527,7 @@ def call_to_phone(self, e, command: str):
         logger.info(f"Run command: {command}")
         res = call(f"{command}", shell=True)
         if res != 0:
+            logger.info(f"Command {command} failed.")
             self.right_view.controls.pop()
             self.right_view.controls.append(Text("Command {command} failed!"))
         else:
@@ -526,10 +536,12 @@ def call_to_phone(self, e, command: str):
             self.right_view.controls.append(
                 ElevatedButton("Confirm and continue", on_click=self.on_confirm)
             )
+            logger.info("Success.")
         self.view.update()
 
 
 def main(page: Page):
+    logger.info(f"Running OpenAndroidInstaller on {PLATFORM}")
     # Configure the application base page
     page.title = "OpenAndroidInstaller"
     page.window_height = 720
@@ -581,11 +593,10 @@ def close_banner(e):
     )
     # TODO: disable the banner for now
     # page.banner.open = True
-
-    page.update()
+    # page.update()
 
     # create application instance
-    app = MainView(page)
+    app = MainView()
 
     # add application's root control to the page
     page.add(app)

openandroidinstaller/widgets.py

@@ -38,6 +38,7 @@ def get_title(title: str):
 def confirm_button(
     text: str, confirm_func: Callable, confirm_text: str = "Confirm and continue"
 ) -> Column:
+    """Get a button, that calls a given function when clicked."""
     return Column(
         [
             Text(f"{text}"),
@@ -59,6 +60,7 @@ def confirm_button(
 def call_button(
     text: str, call_func: Callable, command: str, confirm_text: str = "Confirm and run"
 ) -> Column:
+    """Get a button, that calls a given function with given command when clicked."""
     return Column(
         [
             Text(f"{text}"),

poetry.lock

@@ -6,9 +6,13 @@
 from pathlib import Path
 import zipfile
 from io import BytesIO
+from loguru import logger
+import click
 
 
 def download_adb_fastboot(platform: str):
+    """Download adb and fastboot executable from dl.google.com, extract the zip and save to file."""
+    logger.info(f"Download adb and fastboot for {platform}...")
     url = f"https://dl.google.com/android/repository/platform-tools-latest-{platform}.zip"
     # Downloading the file by sending the request to the URL
     response = requests.get(url, allow_redirects=True)
@@ -19,10 +23,12 @@ def download_adb_fastboot(platform: str):
     download_path = Path(__file__).parent.joinpath(Path("tools")).resolve()
     file = zipfile.ZipFile(BytesIO(response.content))
     file.extractall(download_path.name)
-    return filename 
+    logger.info("DONE.")
 
 
 def download_heimdall(platform: str):
+    """Download heimdall executable from ubuntu.com, extract the zip and save to file."""
+    logger.info(f"Download heimdall for {platform}...")
     url = f"https://people.ubuntu.com/~neothethird/heimdall-{platform}.zip"
     # Downloading the file by sending the request to the URL
     response = requests.get(url, allow_redirects=True)
@@ -33,12 +39,13 @@ def download_heimdall(platform: str):
     download_path = Path(__file__).parent.joinpath(Path("heimdall")).resolve()
     file = zipfile.ZipFile(BytesIO(response.content))
     file.extractall(download_path.name)
-    return filename 
-
+    logger.info("DONE.")
 
 
 def move_files_to_lib():
+    """Move files to the expected path in the openandroidinstaller package."""
     target_path = Path("openandroidinstaller/bin", exist_ok=True)
+    logger.info(f"Move executables to {target_path}...")
     target_path.mkdir()
     # move adb
     adb_path = Path(__file__).parent.joinpath(Path("../tools/platform-tools/adb")).resolve()
@@ -52,17 +59,19 @@ def move_files_to_lib():
     hd_path = Path(__file__).parent.joinpath(Path("../heimdall/heimdall")).resolve()
     hd_target_path = Path(__file__).parent.joinpath(Path("../openandroidinstaller/bin/heimdall")).resolve()
     hd_path.rename(hd_target_path)
+    logger.info("DONE.")
     # make executable
+    logger.info("Allow the executables to be executed.")
     adb_target_path.chmod(0o755)
     fb_target_path.chmod(0o755)
     hd_target_path.chmod(0o755)
-    print("Done")
+    logger.info("DONE.")
 
-
-def main():
-    filename = download_adb_fastboot(platform="linux")
-    print(filename)
-    filename = download_heimdall(platform="linux")
+@click.command()
+@click.option("--platform", help="On which platform should the tools work?", default="linux")
+def main(platform: str):
+    download_adb_fastboot(platform=platform)
+    download_heimdall(platform=platform)
     move_files_to_lib()