fix(ruff): fix D205 and D404 exceptions

Author: amilcarlucas

ardupilot_methodic_configurator/__main__.py

@@ -47,7 +47,7 @@
 
 def create_argument_parser() -> argparse.ArgumentParser:
     """
-    This function sets up an argument parser to handle the command-line arguments for the script.
+    Argument parser to handle the command-line arguments for the script.
 
     Returns:
         argparse.ArgumentParser: The argument parser object.

ardupilot_methodic_configurator/annotate_params.py

@@ -329,6 +329,7 @@ def export_to_param(formatted_params: list[str], filename_out: str) -> None:
     def print_out(formatted_params: list[str], name: str) -> None:
         """
         Print out the contents of the provided list.
+
         If the list is too large, print only the ones that fit on the screen and
         wait for user input to continue.
 
@@ -564,6 +565,7 @@ def create_doc_dict(root: ET.Element, vehicle_type: str, max_line_length: int =
 def format_columns(values: dict[str, Any], max_width: int = 105, max_columns: int = 4) -> list[str]:
     """
     Formats a dictionary of values into column-major horizontally aligned columns.
+
     It uses at most max_columns columns.
 
     Args:

ardupilot_methodic_configurator/backend_filesystem_program_settings.py

@@ -72,8 +72,7 @@ def create_new_vehicle_dir(new_vehicle_dir: str) -> str:
     @staticmethod
     def valid_directory_name(dir_name: str) -> bool:
         """
-        Check if a given directory name contains only alphanumeric characters, underscores, hyphens,
-        and the OS directory separator.
+        Check if a name contains only alphanumeric characters, underscores, hyphens and the OS directory separator.
 
         This function is designed to ensure that the directory name does not contain characters that are
         invalid for directory names in many operating systems. It does not guarantee that the name

ardupilot_methodic_configurator/backend_filesystem_vehicle_components.py

@@ -31,10 +31,7 @@
 
 
 class VehicleComponents:
-    """
-    This class provides methods to load and save
-    vehicle components configurations from a JSON file.
-    """
+    """Load and save vehicle components configurations from a JSON file."""
 
     def __init__(self, save_component_to_system_templates: bool = False) -> None:
         self.vehicle_components_json_filename = "vehicle_components.json"
@@ -82,6 +79,7 @@ def load_schema(self) -> dict:
     def load_component_templates(self) -> dict[str, list[dict]]:
         """
         Load component templates from both system and user templates directories.
+
         User templates take precedence over system templates.
 
         :return: The merged templates as a dictionary
@@ -161,6 +159,7 @@ def _load_user_templates(self) -> dict[str, list[dict]]:
     def save_component_templates(self, templates: dict) -> tuple[bool, str]:  # pylint: disable=too-many-branches
         """
         Save component templates.
+
         For user templates: Only save templates that are user-modified or not present in system templates.
         For system templates: Merge with existing system templates, adding new ones.
 
@@ -401,8 +400,9 @@ def supported_vehicles() -> tuple[str, ...]:
     @staticmethod
     def get_vehicle_components_overviews() -> dict[str, TemplateOverview]:
         """
-        Finds all subdirectories of the templates base directory containing a
-        "vehicle_components.json" file, creates a dictionary where the keys are
+        Finds all subdirectories of the templates base directory containing a "vehicle_components.json" file.
+
+        Creates a dictionary where the keys are
         the subdirectory names (relative to templates base directory) and the
         values are instances of TemplateOverview.
 

ardupilot_methodic_configurator/backend_flightcontroller_info.py

@@ -126,7 +126,8 @@ def set_capabilities(self, capabilities: int) -> None:
     @staticmethod
     def __decode_flight_sw_version(flight_sw_version: int) -> tuple[int, int, int, str]:
         """
-        Decode 32 bit flight_sw_version mavlink parameter
+        Decode 32 bit flight_sw_version mavlink parameter.
+
         corresponds to ArduPilot encoding in  GCS_MAVLINK::send_autopilot_version.
         """
         fw_type_id = (flight_sw_version >> 0) % 256  # E221, E222
@@ -151,6 +152,7 @@ def __decode_flight_sw_version(flight_sw_version: int) -> tuple[int, int, int, s
     def __decode_flight_capabilities(capabilities: int) -> dict[str, str]:
         """
         Decode 32 bit flight controller capabilities bitmask mavlink parameter.
+
         Returns a dict of concise English descriptions of each active capability.
         """
         capabilities_dict: dict[str, str] = {}

ardupilot_methodic_configurator/battery_cell_voltages.py

@@ -59,7 +59,7 @@
 
 class BatteryCell:
     """
-    This class provides methods to work with battery cell voltages for different chemistries.
+    Battery cell voltages for different chemistries.
 
     It includes methods to get the tuple of chemistries, limit voltages based on chemistry type,
     and get recommended voltages for a given chemistry.

ardupilot_methodic_configurator/frontend_tkinter_component_editor.py

@@ -218,10 +218,7 @@ def __init__(self, event_type: tk.EventType) -> None:
 
 
 class ComponentEditorWindow(ComponentEditorWindowBase):
-    """
-    This class validates the user input and handles user interactions
-    for editing component configurations in the ArduPilot Methodic Configurator.
-    """
+    """Validates the user input and handles user interactions for editing component configurations."""
 
     def __init__(self, version: str, local_filesystem: LocalFilesystem) -> None:
         self.serial_ports = ["SERIAL1", "SERIAL2", "SERIAL3", "SERIAL4", "SERIAL5", "SERIAL6", "SERIAL7", "SERIAL8"]

ardupilot_methodic_configurator/frontend_tkinter_directory_selection.py

@@ -144,6 +144,7 @@ def get_selected_directory(self) -> str:
 class VehicleDirectorySelectionWidgets(DirectorySelectionWidgets):
     """
     A subclass of DirectorySelectionWidgets specifically tailored for selecting vehicle directories.
+
     This class extends the functionality of DirectorySelectionWidgets to handle vehicle-specific
     directory selections. It includes additional logic for updating the local filesystem with the
     selected vehicle directory and re-initializing the filesystem with the new directory.

ardupilot_methodic_configurator/frontend_tkinter_pair_tuple_combobox.py

@@ -37,7 +37,8 @@
 # https://dev.to/geraldew/python-tkinter-an-exercise-in-wrapping-the-combobox-ndb
 class PairTupleCombobox(ttk.Combobox):  # pylint: disable=too-many-ancestors
     """
-    A custom Combobox widget that allows for the display of a list of tuples, where each tuple contains a key and a value.
+    A custom Combobox widget that displays a list of key-value tuples.
+
     This widget processes the list of tuples to separate keys and values for display purposes and allows for the selection
     of a tuple based on its key.
     """

ardupilot_methodic_configurator/frontend_tkinter_parameter_editor.py

@@ -127,10 +127,10 @@ def show_about_window(root: ttk.Frame, _version: str) -> None:  # pylint: disabl
 
 class ParameterEditorWindow(BaseWindow):  # pylint: disable=too-many-instance-attributes
     """
-    This class is responsible for creating and managing the graphical user interface (GUI)
-    for the ArduPilot methodic configurator. It inherits from the BaseWindow class
-    and provides functionalities for displaying and interacting with drone
-    parameters, documentation, and flight controller connection settings.
+    Parameter editor and upload graphical user interface (GUI) window.
+
+    It inherits from the BaseWindow class and displays documentation and edit widgets to
+    operate on drone parameters.
     """
 
     def __init__(self, current_file: str, flight_controller: FlightController, local_filesystem: LocalFilesystem) -> None:

ardupilot_methodic_configurator/param_pid_adjustment_update.py

@@ -73,7 +73,9 @@ def create_argument_parser() -> argparse.ArgumentParser:
 
 def ranged_type(value_type: type, min_value: float, max_value: float) -> Callable:
     """
-    Return function handle of an argument type function for ArgumentParser checking a range:
+    Returns a function handle to check an ArgumentParser argument range.
+
+    An argument type function for ArgumentParser checking a range:
         min_value <= arg <= max_value
     Args:
         value_type  - value-type to convert arg to

ardupilot_methodic_configurator/tempcal_imu.py

@@ -119,10 +119,7 @@ def correction(self, coeff: dict, imu: int, temperature: float, axis: str, cal_t
         return poly(cal_temp - TEMP_REF) - poly(temperature - TEMP_REF)  # type: ignore[no-any-return]
 
     def correction_accel(self, imu: int, temperature: float) -> Vector3:
-        """
-        Calculate accel correction from temperature calibration from
-        log data using parameters.
-        """
+        """Calculate accel correction from temperature calibration from log data using parameters."""
         cal_temp = self.atcal.get(imu, TEMP_REF)
         return Vector3(
             self.correction(self.acoef[imu], imu, temperature, "X", cal_temp),
@@ -131,10 +128,7 @@ def correction_accel(self, imu: int, temperature: float) -> Vector3:
         )
 
     def correction_gyro(self, imu: int, temperature: float) -> Vector3:
-        """
-        Calculate gyro correction from temperature calibration from
-        log data using parameters.
-        """
+        """Calculate gyro correction from temperature calibration from log data using parameters."""
         cal_temp = self.gtcal.get(imu, TEMP_REF)
         return Vector3(
             self.correction(self.gcoef[imu], imu, temperature, "X", cal_temp),

param_reorder.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python3
 
 """
-Inserts and/or removes parameter files in the configuration sequence defined in the configuration_steps_ArduCopter.json file.
+Inserts and/or removes parameter files in the configuration sequence defined in the configuration_steps_ArduCopter.json.
 
 It also replaces all occurrences of the old names with the new names
  in all *.py and *.md files in the current directory.

pyproject.toml

@@ -127,6 +127,7 @@ lint.select = [
     "N",    # pep8-naming
     "D",    # pydocstyle
     "UP",   # pyupgrade
+    #"ERA",  # eradicate
     "YTT",  # flake8-2020
     "ANN",  # flake8-annotations
     "ASYNC",# flake8-async
@@ -141,6 +142,7 @@ lint.select = [
     "T10",  # flake8-debugger
     "EM",   # flake8-errmsg
     "EXE",  # flake8-executable
+    #"FIX",  # flake8-fixme
     "ISC",  # flake8-implicit-str-concat
     "ICN",  # flake8-import-conventions
     "LOG",  # flake8-logging
@@ -154,20 +156,18 @@ lint.select = [
     "RSE",  # flake8-raise (RSE)
     "RET",  # flake8-return (RET)
     "SLF",  # flake8-self (SLF)
-    "SLOT", # flake8-slots (SLOT)
     "SIM",  # flake8-simplify
+    "SLOT", # flake8-slots (SLOT)
     "TID",  # flake8-tidy-imports
+    #"TD",   # flake8-todos
     "TC",   # flake8-type-checking
-    "INT",  # flake8-gettext
     "ARG",  # flake8-unused-arguments
     #"PTH",  # flake8-use-pathlib
-    #"TD",   # flake8-todos
-    #"FIX",  # flake8-fixme
-    #"ERA",  # eradicate
+    "INT",  # flake8-gettext
     "PD",   # pandas-vet
     "PGH",  # pygrep-hooks
     "PL",   # Pylint
-    "FLY002", # flynt
+    "FLY",  # flynt
     "PERF", # Performance-related issues
     "FURB", # refurb
     "DOC",  # pydoclint
@@ -185,9 +185,7 @@ lint.ignore = [
     "D103",    # Missing docstring in public function
     "D107",    # Missing docstring in `__init__`
     "D203",    #
-    "D205",    # 1 blank line required between summary line and description
     "D212",    # Multi-line docstring summary should start at the first line
-    "D404",    # First word of the docstring should not be "This"
     "D401",    # First line of docstring should be in imperative mood
     "COM812",
     "DTZ005",  # `tz=None` passed to `datetime.datetime.now()`

tests/test_configuration_steps_schema.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python3
 
 """
+Validates all configuration_steps_*.json files against a JSON schema.
+
 Finds all configuration_steps_*.json files in the project and its subdirectories, and validates them
 against the JSON schema defined in "ardupilot_methodic_configurator/configuration_steps_schema.json".
 

tests/test_vehicle_components_schema.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python3
 
 """
+Validates all vehicle_components.json files against a JSON schema.
+
 Finds all vehicle_components.json files in the project and its subdirectories, and validates them
 against the JSON schema defined in "ardupilot_methodic_configurator/vehicle_components_schema.json".