FIX: enforce ruff rule FBT003

Author: amilcarlucas

MethodicConfigurator/backend_filesystem_program_settings.py

@@ -92,7 +92,9 @@ def valid_directory_name(dir_name: str) -> bool:
 
     @staticmethod
     def __user_config_dir() -> str:
-        user_config_directory = user_config_dir(".ardupilot_methodic_configurator", False, roaming=True, ensure_exists=True)
+        user_config_directory = user_config_dir(
+            ".ardupilot_methodic_configurator", appauthor=False, roaming=True, ensure_exists=True
+        )
 
         if not os_path.exists(user_config_directory):
             error_msg = _("The user configuration directory '{user_config_directory}' does not exist.")
@@ -106,7 +108,7 @@ def __user_config_dir() -> str:
     @staticmethod
     def __site_config_dir() -> str:
         site_config_directory = site_config_dir(
-            ".ardupilot_methodic_configurator", False, version=None, multipath=False, ensure_exists=True
+            ".ardupilot_methodic_configurator", appauthor=False, version=None, multipath=False, ensure_exists=True
         )
 
         if not os_path.exists(site_config_directory):

MethodicConfigurator/frontend_tkinter_base.py

@@ -64,7 +64,7 @@ def leave(_event: tk.Event) -> None:
         tooltip.withdraw()
 
     tooltip = tk.Toplevel(widget)
-    tooltip.wm_overrideredirect(True)
+    tooltip.wm_overrideredirect(boolean=True)
     tooltip_label = ttk.Label(tooltip, text=text, background="#ffffe0", relief="solid", borderwidth=1, justify=tk.LEFT)
     tooltip_label.pack()
     tooltip.withdraw()  # Initially hide the tooltip
@@ -351,7 +351,7 @@ def __init__(self, root_tk: Optional[tk.Toplevel] = None) -> None:
             self.root = tk.Tk()  # type: ignore[assignment]
             # Set the application icon for the window and all child windows
             # https://pythonassets.com/posts/window-icon-in-tk-tkinter/
-            self.root.iconphoto(True, tk.PhotoImage(file=LocalFilesystem.application_icon_filepath()))
+            self.root.iconphoto(True, tk.PhotoImage(file=LocalFilesystem.application_icon_filepath()))  # noqa: FBT003
 
         # Set the theme to 'alt'
         style = ttk.Style()
@@ -450,16 +450,16 @@ def update_show_again() -> None:
         dismiss_button.pack(pady=10)
 
         BaseWindow.center_window(usage_popup_window.root, parent)
-        usage_popup_window.root.attributes("-topmost", True)
+        usage_popup_window.root.attributes("-topmost", True)  # noqa: FBT003
 
         if platform_system() == "Windows":
-            parent.attributes("-disabled", True)  # Disable parent window input
+            parent.attributes("-disabled", True)  # noqa: FBT003  # Disable parent window input
 
         usage_popup_window.root.protocol("WM_DELETE_WINDOW", lambda: UsagePopupWindow.close(usage_popup_window, parent))
 
     @staticmethod
     def close(usage_popup_window: BaseWindow, parent: tk.Toplevel) -> None:
         usage_popup_window.root.destroy()
         if platform_system() == "Windows":
-            parent.attributes("-disabled", False)  # Re-enable the parent window
+            parent.attributes("-disabled", False)  # noqa: FBT003  # Re-enable the parent window
         parent.focus_set()

MethodicConfigurator/frontend_tkinter_directory_selection.py

@@ -157,22 +157,22 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-positional-argumen
     ) -> None:
         # Call the parent constructor with the necessary arguments
         super().__init__(
-            parent,
-            parent_frame,
-            initial_dir,
-            _("Vehicle configuration directory:"),
-            False,
-            _(
+            parent=parent,
+            parent_frame=parent_frame,
+            initialdir=initial_dir,
+            label_text=_("Vehicle configuration directory:"),
+            autoresize_width=False,
+            dir_tooltip=_(
                 "Vehicle-specific directory containing the intermediate\n"
                 "parameter files to be uploaded to the flight controller"
             ),
-            _(
+            button_tooltip=_(
                 "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 "",
-            False,
+            is_template_selection=False,
         )
         self.local_filesystem = local_filesystem
         self.destroy_parent_on_open = destroy_parent_on_open
@@ -278,17 +278,16 @@ def create_option1_widgets(
             "parameter files to be copied to the new vehicle configuration directory"
         )
         self.template_dir = DirectorySelectionWidgets(
-            self,
-            option1_label_frame,
-            initial_template_dir,
-            _("Source Template directory:"),
-            False,
-            template_dir_edit_tooltip,
-            template_dir_btn_tooltip,
-            True,
+            parent=self,
+            parent_frame=option1_label_frame,
+            initialdir=initial_template_dir,
+            label_text=_("Source Template directory:"),
+            autoresize_width=False,
+            dir_tooltip=template_dir_edit_tooltip,
+            button_tooltip=template_dir_btn_tooltip,
+            is_template_selection=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,
@@ -310,14 +309,14 @@ def create_option1_widgets(
         new_base_dir_edit_tooltip = _("Existing directory where the new vehicle configuration directory will be created")
         new_base_dir_btn_tooltip = _("Select the directory where the new vehicle configuration directory will be created")
         self.new_base_dir = DirectorySelectionWidgets(
-            self,
-            option1_label_frame,
-            initial_base_dir,
-            _("Destination base directory:"),
-            False,
-            new_base_dir_edit_tooltip,
-            new_base_dir_btn_tooltip,
-            False,
+            parent=self,
+            parent_frame=option1_label_frame,
+            initialdir=initial_base_dir,
+            label_text=_("Destination base directory:"),
+            autoresize_width=False,
+            dir_tooltip=new_base_dir_edit_tooltip,
+            button_tooltip=new_base_dir_btn_tooltip,
+            is_template_selection=False,
         )
         self.new_base_dir.container_frame.pack(expand=False, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
         new_dir_edit_tooltip = _(
@@ -369,14 +368,14 @@ def create_option3_widgets(self, last_vehicle_dir: str) -> None:
         option3_label_frame.pack(expand=True, fill=tk.X, padx=6, pady=6)
 
         last_dir = DirectorySelectionWidgets(
-            self,
-            option3_label_frame,
-            last_vehicle_dir or "",
-            _("Last used vehicle configuration directory:"),
-            False,
-            _("Last used vehicle configuration directory"),
-            "",
-            False,
+            parent=self,
+            parent_frame=option3_label_frame,
+            initialdir=last_vehicle_dir or "",
+            label_text=_("Last used vehicle configuration directory:"),
+            autoresize_width=False,
+            dir_tooltip=_("Last used vehicle configuration directory"),
+            button_tooltip="",
+            is_template_selection=False,
         )
         last_dir.container_frame.pack(expand=False, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
 

MethodicConfigurator/frontend_tkinter_pair_tuple_combobox.py

@@ -186,7 +186,7 @@ def create_tooltip(self, text: str) -> None:
         try:
             if self.tooltip is None or self.tooltip.winfo_exists():
                 self.tooltip = Toplevel(self.master)
-                self.tooltip.wm_overrideredirect(True)
+                self.tooltip.wm_overrideredirect(boolean=True)
                 x = self.winfo_rootx() + 150  # Adjust width as needed
                 y = self.winfo_rooty()
                 self.tooltip.wm_geometry(f"+{x}+{y}")

MethodicConfigurator/frontend_tkinter_parameter_editor.py

@@ -174,7 +174,7 @@ def __init__(self, current_file: str, flight_controller: FlightController, local
         self.__create_parameter_area_widgets()
 
         # trigger a table update to ask the user what to do in the case this file needs special actions
-        self.root.after(10, self.on_param_file_combobox_change(None, True))  # type: ignore[func-returns-value]
+        self.root.after(10, self.on_param_file_combobox_change(None, forced=True))  # type: ignore[func-returns-value]
 
         # this one should be on top of the previous one hence the longer time
         if UsagePopupWindow.should_display("parameter_editor"):
@@ -409,14 +409,14 @@ def __do_tempcal_imu(self, selected_file: str) -> None:
                     )
                     # Pass the selected filename to the IMUfit class
                     IMUfit(
-                        filename,
-                        tempcal_imu_result_param_fullpath,
-                        False,
-                        False,
-                        False,
-                        False,
-                        self.local_filesystem.vehicle_dir,
-                        self.tempcal_imu_progress_window.update_progress_bar_300_pct,
+                        logfile=filename,
+                        outfile=tempcal_imu_result_param_fullpath,
+                        no_graph=False,
+                        log_parm=False,
+                        online=False,
+                        tclr=False,
+                        figpath=self.local_filesystem.vehicle_dir,
+                        progress_callback=self.tempcal_imu_progress_window.update_progress_bar_300_pct,
                     )
                     self.tempcal_imu_progress_window.destroy()
                     try:
@@ -520,7 +520,7 @@ def download_flight_controller_parameters(self, redownload: bool = False) -> Non
             self.local_filesystem.write_param_default_values_to_file(param_default_values)
         self.param_download_progress_window.destroy()  # for the case that '--device test' and there is no real FC connected
         if not redownload:
-            self.on_param_file_combobox_change(None, True)  # the initial param read will trigger a table update
+            self.on_param_file_combobox_change(None, forced=True)  # the initial param read will trigger a table update
 
     def repopulate_parameter_table(self, selected_file: Union[None, str]) -> None:
         if not selected_file:
@@ -650,7 +650,7 @@ def upload_selected_params(self, selected_params: dict) -> None:
 
         if self.at_least_one_changed_parameter_written:
             # Re-download all parameters, in case one of them changed, and validate that all uploads were successful
-            self.download_flight_controller_parameters(True)
+            self.download_flight_controller_parameters(redownload=True)
             logging_info(_("Re-download all parameters from the flight controller"))
 
             # Validate that the read parameters are the same as the ones in the current_file
@@ -756,13 +756,15 @@ def write_summary_files(self) -> None:  # pylint: disable=too-many-locals
             "these can be reused between similar vehicles"
         )
         messagebox.showinfo(_("Last parameter file processed"), summary_message.format(**locals()))
-        wrote_complete = self.write_summary_file(annotated_fc_parameters, "complete.param", False)
-        wrote_read_only = self.write_summary_file(non_default__read_only_params, "non-default_read-only.param", False)
+        wrote_complete = self.write_summary_file(annotated_fc_parameters, "complete.param", annotate_doc=False)
+        wrote_read_only = self.write_summary_file(
+            non_default__read_only_params, "non-default_read-only.param", annotate_doc=False
+        )
         wrote_calibrations = self.write_summary_file(
-            non_default__writable_calibrations, "non-default_writable_calibrations.param", False
+            non_default__writable_calibrations, "non-default_writable_calibrations.param", annotate_doc=False
         )
         wrote_non_calibrations = self.write_summary_file(
-            non_default__writable_non_calibrations, "non-default_writable_non-calibrations.param", False
+            non_default__writable_non_calibrations, "non-default_writable_non-calibrations.param", annotate_doc=False
         )
         files_to_zip = [
             (wrote_complete, "complete.param"),

MethodicConfigurator/frontend_tkinter_parameter_editor_documentation_frame.py

@@ -114,7 +114,7 @@ def update_documentation_labels(self, current_file: str) -> None:
         )
         self.__update_documentation_label(_("External tool:"), external_tool_text, external_tool_url)
         mandatory_text, mandatory_url = self.local_filesystem.get_documentation_text_and_url(current_file, "mandatory")
-        self.__update_documentation_label(_("Mandatory:"), mandatory_text, mandatory_url, False)
+        self.__update_documentation_label(_("Mandatory:"), mandatory_text, mandatory_url, url_expected=False)
 
         if self.auto_open_var.get():
             if wiki_url:

MethodicConfigurator/frontend_tkinter_template_overview.py

@@ -105,7 +105,7 @@ def __init__(self, parent: Optional[tk.Toplevel] = None) -> None:
             self.tree.heading(
                 col_str,
                 text=col_str,
-                command=lambda col=col_str: self.__sort_by_column(col, False),  # type: ignore[misc]
+                command=lambda col=col_str: self.__sort_by_column(col, reverse=False),  # type: ignore[misc]
             )
 
         if isinstance(self.root, tk.Toplevel):

pyproject.toml

@@ -100,7 +100,7 @@ lint.select = [
     "ASYNC",# flake8-async
     "S",    # flake8-bandit
     #"BLE",  # flake8-blind-except
-    #"FBT",  # flake8-boolean-trap
+    "FBT",  # flake8-boolean-trap
     "B",    # flake8-bugbear
     "A",    # flake8-builtins
     "COM",  # flake8-commas
@@ -165,6 +165,8 @@ lint.ignore = [
     "D401",    # First line of docstring should be in imperative mood
     "COM812",
     "DTZ005",  # `tz=None` passed to `datetime.datetime.now()`
+    "FBT001",  # Boolean-typed positional argument in function definition
+    "FBT002",  # Boolean default positional argument in function definition
 ]
 
 line-length = 127

unittests/backend_filesystem_test.py

@@ -32,7 +32,7 @@ def test_read_params_from_files(self, mock_listdir, mock_isdir) -> None:
         LocalFilesystem.load_param_file_into_dict = mock_load_param_file_into_dict
 
         # Call the method under test
-        lfs = LocalFilesystem("vehicle_dir", "vehicle_type", None, False)
+        lfs = LocalFilesystem("vehicle_dir", "vehicle_type", None, allow_editing_template_files=False)
         result = lfs.read_params_from_files()
 
         # Assertions
@@ -42,7 +42,7 @@ def test_read_params_from_files(self, mock_listdir, mock_isdir) -> None:
         mock_load_param_file_into_dict.assert_called_once_with("vehicle_dir/02_test.param")
 
     def test_str_to_bool(self) -> None:
-        lfs = LocalFilesystem("vehicle_dir", "vehicle_type", None, False)
+        lfs = LocalFilesystem("vehicle_dir", "vehicle_type", None, allow_editing_template_files=False)
         self.assertTrue(lfs.str_to_bool("true"))
         self.assertTrue(lfs.str_to_bool("yes"))
         self.assertTrue(lfs.str_to_bool("1"))
@@ -59,7 +59,7 @@ def test_re_init(self, mock_read_params_from_files, mock_listdir, mock_isdir) ->
         mock_listdir.return_value = ["00_default.param", "01_ignore_readonly.param", "02_test.param"]
         mock_read_params_from_files.return_value = {"02_test.param": {"TEST_PARAM": "value"}}
 
-        lfs = LocalFilesystem("vehicle_dir", "vehicle_type", None, False)
+        lfs = LocalFilesystem("vehicle_dir", "vehicle_type", None, allow_editing_template_files=False)
         lfs.re_init("new_vehicle_dir", "new_vehicle_type")
 
         self.assertEqual(lfs.vehicle_dir, "new_vehicle_dir")
@@ -97,7 +97,7 @@ def test_copy_template_files_to_new_vehicle_dir(self, mock_copy2, mock_copytree,
         mock_join.side_effect = lambda *args: "/".join(args)
 
         # Initialize LocalFilesystem
-        lfs = LocalFilesystem("vehicle_dir", "vehicle_type", None, False)
+        lfs = LocalFilesystem("vehicle_dir", "vehicle_type", None, allow_editing_template_files=False)
 
         # Call the method under test
         lfs.copy_template_files_to_new_vehicle_dir("template_dir", "new_vehicle_dir")