Merge pull request #411 from python-cmd2/autocompleter

Fixes problem with not passing the parameter hint suppression down to…

Author: tleonhardt

cmd2/argcomplete_bridge.py

@@ -16,6 +16,7 @@
     except AttributeError:
         DEFAULT_COMPLETER = argcomplete.completers.FilesCompleter()
 
+    from cmd2.argparse_completer import ACTION_ARG_CHOICES, ACTION_SUPPRESS_HINT
     from contextlib import redirect_stdout
     import copy
     from io import StringIO
@@ -245,11 +246,22 @@ def __call__(self, argument_parser, completer=None, always_complete_options=True
                 if comp_type == 63:  # type is 63 for second tab press
                     print(outstr.rstrip(), file=argcomplete.debug_stream, end='')
 
-                output_stream.write(ifs.join([ifs, ' ']).encode(argcomplete.sys_encoding))
+                if completions is not None:
+                    output_stream.write(ifs.join([ifs, ' ']).encode(argcomplete.sys_encoding))
+                else:
+                    output_stream.write(ifs.join([]).encode(argcomplete.sys_encoding))
             else:
                 # if completions is None we assume we don't know how to handle it so let bash
                 # go forward with normal filesystem completion
                 output_stream.write(ifs.join([]).encode(argcomplete.sys_encoding))
             output_stream.flush()
             argcomplete.debug_stream.flush()
             exit_method(0)
+
+
+    def bash_complete(action, show_hint: bool=True):
+        """Helper function to configure an argparse action to fall back to bash completion"""
+        def complete_none(*args, **kwargs):
+            return None
+        setattr(action, ACTION_SUPPRESS_HINT, not show_hint)
+        setattr(action, ACTION_ARG_CHOICES, (complete_none,))

cmd2/argparse_completer.py

@@ -75,6 +75,7 @@ def my_completer(text: str, line: str, begidx: int, endidx:int, extra_param: str
 # attribute that can optionally added to an argparse argument (called an Action) to
 # define the completion choices for the argument. You may provide a Collection or a Function.
 ACTION_ARG_CHOICES = 'arg_choices'
+ACTION_SUPPRESS_HINT = 'suppress_hint'
 
 
 class _RangeAction(object):
@@ -261,6 +262,7 @@ def __init__(self,
                         sub_completers[subcmd] = AutoCompleter(action.choices[subcmd], subcmd_start,
                                                                arg_choices=subcmd_args,
                                                                subcmd_args_lookup=subcmd_lookup,
+                                                               tab_for_arg_help=tab_for_arg_help,
                                                                cmd2_app=cmd2_app)
                         sub_commands.append(subcmd)
                     self._positional_completers[action.dest] = sub_completers
@@ -555,8 +557,19 @@ def _resolve_choices_for_arg(self, action: argparse.Action, used_values=()) -> L
         return []
 
     def _print_action_help(self, action: argparse.Action) -> None:
+        # is parameter hinting disabled globally?
         if not self._tab_for_arg_help:
             return
+
+        # is parameter hinting disabled for this parameter?
+        try:
+            suppress_hint = getattr(action, ACTION_SUPPRESS_HINT)
+        except AttributeError:
+            pass
+        else:
+            if suppress_hint:
+                return
+
         if action.option_strings:
             flags = ', '.join(action.option_strings)
             param = ''

examples/subcommands.py

@@ -19,6 +19,10 @@
 parser_foo = base_subparsers.add_parser('foo', help='foo help')
 parser_foo.add_argument('-x', type=int, default=1, help='integer')
 parser_foo.add_argument('y', type=float, help='float')
+input_file = parser_foo.add_argument('input_file', type=str, help='Input File')
+if __name__ == '__main__':
+    from cmd2.argcomplete_bridge import bash_complete
+    bash_complete(input_file)
 
 # create the parser for the "bar" subcommand
 parser_bar = base_subparsers.add_parser('bar', help='bar help')