fix(pyright): Fix or ignore pyright linter issues

Author: amilcarlucas

.github/workflows/pyright.yml

@@ -0,0 +1,47 @@
+name: Pyright
+
+on:
+  pull_request:
+    paths:
+      - '**/*.py'        # Watch for changes in any Python files
+      - 'pyproject.toml' # Watch for changes in the pyproject.toml file
+  push:
+    paths:
+      - '**/*.py'        # Watch for changes in any Python files
+      - 'pyproject.toml' # Watch for changes in the pyproject.toml file
+  workflow_dispatch:
+
+jobs:
+  pyright:
+    runs-on: ubuntu-latest
+    strategy:
+        matrix:
+          python-version: ["3.9", "3.12"]
+
+    env:
+        UV_SYSTEM_PYTHON: 1
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+        # https://docs.astral.sh/uv/guides/integration/github/
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+            python-version: ${{ matrix.python-version }}
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+            python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        # these extra packages are required by pyright to validate the python imports
+        run: |
+            uv pip install 'pyright==1.1.394' 'argcomplete==3.5.3' 'defusedxml==0.7.1' 'jsonschema==4.23.0' 'matplotlib==3.9.4' 'numpy==2.0.2' 'pillow==11.1.0' 'platformdirs==4.3.6' 'pymavlink==2.4.42' 'pyserial==3.5' 'requests==2.32.3' 'setuptools==75.8.0'
+
+      - name: Run pyright
+        uses: jakebailey/pyright-action@v2
+        with:
+          version: PATH

REUSE.toml

@@ -53,7 +53,7 @@ SPDX-FileCopyrightText = "2024-2025 Amilcar Lucas, 2025 Jonas Vermeulen"
 SPDX-License-Identifier = "GPL-3.0-or-later"
 
 [[annotations]]
-path = ["cliff.toml", "install_msgfmt.bat", "install_wsl.bash", "pyproject.toml", "pytest.ini", "test_pip_package.sh"]
+path = ["pyrightconfig.json", "install_msgfmt.bat", "install_wsl.bash", "pyproject.toml", "pytest.ini", "test_pip_package.sh"]
 SPDX-FileCopyrightText = "2024-2025 Amilcar Lucas"
 SPDX-License-Identifier = "GPL-3.0-or-later"
 

ardupilot_methodic_configurator/argparse_check_range.py

@@ -36,16 +36,16 @@ def __init__(self, *args, **kwargs) -> None:
 
     def interval(self) -> str:
         if hasattr(self, "min"):
-            _lo = f"[{self.min}"
+            _lo = f"[{self.min}"  # pyright: ignore[reportAttributeAccessIssue]
         elif hasattr(self, "inf"):
-            _lo = f"({self.inf}"
+            _lo = f"({self.inf}"  # pyright: ignore[reportAttributeAccessIssue]
         else:
             _lo = "(-infinity"
 
         if hasattr(self, "max"):
-            _up = f"{self.max}]"
+            _up = f"{self.max}]"  # pyright: ignore[reportAttributeAccessIssue]
         elif hasattr(self, "sup"):
-            _up = f"{self.sup})"
+            _up = f"{self.sup})"  # pyright: ignore[reportAttributeAccessIssue]
         else:
             _up = "+infinity)"
 

ardupilot_methodic_configurator/backend_flightcontroller.py

@@ -80,7 +80,7 @@ def __init__(self, reboot_time: int) -> None:
         self.__reboot_time = reboot_time
         self.__connection_tuples: list[tuple[str, str]] = []
         self.discover_connections()
-        self.master: Union[mavutil.mavlink_connection, None] = None
+        self.master: Union[mavutil.mavlink_connection, None] = None  # pyright: ignore[reportGeneralTypeIssues]
         self.comport: Union[mavutil.SerialPort, None] = None
         self.fc_parameters: dict[str, float] = {}
         self.info = BackendFlightcontrollerInfo()
@@ -583,7 +583,7 @@ def add_argparse_arguments(parser: ArgumentParser) -> ArgumentParser:
                 'If set to "none" no connection is made.'
                 " Default is autodetection"
             ),
-        ).completer = lambda **_: FlightController.__list_serial_ports()
+        ).completer = lambda **_: FlightController.__list_serial_ports()  # pyright: ignore[reportAttributeAccessIssue]
         parser.add_argument(
             "-r",
             "--reboot-time",

ardupilot_methodic_configurator/backend_mavftp.py

@@ -1133,13 +1133,13 @@ def __handle_reset_sessions_reply(self, op, _m) -> MAVFTPReturn:
         """Handle reset sessions reply."""
         return self.__decode_ftp_ack_and_nack(op)
 
-    def process_ftp_reply(self, operation_name, timeout=5) -> MAVFTPReturn:
+    def process_ftp_reply(self, operation_name, timeout: float = 5) -> MAVFTPReturn:
         """Execute an FTP operation that requires processing a MAVLink response."""
         start_time = time.time()
         ret = MAVFTPReturn(operation_name, ERR_Fail)
         recv_timeout = 0.1
         assert (  # noqa: S101
-            timeout == 0 or timeout > self.ftp_settings.idle_detection_time
+            timeout == 0 or timeout > float(self.ftp_settings.idle_detection_time)
         ), "timeout must be > settings.idle_detection_time"
         assert recv_timeout < self.ftp_settings.retry_time, "recv_timeout must be < settings.retry_time"  # noqa: S101
 

ardupilot_methodic_configurator/extract_param_defaults.py

@@ -139,7 +139,7 @@ def extract_parameter_values(logfile: str, param_type: str = "defaults") -> dict
             if not values:
                 raise SystemExit(NO_DEFAULT_VALUES_MESSAGE)
             return values
-        pname = m.Name
+        pname = str(m.Name)
         if len(pname) > PARAM_NAME_MAX_LEN:
             msg = f"Too long parameter name: {pname}"
             raise SystemExit(msg)
@@ -150,14 +150,26 @@ def extract_parameter_values(logfile: str, param_type: str = "defaults") -> dict
         if pname in values:
             continue
         if param_type == "defaults":
-            if hasattr(m, "Default"):
-                values[pname] = m.Default
+            if hasattr(m, "Default") and m.Default is not None:
+                try:
+                    values[pname] = float(m.Default)
+                except ValueError as e:
+                    msg = f"Error converting {m.Default} to float"
+                    raise SystemExit(msg) from e
         elif param_type == "values":
-            if hasattr(m, "Value"):
-                values[pname] = m.Value
+            if hasattr(m, "Value") and m.Value is not None:
+                try:
+                    values[pname] = float(m.Value)
+                except ValueError as e:
+                    msg = f"Error converting {m.Value} to float"
+                    raise SystemExit(msg) from e
         elif param_type == "non_default_values":
-            if hasattr(m, "Value") and hasattr(m, "Default") and m.Value != m.Default:
-                values[pname] = m.Value
+            if hasattr(m, "Value") and hasattr(m, "Default") and m.Value != m.Default and m.Value is not None:
+                try:
+                    values[pname] = float(m.Value)
+                except ValueError as e:
+                    msg = f"Error converting {m.Value} to float"
+                    raise SystemExit(msg) from e
         else:
             msg = f"Invalid type {param_type}"
             raise SystemExit(msg)

ardupilot_methodic_configurator/frontend_tkinter_component_editor.py

@@ -210,6 +210,13 @@ class VoltageTooHighError(Exception):
 }
 
 
+class MockEvent(tk.Event):  # pylint: disable=too-few-public-methods
+    """A mock event object that mirrors the structure of a real tkinter event."""
+
+    def __init__(self, event_type: tk.EventType) -> None:
+        self.type = event_type
+
+
 class ComponentEditorWindow(ComponentEditorWindowBase):
     """
     This class validates the user input and handles user interactions
@@ -750,7 +757,7 @@ def validate_data(self) -> bool:  # pylint: disable=too-many-branches
 
             validate_function = self.get_validate_function(entry, path)
             if validate_function:
-                mock_focus_out_event = type("", (), {"type": "10"})()
+                mock_focus_out_event = MockEvent(tk.EventType.FocusOut)
                 if not validate_function(mock_focus_out_event):
                     invalid_values = True
             if path in {

ardupilot_methodic_configurator/frontend_tkinter_parameter_editor_table.py

@@ -15,6 +15,7 @@
 from logging import critical as logging_critical
 from logging import debug as logging_debug
 from logging import info as logging_info
+from math import nan
 from platform import system as platform_system
 from sys import exit as sys_exit
 from tkinter import messagebox, ttk
@@ -190,8 +191,10 @@ def rename_fc_connection(self, selected_file: str) -> None:
                     messagebox.showinfo(_("Parameter Renamed"), info_msg.format(**locals()))
 
     def __update_table(self, params: dict[str, Par], fc_parameters: dict[str, float]) -> None:
+        current_param_name: str = ""
         try:
             for i, (param_name, param) in enumerate(params.items(), 1):
+                current_param_name = param_name
                 param_metadata = self.local_filesystem.doc_dict.get(param_name, None)
                 param_default = self.local_filesystem.param_default_dict.get(param_name, None)
                 doc_tooltip = (
@@ -227,7 +230,9 @@ def __update_table(self, params: dict[str, Par], fc_parameters: dict[str, float]
             add_button.grid(row=len(params) + 2, column=0, sticky="w", padx=0)
 
         except KeyError as e:
-            logging_critical(_("Parameter %s not found in the %s file: %s"), param_name, self.current_file, e, exc_info=True)
+            logging_critical(
+                _("Parameter %s not found in the %s file: %s"), current_param_name, self.current_file, e, exc_info=True
+            )
             sys_exit(1)
 
         # Configure the table_frame to stretch columns
@@ -640,7 +645,9 @@ def __on_parameter_value_change(self, event: tk.Event, current_file: str, param_
         except KeyError as e:
             logging_critical(_("Parameter %s not found in the %s file: %s"), param_name, current_file, e, exc_info=True)
             sys_exit(1)
-        valid = True
+        valid: bool = True
+        changed: bool = False
+        p: float = nan
         # Check if the input is a valid float
         try:
             p = float(new_value)  # type: ignore[arg-type] # workaround a mypy bug

ardupilot_methodic_configurator/frontend_tkinter_template_overview.py

@@ -136,12 +136,12 @@ def _adjust_treeview_column_widths(self) -> None:
         for col in self.tree["columns"]:
             max_width = 0
             for subtitle in col.title().split("\n"):
-                max_width = max(max_width, tk.font.Font().measure(subtitle))
+                max_width = max(max_width, tk.font.Font().measure(subtitle))  # pyright: ignore[reportAttributeAccessIssue]
 
             # Iterate over all rows and update the max_width if a wider entry is found
             for item in self.tree.get_children():
                 item_text = self.tree.item(item, "values")[self.tree["columns"].index(col)]
-                text_width = tk.font.Font().measure(item_text)
+                text_width = tk.font.Font().measure(item_text)  # pyright: ignore[reportAttributeAccessIssue]
                 max_width = max(max_width, text_width)
 
             # Update the column's width property to accommodate the largest text width

credits/CREDITS.md

@@ -61,6 +61,7 @@ Credits also go to these other software projects that helped in developing ArduP
 - [ruff](https://docs.astral.sh/ruff/): A fast Python linter.
 - [pylint](https://www.pylint.org/): A Python static code analysis tool.
 - [mypy](https://mypy-lang.org/): A static type checker for Python.
+- [pyright](https://github.com/microsoft/pyright): Pyright is a full-featured, standards-based static type checker for Python.
 - [uv](https://docs.astral.sh/uv/): An extremely fast Python package and project manager.
 - [grammarly](https://www.grammarly.com/): An AI-powered writing assistant.
 - [markdown-lint-cli2](https://github.com/DavidAnson/markdownlint-cli2): A command-line tool for linting Markdown files.