IMPROVEMENT: Add more return type hints

amilcarlucas · amilcarlucas · commit c603a92b7207 · 2024-11-21T20:30:23.000+01:00
diff --git a/MethodicConfigurator/annotate_params.py b/MethodicConfigurator/annotate_params.py
@@ -50,7 +50,7 @@
 # mypy: disable-error-code="unused-ignore"
 
 
-def arg_parser():
+def arg_parser() -> argparse.Namespace:
     parser = argparse.ArgumentParser(
         description="Fetches on-line ArduPilot parameter documentation and adds it to the "
         "specified file or to all *.param and *.parm files in the specified directory."
diff --git a/MethodicConfigurator/ardupilot_methodic_configurator.py b/MethodicConfigurator/ardupilot_methodic_configurator.py
@@ -30,7 +30,7 @@
 from MethodicConfigurator.frontend_tkinter_parameter_editor import ParameterEditorWindow
 
 
-def argument_parser():
+def argument_parser() -> argparse.Namespace:
     """
     Parses command-line arguments for the script.
 
diff --git a/MethodicConfigurator/argparse_check_range.py b/MethodicConfigurator/argparse_check_range.py
@@ -34,7 +34,7 @@ def __init__(self, *args, **kwargs) -> None:
 
         super().__init__(*args, **kwargs)
 
-    def interval(self):
+    def interval(self) -> str:
         if hasattr(self, "min"):
             _lo = f"[{self.min}"
         elif hasattr(self, "inf"):
diff --git a/MethodicConfigurator/backend_filesystem.py b/MethodicConfigurator/backend_filesystem.py
@@ -382,11 +382,11 @@ def get_directory_name_from_full_path(full_path: str) -> str:
     def get_vehicle_directory_name(self) -> str:
         return self.get_directory_name_from_full_path(self.vehicle_dir)
 
-    def zip_file_path(self):
+    def zip_file_path(self) -> str:
         vehicle_name = self.get_vehicle_directory_name()
         return os_path.join(self.vehicle_dir, f"{vehicle_name}.zip")
 
-    def zip_file_exists(self):
+    def zip_file_exists(self) -> bool:
         zip_file_path = self.zip_file_path()
         return os_path.exists(zip_file_path) and os_path.isfile(zip_file_path)
 
@@ -436,10 +436,10 @@ def zip_files(self, files_to_zip: list[tuple[bool, str]]) -> None:
 
         logging_info(_("Intermediate parameter files and summary files zipped to %s"), zip_file_path)
 
-    def vehicle_image_filepath(self):
+    def vehicle_image_filepath(self) -> str:
         return os_path.join(self.vehicle_dir, "vehicle.jpg")
 
-    def vehicle_image_exists(self):
+    def vehicle_image_exists(self) -> bool:
         return os_path.exists(self.vehicle_image_filepath()) and os_path.isfile(self.vehicle_image_filepath())
 
     @staticmethod
@@ -477,11 +477,11 @@ def copy_template_files_to_new_vehicle_dir(self, template_dir: str, new_vehicle_
     def getcwd() -> str:
         return os_getcwd()
 
-    def tempcal_imu_result_param_tuple(self):
+    def tempcal_imu_result_param_tuple(self) -> tuple[str, str]:
         tempcal_imu_result_param_filename = "03_imu_temperature_calibration_results.param"
-        return [tempcal_imu_result_param_filename, os_path.join(self.vehicle_dir, tempcal_imu_result_param_filename)]
+        return tempcal_imu_result_param_filename, os_path.join(self.vehicle_dir, tempcal_imu_result_param_filename)
 
-    def copy_fc_values_to_file(self, selected_file: str, params: dict[str, float]):
+    def copy_fc_values_to_file(self, selected_file: str, params: dict[str, float]) -> int:
         ret = 0
         if selected_file in self.file_parameters:
             for param, v in self.file_parameters[selected_file].items():
@@ -557,15 +557,15 @@ def get_start_file(self, explicit_index: int, tcal_available: bool) -> str:
             start_file_index = len(files) - 1
         return files[start_file_index]
 
-    def get_eval_variables(self):
+    def get_eval_variables(self) -> dict[str, dict[str, Any]]:
         variables = {}
         if hasattr(self, "vehicle_components") and self.vehicle_components and "Components" in self.vehicle_components:
             variables["vehicle_components"] = self.vehicle_components["Components"]
         if hasattr(self, "doc_dict") and self.doc_dict:
             variables["doc_dict"] = self.doc_dict
         return variables
 
-    def copy_fc_params_values_to_template_created_vehicle_files(self, fc_parameters: dict[str, float]):
+    def copy_fc_params_values_to_template_created_vehicle_files(self, fc_parameters: dict[str, float]) -> str:
         eval_variables = self.get_eval_variables()
         for param_filename, param_dict in self.file_parameters.items():
             for param_name, param in param_dict.items():
diff --git a/MethodicConfigurator/backend_filesystem_configuration_steps.py b/MethodicConfigurator/backend_filesystem_configuration_steps.py
@@ -176,9 +176,9 @@ def compute_parameters(self, filename: str, file_info: dict, parameter_type: str
                 logging_warning(error_msg)
         return ""
 
-    def auto_changed_by(self, selected_file: str):
+    def auto_changed_by(self, selected_file: str) -> str:
         if selected_file in self.configuration_steps:
-            return self.configuration_steps[selected_file].get("auto_changed_by", "")
+            return str(self.configuration_steps[selected_file].get("auto_changed_by", ""))
         return ""
 
     def jump_possible(self, selected_file: str) -> dict[str, str]:
diff --git a/MethodicConfigurator/backend_filesystem_vehicle_components.py b/MethodicConfigurator/backend_filesystem_vehicle_components.py
@@ -38,7 +38,7 @@ def __init__(self) -> None:
         self.vehicle_components_json_filename = "vehicle_components.json"
         self.vehicle_components: Union[None, dict[Any, Any]] = None
 
-    def load_vehicle_components_json_data(self, vehicle_dir: str):
+    def load_vehicle_components_json_data(self, vehicle_dir: str) -> dict[Any, Any]:
         data = {}
         filepath = os_path.join(vehicle_dir, self.vehicle_components_json_filename)
         try:
diff --git a/MethodicConfigurator/backend_flightcontroller.py b/MethodicConfigurator/backend_flightcontroller.py
@@ -416,7 +416,7 @@ def get_params_progress_callback(completion: float) -> None:
 
         return pdict, defdict
 
-    def set_param(self, param_name: str, param_value: float):
+    def set_param(self, param_name: str, param_value: float) -> None:
         """
         Set a parameter on the flight controller.
 
@@ -425,8 +425,8 @@ def set_param(self, param_name: str, param_value: float):
             param_value (float): The value to set the parameter to.
         """
         if self.master is None:  # FIXME for testing only pylint: disable=fixme
-            return None
-        return self.master.param_set_send(param_name, param_value)
+            return
+        self.master.param_set_send(param_name, param_value)
 
     def reset_and_reconnect(
         self, reset_progress_callback=None, connection_progress_callback=None, extra_sleep_time: Optional[int] = None
@@ -528,7 +528,7 @@ def __auto_detect_serial(self) -> list[mavutil.SerialPort]:
 
     # pylint: enable=duplicate-code
 
-    def get_connection_tuples(self):
+    def get_connection_tuples(self) -> list[tuple[str, str]]:
         """
         Get all available connections.
         """
diff --git a/MethodicConfigurator/backend_flightcontroller_info.py b/MethodicConfigurator/backend_flightcontroller_info.py
@@ -8,7 +8,7 @@
 SPDX-License-Identifier: GPL-3.0-or-later
 """
 
-from typing import Any
+from typing import Any, Union
 
 from pymavlink import mavutil
 
@@ -45,7 +45,7 @@ def __init__(self) -> None:
         self.is_supported = False
         self.is_mavftp_supported = False
 
-    def get_info(self):
+    def get_info(self) -> dict[str, Union[str, dict[str, str]]]:
         return {
             "Vendor": self.vendor_and_vendor_id,
             "Product": self.product_and_product_id,
diff --git a/MethodicConfigurator/backend_mavftp.py b/MethodicConfigurator/backend_mavftp.py
@@ -17,7 +17,8 @@
 import struct
 import sys
 import time
-from argparse import ArgumentParser
+from argparse import ArgumentParser, Namespace
+from collections.abc import Generator
 from datetime import datetime
 from io import BufferedReader, BufferedWriter
 from io import BytesIO as SIO
@@ -106,7 +107,7 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-positional-argumen
         self.offset: int = offset  # Offset for read/write operations.
         self.payload = payload  # (bytes) Payload for the operation.
 
-    def pack(self):
+    def pack(self) -> bytearray:
         """pack message"""
         ret = struct.pack(
             "<HBBBBBBI", self.seq, self.session, self.opcode, self.size, self.req_opcode, self.burst_complete, 0, self.offset
@@ -128,7 +129,7 @@ def __str__(self) -> str:
             ret += f" [{self.payload[0]}]"
         return ret
 
-    def items(self):
+    def items(self) -> Generator[tuple[str, Union[int, bool, bytes]]]:
         """Yield each attribute and its value for the FTP_OP instance. For debugging purposes."""
         yield "seq", self.seq
         yield "session", self.session
@@ -280,7 +281,7 @@ def display_message(self) -> None:  # pylint: disable=too-many-branches
             logging.error("%s failed, unknown error %u in display_message()", self.operation_name, self.error_code)
 
     @property
-    def return_code(self):
+    def return_code(self) -> int:
         return self.error_code
 
 
@@ -1397,7 +1398,7 @@ def decode_and_save_params(fh) -> MAVFTPReturn:
 
 if __name__ == "__main__":
 
-    def argument_parser():
+    def argument_parser() -> Namespace:
         """
         Parses command-line arguments for the script.
 
@@ -1529,7 +1530,7 @@ def argument_parser():
         # Add other subparsers commands as needed
         return parser.parse_args()
 
-    def auto_detect_serial():
+    def auto_detect_serial() -> list[mavutil.SerialPort]:
         preferred_ports = [
             "*FTDI*",
             "*3D*",
@@ -1545,7 +1546,7 @@ def auto_detect_serial():
             "*CubePilot*",
             "*Qiotek*",
         ]
-        serial_list = mavutil.auto_detect_serial(preferred_list=preferred_ports)
+        serial_list: list[mavutil.SerialPort] = mavutil.auto_detect_serial(preferred_list=preferred_ports)
         serial_list.sort(key=lambda x: x.device)
 
         # remove OTG2 ports for dual CDC
@@ -1558,7 +1559,7 @@ def auto_detect_serial():
 
         return serial_list
 
-    def auto_connect(device):
+    def auto_connect(device) -> mavutil.SerialPort:
         comport = None
         if device:
             comport = mavutil.SerialPort(device=device, description=device)
diff --git a/MethodicConfigurator/extract_param_defaults.py b/MethodicConfigurator/extract_param_defaults.py
@@ -27,7 +27,7 @@
 MAV_PARAM_TYPE_REAL32 = 9
 
 
-def parse_arguments(args=None):
+def parse_arguments(args=None) -> argparse.Namespace:
     """
     Parses command line arguments for the script.
 
@@ -92,7 +92,7 @@ def parse_arguments(args=None):
         if args.compid != -1:
             raise SystemExit("--compid parameter is only relevant if --format is qgcs")
 
-    return args
+    return args  # type: ignore # mypy bug
 
 
 def extract_parameter_values(logfile: str, param_type: str = "defaults") -> dict[str, float]:  # pylint: disable=too-many-branches
diff --git a/MethodicConfigurator/frontend_tkinter_base.py b/MethodicConfigurator/frontend_tkinter_base.py
@@ -384,7 +384,7 @@ def put_image_in_label(parent: ttk.Frame, filepath: str, image_height: int = 40)
         photo = ImageTk.PhotoImage(resized_image)
 
         # Create a label with the resized image
-        image_label = ttk.Label(parent, image=photo)
+        image_label = ttk.Label(parent, image=photo)  # type: ignore[arg-type] # workaround a mypy issue
         # Keep a reference to the image to prevent it from being garbage collected
         image_label.image = photo  # type: ignore
         return image_label
diff --git a/MethodicConfigurator/frontend_tkinter_component_editor.py b/MethodicConfigurator/frontend_tkinter_component_editor.py
@@ -9,7 +9,7 @@
 """
 
 import tkinter as tk
-from argparse import ArgumentParser
+from argparse import ArgumentParser, Namespace
 from logging import basicConfig as logging_basicConfig
 
 # from logging import debug as logging_debug
@@ -18,7 +18,7 @@
 from logging import getLevelName as logging_getLevelName
 from math import log2
 from tkinter import ttk
-from typing import Any, Union
+from typing import Any, Callable, Union
 
 from MethodicConfigurator import _, __version__
 from MethodicConfigurator.backend_filesystem import LocalFilesystem
@@ -31,7 +31,7 @@
 from MethodicConfigurator.frontend_tkinter_component_editor_base import ComponentEditorWindowBase
 
 
-def argument_parser():
+def argument_parser() -> Namespace:
     """
     Parses command-line arguments for the script.
 
@@ -562,7 +562,7 @@ def get_combobox_values(param_name: str) -> list:
         entry.insert(0, str(value))
         return entry
 
-    def get_validate_function(self, entry, path):
+    def get_validate_function(self, entry, path) -> Union[Callable[[tk.Event[tk.Entry]], object], None]:  # pylint: disable=unsubscriptable-object
         validate_functions = {
             ("Frame", "Specifications", "TOW min Kg"): lambda event, entry=entry, path=path: self.validate_entry_limits(
                 event, entry, float, (0.01, 600), "Takeoff Weight", path
diff --git a/MethodicConfigurator/frontend_tkinter_component_editor_base.py b/MethodicConfigurator/frontend_tkinter_component_editor_base.py
@@ -9,7 +9,7 @@
 """
 
 import tkinter as tk
-from argparse import ArgumentParser
+from argparse import ArgumentParser, Namespace
 from logging import basicConfig as logging_basicConfig
 from logging import getLevelName as logging_getLevelName
 
@@ -31,7 +31,7 @@
 )
 
 
-def argument_parser():
+def argument_parser() -> Namespace:
     """
     Parses command-line arguments for the script.
 
diff --git a/MethodicConfigurator/frontend_tkinter_connection_selection.py b/MethodicConfigurator/frontend_tkinter_connection_selection.py
@@ -9,7 +9,7 @@
 """
 
 import tkinter as tk
-from argparse import ArgumentParser
+from argparse import ArgumentParser, Namespace
 from logging import basicConfig as logging_basicConfig
 from logging import debug as logging_debug
 from logging import getLevelName as logging_getLevelName
@@ -88,9 +88,9 @@ def on_select_connection_combobox_change(self, _event) -> None:
                     # nothing got selected revert to the current connection
                     self.conn_selection_combobox.set(self.previous_selection)
                 return
-            self.reconnect(selected_connection)
+            self.reconnect(selected_connection)  # type: ignore[arg-type] # workaround for mypy issue
 
-    def add_connection(self):
+    def add_connection(self) -> str:
         # Open the connection selection dialog
         selected_connection = simpledialog.askstring(
             _("Flight Controller Connection"),
@@ -114,6 +114,7 @@ def add_connection(self):
         else:
             error_msg = _("Add connection canceled or string empty {selected_connection}")
             logging_debug(error_msg.format(**locals()))
+            selected_connection = ""
         return selected_connection
 
     def reconnect(self, selected_connection: str = "") -> bool:  # defaults to auto-connect
@@ -248,7 +249,7 @@ def skip_fc_connection(self, flight_controller: FlightController) -> None:
         self.root.destroy()
 
 
-def argument_parser():
+def argument_parser() -> Namespace:
     """
     Parses command-line arguments for the script.
 
diff --git a/MethodicConfigurator/frontend_tkinter_directory_selection.py b/MethodicConfigurator/frontend_tkinter_directory_selection.py
@@ -9,7 +9,7 @@
 """
 
 import tkinter as tk
-from argparse import ArgumentParser
+from argparse import ArgumentParser, Namespace
 from copy import deepcopy
 from logging import basicConfig as logging_basicConfig
 from logging import debug as logging_error
@@ -133,7 +133,7 @@ def __init__(self, parent_frame, initial_dir: str, label_text: str, dir_tooltip:
         directory_entry.pack(side=tk.LEFT, fill="x", expand=True, anchor=tk.NW, pady=(4, 0))
         show_tooltip(directory_entry, dir_tooltip)
 
-    def get_selected_directory(self):
+    def get_selected_directory(self) -> str:
         return self.dir_var.get()
 
 
@@ -473,7 +473,7 @@ def open_last_vehicle_directory(self, last_vehicle_dir: str) -> None:
             )
 
 
-def argument_parser():
+def argument_parser() -> Namespace:
     """
     Parses command-line arguments for the script.
 
diff --git a/MethodicConfigurator/frontend_tkinter_entry_dynamic.py b/MethodicConfigurator/frontend_tkinter_entry_dynamic.py
@@ -80,7 +80,7 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-positional-argumen
         self.bind("<Return>", self.update_entry_from_listbox)
         self.bind("<Escape>", lambda event: self.unpost_listbox())
 
-    def default_filter_function(self, entry_data):
+    def default_filter_function(self, entry_data) -> list[str]:
         if self._ignorecase_match:
             if self._startswith_match:
                 return [item for item in self._list_of_items if item.lower().startswith(entry_data.lower())]
@@ -173,8 +173,8 @@ def unpost_listbox(self) -> None:
             self._listbox.master.destroy()
             self._listbox = None
 
-    def get_value(self):
-        return self._entry_var.get()
+    def get_value(self) -> str:
+        return self._entry_var.get()  # type: ignore[no-any-return] # mypy bug
 
     def set_value(self, text, close_dialog=False) -> None:
         self._set_var(text)
diff --git a/MethodicConfigurator/frontend_tkinter_flightcontroller_info.py b/MethodicConfigurator/frontend_tkinter_flightcontroller_info.py
diff --git a/MethodicConfigurator/frontend_tkinter_pair_tuple_combobox.py b/MethodicConfigurator/frontend_tkinter_pair_tuple_combobox.py
diff --git a/MethodicConfigurator/frontend_tkinter_parameter_editor.py b/MethodicConfigurator/frontend_tkinter_parameter_editor.py
diff --git a/MethodicConfigurator/frontend_tkinter_parameter_editor_table.py b/MethodicConfigurator/frontend_tkinter_parameter_editor_table.py
diff --git a/MethodicConfigurator/tempcal_imu.py b/MethodicConfigurator/tempcal_imu.py
diff --git a/pyproject.toml b/pyproject.toml
