FIX: inconsistent return types

Author: amilcarlucas

MethodicConfigurator/annotate_params.py

@@ -390,7 +390,7 @@ def get_xml_data(base_url: str, directory: str, filename: str, vehicle_type: str
             raise SystemExit("permission denied to write online XML documentation to file") from e
 
     # Parse the XML data
-    return DET.fromstring(xml_data)
+    return DET.fromstring(xml_data)  # type: ignore[no-any-return]
 
 
 def load_default_param_file(directory: str) -> dict[str, "Par"]:

MethodicConfigurator/backend_filesystem_configuration_steps.py

@@ -169,9 +169,9 @@ def auto_changed_by(self, selected_file: str):
             return self.configuration_steps[selected_file].get("auto_changed_by", "")
         return ""
 
-    def jump_possible(self, selected_file: str):
+    def jump_possible(self, selected_file: str) -> dict[str, str]:
         if selected_file in self.configuration_steps:
-            return self.configuration_steps[selected_file].get("jump_possible", {})
+            return dict(self.configuration_steps[selected_file].get("jump_possible", {}))
         return {}
 
     def get_documentation_text_and_url(self, selected_file: str, prefix_key: str) -> tuple[str, str]:

MethodicConfigurator/backend_filesystem_program_settings.py

@@ -21,6 +21,7 @@
 from re import escape as re_escape
 from re import match as re_match
 from re import sub as re_sub
+from typing import Any
 
 from platformdirs import site_config_dir, user_config_dir
 
@@ -111,7 +112,7 @@ def __site_config_dir():
         return site_config_directory
 
     @staticmethod
-    def __get_settings_as_dict():
+    def __get_settings_as_dict() -> dict[str, Any]:
         settings_path = os_path.join(ProgramSettings.__user_config_dir(), "settings.json")
 
         settings = {}
@@ -226,8 +227,9 @@ def get_recently_used_dirs():
         return template_dir, new_base_dir, vehicle_dir
 
     @staticmethod
-    def display_usage_popup(ptype: str):
-        return ProgramSettings.__get_settings_as_dict()["display_usage_popup"].get(ptype, True)
+    def display_usage_popup(ptype: str) -> bool:
+        display_usage_popup_settings = ProgramSettings.__get_settings_as_dict().get("display_usage_popup", {})
+        return bool(display_usage_popup_settings.get(ptype, True))
 
     @staticmethod
     def set_display_usage_popup(ptype: str, value: bool):

MethodicConfigurator/backend_filesystem_vehicle_components.py

@@ -67,7 +67,7 @@ def get_fc_fw_type_from_vehicle_components_json(self) -> str:
         else:
             components = None
         if components:
-            fw_type = components.get("Flight Controller", {}).get("Firmware", {}).get("Type", "")
+            fw_type: str = components.get("Flight Controller", {}).get("Firmware", {}).get("Type", "")
             if fw_type in self.supported_vehicles():
                 return fw_type
             error_msg = _("Firmware type {fw_type} in {self.vehicle_components_json_filename} is not supported")
@@ -80,7 +80,7 @@ def get_fc_fw_version_from_vehicle_components_json(self) -> str:
         else:
             components = None
         if components:
-            version_str = components.get("Flight Controller", {}).get("Firmware", {}).get("Version", "")
+            version_str: str = components.get("Flight Controller", {}).get("Firmware", {}).get("Version", "")
             version_str = version_str.lstrip().split(" ")[0] if version_str else ""
             if re_match(r"^\d+\.\d+\.\d+$", version_str):
                 return version_str

MethodicConfigurator/backend_flightcontroller.py

@@ -95,7 +95,7 @@ def discover_connections(self):
         for port in self.__connection_tuples:
             logging_info("%s - %s", port[0], port[1])
         # now that it is logged, add the 'Add another' tuple
-        self.__connection_tuples += [tuple([_("Add another"), _("Add another")])]
+        self.__connection_tuples += [(_("Add another"), _("Add another"))]
 
     def disconnect(self):
         """
@@ -222,7 +222,7 @@ def __request_message(self, message_id: int):
 
     def __create_connection_with_retry(
         self, progress_callback, retries: int = 3, timeout: int = 5, log_errors: bool = True
-    ) -> mavutil.mavlink_connection:
+    ) -> str:
         """
         Attempts to create a connection to the flight controller with retries.
 

MethodicConfigurator/backend_mavftp.py

@@ -368,7 +368,8 @@ def cmd_ftp(self, args) -> MAVFTPReturn:  # noqa PRL0911 pylint: disable=too-man
         if args[0] == "list":
             return self.cmd_list(args[1:])
         if args[0] == "set":
-            return self.ftp_settings.command(args[1:])
+            self.ftp_settings.command(args[1:])
+            return MAVFTPReturn("FTP command", ERR_None)
         if args[0] == "get":
             return self.cmd_get(args[1:])
         if args[0] == "getparams":
@@ -859,7 +860,7 @@ def cmd_rm(self, args) -> MAVFTPReturn:
         self.__send(op)
         return self.process_ftp_reply("RemoveFile")
 
-    def cmd_rmdir(self, args):
+    def cmd_rmdir(self, args) -> MAVFTPReturn:
         """remove directory"""
         if len(args) != 1:
             logging.error("Usage: rmdir [DIRECTORYNAME]")
@@ -871,7 +872,7 @@ def cmd_rmdir(self, args):
         self.__send(op)
         return self.process_ftp_reply("RemoveDirectory")
 
-    def __handle_remove_reply(self, op, _m):
+    def __handle_remove_reply(self, op, _m) -> MAVFTPReturn:
         """handle remove reply"""
         return self.__decode_ftp_ack_and_nack(op)
 
@@ -890,7 +891,7 @@ def cmd_rename(self, args) -> MAVFTPReturn:
         self.__send(op)
         return self.process_ftp_reply("Rename")
 
-    def __handle_rename_reply(self, op, _m):
+    def __handle_rename_reply(self, op, _m) -> MAVFTPReturn:
         """handle rename reply"""
         return self.__decode_ftp_ack_and_nack(op)
 
@@ -906,7 +907,7 @@ def cmd_mkdir(self, args) -> MAVFTPReturn:
         self.__send(op)
         return self.process_ftp_reply("CreateDirectory")
 
-    def __handle_mkdir_reply(self, op, _m):
+    def __handle_mkdir_reply(self, op, _m) -> MAVFTPReturn:
         """handle mkdir reply"""
         return self.__decode_ftp_ack_and_nack(op)
 
@@ -924,7 +925,7 @@ def cmd_crc(self, args) -> MAVFTPReturn:
         self.__send(op)
         return self.process_ftp_reply("CalcFileCRC32")
 
-    def __handle_crc_reply(self, op, _m):
+    def __handle_crc_reply(self, op, _m) -> MAVFTPReturn:
         """handle crc reply"""
         if op.opcode == OP_Ack and op.size == 4:
             (crc,) = struct.unpack("<I", op.payload)
@@ -1119,9 +1120,9 @@ def __idle_task(self) -> bool:
         return self.__last_send_time_was_more_than_idle_detection_time_ago(now)
 
     def __last_send_time_was_more_than_idle_detection_time_ago(self, now: float) -> bool:
-        return self.last_send_time is not None and now - self.last_send_time > self.ftp_settings.idle_detection_time
+        return self.last_send_time is not None and now - self.last_send_time > float(self.ftp_settings.idle_detection_time)
 
-    def __handle_reset_sessions_reply(self, op, _m):
+    def __handle_reset_sessions_reply(self, op, _m) -> MAVFTPReturn:
         """handle reset sessions reply"""
         return self.__decode_ftp_ack_and_nack(op)
 
@@ -1352,13 +1353,13 @@ def cmd_getparams(  # pylint: disable=too-many-arguments
         sort_type: str = "missionplanner",
         add_datatype_comments: bool = False,
         add_timestamp_comment: bool = False,
-    ):
+    ) -> MAVFTPReturn:
         """Decode the parameter file and save the values and defaults to disk"""
 
-        def decode_and_save_params(fh):
+        def decode_and_save_params(fh) -> MAVFTPReturn:
             if fh is None:
                 logging.error("FTP: no parameter file handler")
-                return
+                return MAVFTPReturn("GetParams", ERR_Fail)
             try:
                 data = fh.read()
             except OSError as exp:
@@ -1383,8 +1384,9 @@ def decode_and_save_params(fh):
                         logging.info("%-16s %f (default %f)", name, value, param_defaults[name][0])
                     else:
                         logging.info("%-16s %f", name, value)
+            return MAVFTPReturn("GetParams", ERR_None)
 
-        self.cmd_get(
+        return self.cmd_get(
             ["@PARAM/param.pck?withdefaults=1" if len(args) > 1 else "@PARAM/param.pck"],
             callback=decode_and_save_params,
             progress_callback=progress_callback,

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]
         # Keep a reference to the image to prevent it from being garbage collected
         image_label.image = photo  # type: ignore
         return image_label

MethodicConfigurator/frontend_tkinter_parameter_editor_table.py

@@ -48,7 +48,7 @@ def __init__(self, root, local_filesystem, parameter_editor):
         self.root = root
         self.local_filesystem = local_filesystem
         self.parameter_editor = parameter_editor
-        self.current_file = None
+        self.current_file = ""
         self.upload_checkbutton_var = {}
         self.at_least_one_param_edited = False
 

MethodicConfigurator/internationalization.py

@@ -20,11 +20,11 @@
 LANGUAGE_CHOICES = ["en", "zh_CN", "pt"]
 
 
-def identity_function(s):
+def identity_function(s: str) -> str:
     return s
 
 
-def load_translation() -> Callable:
+def load_translation() -> Callable[[str], str]:
     default_language = LANGUAGE_CHOICES[0]
 
     # First, pre-parse to find the --language argument

pyproject.toml

@@ -152,7 +152,7 @@ no_implicit_optional = true
 # Configuring warnings
 warn_unused_ignores = true
 warn_no_return = false
-warn_return_any = false
+warn_return_any = true
 warn_redundant_casts = true
 
 # Misc things