IMPROVEMENT: Refractor more code out of backend_filesystem.py

Author: amilcarlucas

MethodicConfigurator/backend_filesystem.py

@@ -12,7 +12,6 @@
 from os import getcwd as os_getcwd
 from os import listdir as os_listdir
 from os import rename as os_rename
-from os import walk as os_walk
 
 from shutil import copy2 as shutil_copy2
 from shutil import copytree as shutil_copytree
@@ -42,8 +41,6 @@
 from MethodicConfigurator.backend_filesystem_configuration_steps import ConfigurationSteps
 from MethodicConfigurator.backend_filesystem_program_settings import ProgramSettings
 
-from MethodicConfigurator.middleware_template_overview import TemplateOverview
-
 TOOLTIP_MAX_LENGTH = 105
 
 
@@ -516,31 +513,6 @@ def supported_vehicles():
         return ['AP_Periph', 'AntennaTracker', 'ArduCopter', 'ArduPlane',
                                     'ArduSub', 'Blimp', 'Heli', 'Rover', 'SITL']
 
-    @staticmethod
-    def get_vehicle_components_overviews():
-        """
-        Finds all subdirectories of base_dir containing a "vehicle_components.json" file,
-        creates a dictionary where the keys are the subdirectory names (relative to base_dir)
-        and the values are instances of VehicleComponents.
-
-        :param base_dir: The base directory to start searching from.
-        :return: A dictionary mapping subdirectory paths to VehicleComponents instances.
-        """
-        vehicle_components_dict = {}
-        file_to_find = VehicleComponents().vehicle_components_json_filename
-        template_default_dir = ProgramSettings.get_templates_base_dir()
-        for root, _dirs, files in os_walk(template_default_dir):
-            if file_to_find in files:
-                relative_path = os_path.relpath(root, template_default_dir)
-                vehicle_components = VehicleComponents()
-                comp_data = vehicle_components.load_vehicle_components_json_data(root)
-                if comp_data:
-                    comp_data = comp_data.get('Components', {})
-                    vehicle_components_overview = TemplateOverview(comp_data)
-                    vehicle_components_dict[relative_path] = vehicle_components_overview
-
-        return vehicle_components_dict
-
     @staticmethod
     def add_argparse_arguments(parser):
         parser.add_argument('-t', '--vehicle-type',

MethodicConfigurator/backend_filesystem_vehicle_components.py

@@ -9,6 +9,7 @@
 '''
 
 from os import path as os_path
+from os import walk as os_walk
 
 # from sys import exit as sys_exit
 # from logging import debug as logging_debug
@@ -22,6 +23,10 @@
 from json import dump as json_dump
 from json import JSONDecodeError
 
+from MethodicConfigurator.backend_filesystem_program_settings import ProgramSettings
+
+from MethodicConfigurator.middleware_template_overview import TemplateOverview
+
 
 class VehicleComponents:
     """
@@ -67,3 +72,28 @@ def get_fc_fw_version_from_vehicle_components_json(self) -> str:
                 return version_str
             logging_error(f"FW version string {version_str} on {self.vehicle_components_json_filename} is invalid")
         return None
+
+    @staticmethod
+    def get_vehicle_components_overviews():
+        """
+        Finds all subdirectories of base_dir containing a "vehicle_components.json" file,
+        creates a dictionary where the keys are the subdirectory names (relative to base_dir)
+        and the values are instances of VehicleComponents.
+
+        :param base_dir: The base directory to start searching from.
+        :return: A dictionary mapping subdirectory paths to VehicleComponents instances.
+        """
+        vehicle_components_dict = {}
+        file_to_find = VehicleComponents().vehicle_components_json_filename
+        template_default_dir = ProgramSettings.get_templates_base_dir()
+        for root, _dirs, files in os_walk(template_default_dir):
+            if file_to_find in files:
+                relative_path = os_path.relpath(root, template_default_dir)
+                vehicle_components = VehicleComponents()
+                comp_data = vehicle_components.load_vehicle_components_json_data(root)
+                if comp_data:
+                    comp_data = comp_data.get('Components', {})
+                    vehicle_components_overview = TemplateOverview(comp_data)
+                    vehicle_components_dict[relative_path] = vehicle_components_overview
+
+        return vehicle_components_dict

MethodicConfigurator/frontend_tkinter_directory_selection.py

@@ -31,6 +31,7 @@
 from MethodicConfigurator.common_arguments import add_common_arguments_and_parse
 
 from MethodicConfigurator.backend_filesystem import LocalFilesystem
+from MethodicConfigurator.backend_filesystem_program_settings import ProgramSettings
 
 from MethodicConfigurator.frontend_tkinter_base import show_no_param_files_error
 from MethodicConfigurator.frontend_tkinter_base import show_tooltip
@@ -49,12 +50,12 @@ class DirectorySelectionWidgets():
     """
     def __init__(self, parent, parent_frame, initialdir: str, label_text: str,  # pylint: disable=too-many-arguments
                  autoresize_width: bool, dir_tooltip: str, button_tooltip: str,
-                 local_filesystem: LocalFilesystem = None):
+                 is_template_selection: bool):
         self.parent = parent
         self.directory = deepcopy(initialdir)
         self.label_text = label_text
         self.autoresize_width = autoresize_width
-        self.local_filesystem2 = local_filesystem  # "2" to not collide with VehicleDirectorySelectionWidgets.local_filesystem
+        self.is_template_selection = is_template_selection
 
         # Create a new frame for the directory selection label and button
         self.container_frame = ttk.Frame(parent_frame)
@@ -86,9 +87,9 @@ def __init__(self, parent, parent_frame, initialdir: str, label_text: str,  # py
             self.directory_entry.xview_moveto(1.0)
 
     def on_select_directory(self):
-        if self.local_filesystem2:
-            TemplateOverviewWindow(self.parent.root, self.local_filesystem2)
-            selected_directory = self.local_filesystem2.get_recently_used_dirs()[0]
+        if self.is_template_selection:
+            TemplateOverviewWindow(self.parent.root)
+            selected_directory = ProgramSettings.get_recently_used_dirs()[0]
             logging_info("Selected template directory: %s", selected_directory)
         else:
             selected_directory = filedialog.askdirectory(initialdir=self.directory, title=f"Select {self.label_text}")
@@ -155,7 +156,8 @@ def __init__(self, parent: ttk, parent_frame: ttk.Frame,  # pylint: disable=too-
                          "parameter files to be uploaded to the flight controller",
                          "Select the vehicle-specific configuration directory containing the\n"
                          "intermediate parameter files to be uploaded to the flight controller" \
-                            if destroy_parent_on_open else '')
+                            if destroy_parent_on_open else '',
+                         False)
         self.local_filesystem = local_filesystem
         self.destroy_parent_on_open = destroy_parent_on_open
 
@@ -241,7 +243,7 @@ def create_option1_widgets(self, initial_template_dir: str, initial_base_dir: st
                                                       False,
                                                       template_dir_edit_tooltip,
                                                       template_dir_btn_tooltip,
-                                                      self.local_filesystem)
+                                                      True)
         self.template_dir.container_frame.pack(expand=False, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
 
         use_fc_params_checkbox = ttk.Checkbutton(option1_label_frame, variable=self.use_fc_params,
@@ -261,7 +263,8 @@ def create_option1_widgets(self, initial_template_dir: str, initial_base_dir: st
                                                       "(destination) base directory:",
                                                       False,
                                                       new_base_dir_edit_tooltip,
-                                                      new_base_dir_btn_tooltip)
+                                                      new_base_dir_btn_tooltip,
+                                                      False)
         self.new_base_dir.container_frame.pack(expand=False, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
         new_dir_edit_tooltip = "A new vehicle configuration directory with this name will be created at the " \
             "(destination) base directory"
@@ -303,7 +306,8 @@ def create_option3_widgets(self, last_vehicle_dir: str):
                                              "Last used vehicle configuration directory:",
                                              False,
                                              "Last used vehicle configuration directory",
-                                             "")
+                                             "",
+                                             False)
         last_dir.container_frame.pack(expand=False, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
 
         # Check if there is a last used vehicle configuration directory

MethodicConfigurator/frontend_tkinter_template_overview.py

@@ -17,16 +17,15 @@
 
 from MethodicConfigurator.middleware_template_overview import TemplateOverview
 
-from MethodicConfigurator.backend_filesystem import LocalFilesystem
+from MethodicConfigurator.backend_filesystem_program_settings import ProgramSettings
+from MethodicConfigurator.backend_filesystem_vehicle_components import VehicleComponents
 
 from MethodicConfigurator.common_arguments import add_common_arguments_and_parse
 
 from MethodicConfigurator.frontend_tkinter_base import BaseWindow
-from MethodicConfigurator.frontend_tkinter_base import show_error_message
 
 from MethodicConfigurator.version import VERSION
 
-
 class TemplateOverviewWindow(BaseWindow):
     """
     Represents the window for viewing and managing ArduPilot vehicle templates.
@@ -38,18 +37,15 @@ class TemplateOverviewWindow(BaseWindow):
 
     Attributes:
         window (tk.Tk): The root Tkinter window object for the GUI.
-        local_filesystem (LocalFilesystem): An instance of LocalFilesystem used to interact with the filesystem, including
-                                            operations related to template directories.
 
     Methods:
         on_row_double_click(event): Handles the event triggered when a row in the Treeview is double-clicked, allowing the user
                                      to store the corresponding template directory.
     """
-    def __init__(self, parent: tk.Tk, local_filesystem: LocalFilesystem):
+    def __init__(self, parent: tk.Tk):
         super().__init__(parent)
         self.root.title(f"Amilcar Lucas's - ArduPilot methodic configurator {VERSION} - Template Overview and selection")
         self.root.geometry("1200x300")
-        self.local_filesystem = local_filesystem
 
         instruction_text = "Please double-click the template below that most resembles your own vehicle components"
         instruction_label = ttk.Label(self.main_frame, text=instruction_text, font=('Arial', 12))
@@ -75,7 +71,7 @@ def __init__(self, parent: tk.Tk, local_filesystem: LocalFilesystem):
             self.tree.heading(col, text=col)
 
         # Populate the Treeview with data from the template overview
-        for key, template_overview in self.local_filesystem.get_vehicle_components_overviews().items():
+        for key, template_overview in VehicleComponents.get_vehicle_components_overviews().items():
             attribute_names = template_overview.attributes()
             values = (key,) + tuple(getattr(template_overview, attr, '') for attr in attribute_names)
             self.tree.insert('', 'end', text=key, values=values)
@@ -118,7 +114,7 @@ def on_row_double_click(self, event):
         item_id = self.tree.identify_row(event.y)
         if item_id:
             selected_template_relative_path = self.tree.item(item_id)['text']
-            self.local_filesystem.store_template_dir(selected_template_relative_path)
+            ProgramSettings.store_template_dir(selected_template_relative_path)
             self.root.destroy()
 
 def argument_parser():
@@ -136,25 +132,16 @@ def argument_parser():
                                                  'apply changes directly to the flight controller. The tool is built to '
                                                  'semi-automate the configuration process of ArduPilot for drones by '
                                                  'providing a clear and intuitive interface for parameter management.')
-    parser = LocalFilesystem.add_argparse_arguments(parser)
     return add_common_arguments_and_parse(parser)
 
 def main():
     args = argument_parser()
 
     logging_basicConfig(level=logging_getLevelName(args.loglevel), format='%(asctime)s - %(levelname)s - %(message)s')
 
-    vehicle_type = "ArduCopter"
-
-    try:
-        local_filesystem = LocalFilesystem(args.vehicle_dir, vehicle_type, None, args.allow_editing_template_files)
-    except SystemExit as expt:
-        show_error_message("Fatal error reading parameter files", f"{expt}")
-        raise
-
-    TemplateOverviewWindow(None, local_filesystem)
+    TemplateOverviewWindow(None)
 
-    print(local_filesystem.get_recently_used_dirs()[0])
+    print(ProgramSettings.get_recently_used_dirs()[0])
 
 if __name__ == "__main__":
     main()