Merge pull request #1362 from common-workflow-language/argcomplete

Added argcomplete

Author: mr-c

cwltool/main.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 """Entry point for cwltool."""
 
+import argcomplete
 import argparse
 import functools
 import io
@@ -100,7 +101,7 @@
     windows_default_container_id,
 )
 from .workflow import Workflow
-
+# PYTHON_ARGCOMPLETE_OK
 
 def _terminate_processes() -> None:
     """Kill all spawned processes.
@@ -396,7 +397,7 @@ def init_job_order(
                 k: v for k, v in cmd_line.items() if k.startswith(record_name)
             }
             for key, value in record_items.items():
-                record[key[len(record_name) + 1 :]] = value
+                record[key[len(record_name) + 1:]] = value
                 del cmd_line[key]
             cmd_line[str(record_name)] = record
         if "job_order" in cmd_line and cmd_line["job_order"]:
@@ -854,7 +855,9 @@ def main(
             addl = []  # type: List[str]
             if "CWLTOOL_OPTIONS" in os.environ:
                 addl = os.environ["CWLTOOL_OPTIONS"].split(" ")
-            args = arg_parser().parse_args(addl + argsl)
+            parser = arg_parser()
+            argcomplete.autocomplete(parser)
+            args = parser.parse_args(addl + argsl)
             if args.record_container_id:
                 if not args.cidfile_dir:
                     args.cidfile_dir = os.getcwd()
@@ -895,7 +898,7 @@ def main(
                 args.workflow = "CWLFile"
             else:
                 _logger.error("CWL document required, no input file was provided")
-                arg_parser().print_help()
+                parser.print_help()
                 return 1
         if args.relax_path_checks:
             command_line_tool.ACCEPTLIST_RE = command_line_tool.ACCEPTLIST_EN_RELAXED_RE

setup.py

@@ -105,6 +105,7 @@
         "typing-extensions",
         "coloredlogs",
         "pydot >= 1.4.1",
+        "argcomplete",
     ],
     extras_require={
         "deps": ["galaxy-tool-util"],

typeshed/3/argcomplete/__init__.pyi

@@ -0,0 +1,22 @@
+from typing import Any, Optional
+import argparse
+class CompletionFinder:
+    always_complete_options: Any = ...
+    exclude: Any = ...
+    validator: Any = ...
+    print_suppressed: Any = ...
+    completing: bool = ...
+    default_completer: Any = ...
+    append_space: Any = ...
+    def __init__(self, argument_parser: Optional[argparse.ArgumentParser] = ..., always_complete_options: bool = ..., exclude: Optional[Any] = ..., validator: Optional[Any] = ..., print_suppressed: bool = ..., default_completer: Any = ..., append_space: Optional[Any] = ...) -> None: ...
+    def __call__(self, argument_parser: argparse.ArgumentParser, always_complete_options: bool = ..., exit_method: Any = ..., output_stream: Optional[Any] = ..., exclude: Optional[Any] = ..., validator: Optional[Any] = ..., print_suppressed: bool = ..., append_space: Optional[Any] = ..., default_completer: Any = ...) -> None: ...
+    def collect_completions(self, active_parsers: Any, parsed_args: Any, cword_prefix: Any, debug: Any): ...
+    def filter_completions(self, completions: Any): ...
+    def quote_completions(self, completions: Any, cword_prequote: Any, last_wordbreak_pos: Any): ...
+    def rl_complete(self, text: Any, state: Any): ...
+    def get_display_completions(self): ...
+
+class ExclusiveCompletionFinder(CompletionFinder): ...
+
+autocomplete: CompletionFinder
+