feat(args): add argument data completion. Add tests to prevent regressions

Author: amilcarlucas

ardupilot_methodic_configurator/annotate_params.py

@@ -37,6 +37,7 @@
 from xml.etree import ElementTree as ET  # no parsing, just data-structure manipulation
 
 import argcomplete
+from argcomplete.completers import FilesCompleter
 from defusedxml import ElementTree as DET  # noqa: N814, just parsing, no data-structure manipulation
 
 # URL of the XML file
@@ -61,7 +62,7 @@ def create_argument_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "target",
         help="The target file or directory.",
-    )
+    ).completer = FilesCompleter(allowednames=(".param", ".parm"))
     parser.add_argument(
         "-d",
         "--delete-documentation-annotations",
@@ -80,21 +81,31 @@ def create_argument_parser() -> argparse.ArgumentParser:
         choices=["none", "missionplanner", "mavproxy"],
         default="none",
         help="Sort the parameters in the file. Default is %(default)s.",
-    )
+    ).completer = lambda **_: ["none", "missionplanner", "mavproxy"]
     parser.add_argument(
         "-t",
         "--vehicle-type",
         choices=["AP_Periph", "AntennaTracker", "ArduCopter", "ArduPlane", "ArduSub", "Blimp", "Heli", "Rover", "SITL"],
         default="ArduCopter",
         help="The type of the vehicle. Default is %(default)s.",
-    )
+    ).completer = lambda **_: [
+        "AP_Periph",
+        "AntennaTracker",
+        "ArduCopter",
+        "ArduPlane",
+        "ArduSub",
+        "Blimp",
+        "Heli",
+        "Rover",
+        "SITL",
+    ]
     parser.add_argument(
         "-m",
         "--max-line-length",
         type=int,
         default=100,
         help="Maximum documentation line length. Default is %(default)s.",
-    )
+    ).choices = range(80, 121)
     parser.add_argument(
         "--verbose",
         action="store_true",

ardupilot_methodic_configurator/backend_filesystem.py

@@ -26,6 +26,8 @@
 from typing import Any, Optional
 from zipfile import ZipFile
 
+from argcomplete.completers import DirectoriesCompleter
+
 from ardupilot_methodic_configurator import _
 from ardupilot_methodic_configurator.annotate_params import (
     PARAM_DEFINITION_XML_FILE,
@@ -669,15 +671,15 @@ def add_argparse_arguments(parser: ArgumentParser) -> ArgumentParser:
             choices=VehicleComponents.supported_vehicles(),
             default="",
             help=_("The type of the vehicle. Default is ArduCopter"),
-        )
+        ).choices = lambda **_: VehicleComponents.supported_vehicles()
         parser.add_argument(
             "--vehicle-dir",
             type=str,
             default=os_getcwd(),
             help=_(
                 "Directory containing vehicle-specific intermediate parameter files. Default is the current working directory"
             ),
-        )
+        ).completer = DirectoriesCompleter()
         parser.add_argument(
             "--n",
             type=int,

ardupilot_methodic_configurator/backend_flightcontroller.py

@@ -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()
         parser.add_argument(
             "-r",
             "--reboot-time",
@@ -593,5 +593,5 @@ def add_argparse_arguments(parser: ArgumentParser) -> ArgumentParser:
             action=CheckRange,
             default=7,
             help=_("Flight controller reboot time. Default is %(default)s"),
-        )
+        ).choices = range(5, 51)
         return parser