feat(args): add command line argument completion.

Add tests to prevent regressions

Author: amilcarlucas

ARCHITECTURE.md

@@ -125,6 +125,7 @@ the following system design requirements were derived:
   - [DevOps](https://en.wikipedia.org/wiki/DevOps)
   - [CI/CD automation](https://en.wikipedia.org/wiki/CI/CD)
   - git pre-commit hooks for code linting and other code quality checks
+  - create command-line autocompletion for bash, zsh and powershell [PR #134](https://github.com/ArduPilot/MethodicConfigurator/pull/134)
 
 ### The Software architecture
 
@@ -467,3 +468,65 @@ or create a gitlab Pull request with the changes to the `.po` file.
 The github [robot will automatically convert that `.po` file into a `.mo` file](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/update_mo_files.yml)
 and create an [*ArduPilot methodic configurator* installer](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/windows_build.yml)
 that you can use to test the translations.
+
+## Install command line completion
+
+### Global python argcomplete
+
+For command line (tab) completion for all python scripts that support [argcomplete](https://github.com/kislyuk/argcomplete) do:
+
+```bash
+activate-global-python-argcomplete
+```
+
+### Fine granular python argcomplete
+
+For Bash autocompletion, add this to your `~/.bashrc`:
+
+```bash
+eval "$(register-python-argcomplete ardupilot_methodic_configurator)"
+eval "$(register-python-argcomplete extract_param_defaults)"
+eval "$(register-python-argcomplete annotate_params)"
+eval "$(register-python-argcomplete param_pid_adjustment_update)"
+eval "$(register-python-argcomplete mavftp)"
+```
+
+For Zsh autocompletion, add these lines to your `~/.zshrc`:
+
+```zsh
+autoload -U bashcompinit
+bashcompinit
+eval "$(register-python-argcomplete ardupilot_methodic_configurator)"
+eval "$(register-python-argcomplete extract_param_defaults)"
+eval "$(register-python-argcomplete annotate_params)"
+eval "$(register-python-argcomplete param_pid_adjustment_update)"
+eval "$(register-python-argcomplete mavftp)"
+```
+
+For PowerShell autocompletion, run this command in PowerShell:
+
+```powershell
+$scripts = @(
+    'ardupilot_methodic_configurator',
+    'extract_param_defaults',
+    'annotate_params',
+    'param_pid_adjustment_update',
+    'mavftp'
+)
+foreach ($script in $scripts) {
+    Register-ArgumentCompleter -Native -CommandName $script -ScriptBlock {
+        param($wordToComplete, $commandAst, $cursorPosition)
+        $command = $script
+        $env:COMP_LINE = $commandAst.ToString()
+        $env:COMP_POINT = $cursorPosition
+        $env:_ARGCOMPLETE = "1"
+        $env:_ARGCOMPLETE_COMP_WORDBREAKS = " `"`'><=;|&(:"
+        $env:COMP_WORDS = $commandAst.ToString()
+        $env:COMP_CWORD = $cursorPosition
+
+        (& python -m argcomplete.completers $command) | ForEach-Object {
+            [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
+        }
+    }
+}
+```

REUSE.toml

@@ -77,6 +77,11 @@ path = "credits/ArduPilot_tempcal_IMU.py-COPYING.txt"
 SPDX-FileCopyrightText = "2024-2025 Amilcar Lucas"
 SPDX-License-Identifier = "GPL-3.0-or-later"
 
+[[annotations]]
+path = "credits/argcomplete-LICENSE.rst"
+SPDX-FileCopyrightText = "2012-2025 Andrey Kislyuk"
+SPDX-License-Identifier = "Apache-2.0"
+
 [[annotations]]
 path = "credits/charset-normalizer-LICENSE"
 SPDX-FileCopyrightText = "Copyright (c) 2019 TAHRI Ahmed R."

ardupilot_methodic_configurator/__main__.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# PYTHON_ARGCOMPLETE_OK
 
 """
 The main application file. calls four sub-applications.
@@ -20,11 +21,13 @@
 from typing import Union
 from webbrowser import open as webbrowser_open
 
+import argcomplete
+
 from ardupilot_methodic_configurator import _, __version__
 from ardupilot_methodic_configurator.backend_filesystem import LocalFilesystem
 from ardupilot_methodic_configurator.backend_filesystem_program_settings import ProgramSettings
 from ardupilot_methodic_configurator.backend_flightcontroller import FlightController
-from ardupilot_methodic_configurator.common_arguments import add_common_arguments_and_parse
+from ardupilot_methodic_configurator.common_arguments import add_common_arguments
 from ardupilot_methodic_configurator.frontend_tkinter_base import show_error_message
 from ardupilot_methodic_configurator.frontend_tkinter_component_editor import ComponentEditorWindow
 from ardupilot_methodic_configurator.frontend_tkinter_connection_selection import ConnectionSelectionWindow
@@ -34,14 +37,12 @@
 from ardupilot_methodic_configurator.middleware_software_updates import UpdateManager, check_for_software_updates
 
 
-def argument_parser() -> argparse.Namespace:
+def create_argument_parser() -> argparse.ArgumentParser:
     """
-    Parses command-line arguments for the script.
-
     This function sets up an argument parser to handle the command-line arguments for the script.
 
     Returns:
-    argparse.Namespace: An object containing the parsed arguments.
+        argparse.ArgumentParser: The argument parser object.
 
     """
     parser = argparse.ArgumentParser(
@@ -63,7 +64,10 @@ def argument_parser() -> argparse.Namespace:
     parser = ComponentEditorWindow.add_argparse_arguments(parser)
     parser = ParameterEditorWindow.add_argparse_arguments(parser)
     parser = UpdateManager.add_argparse_arguments(parser)
-    return add_common_arguments_and_parse(parser)
+    parser = add_common_arguments(parser)
+
+    argcomplete.autocomplete(parser)
+    return parser
 
 
 def connect_to_fc_and_set_vehicle_type(args: argparse.Namespace) -> tuple[FlightController, str]:
@@ -134,7 +138,7 @@ def component_editor(
 
 
 def main() -> None:
-    args = argument_parser()
+    args = create_argument_parser().parse_args()
 
     logging_basicConfig(level=logging_getLevelName(args.loglevel), format="%(asctime)s - %(levelname)s - %(message)s")
 

ardupilot_methodic_configurator/annotate_params.py

@@ -1,4 +1,5 @@
 #!/usr/bin/python3
+# PYTHON_ARGCOMPLETE_OK
 
 """
 Fetches online ArduPilot parameter documentation (if not cached) locally.
@@ -36,6 +37,8 @@
 from typing import Any, Optional, Union
 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
@@ -52,15 +55,15 @@
 # mypy: disable-error-code="unused-ignore"
 
 
-def arg_parser() -> argparse.Namespace:
+def create_argument_parser() -> argparse.ArgumentParser:
     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."
     )
     parser.add_argument(
         "target",
         help="The target file or directory.",
-    )
+    ).completer = FilesCompleter(allowednames=(".param", ".parm"))
     parser.add_argument(
         "-d",
         "--delete-documentation-annotations",
@@ -107,6 +110,13 @@ def arg_parser() -> argparse.Namespace:
         help="Display version information and exit.",
     )
 
+    argcomplete.autocomplete(parser)
+    return parser
+
+
+def parse_arguments() -> argparse.Namespace:
+    parser = create_argument_parser()
+
     args = parser.parse_args()
 
     if args.verbose:
@@ -818,7 +828,7 @@ def parse_parameter_metadata(
 
 
 def main() -> None:
-    args = arg_parser()
+    args = parse_arguments()
     try:
         xml_url = get_xml_url(args.vehicle_type, args.firmware_version)
         xml_dir = get_xml_dir(args.target)

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,
@@ -677,7 +679,7 @@ def add_argparse_arguments(parser: ArgumentParser) -> ArgumentParser:
             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",