Help string support for fish

argcomplete/__init__.py

@@ -199,6 +199,11 @@ def __call__(self, argument_parser, always_complete_options=True, exit_method=os
             debug("Invalid value for IFS, quitting [{v}]".format(v=ifs))
             exit_method(1)
 
+        dfs = os.environ.get("_ARGCOMPLETE_DFS")
+        if dfs and len(dfs) != 1:
+            debug("Invalid value for DFS, quitting [{v}]".format(v=dfs))
+            exit_method(1)
+
         comp_line = os.environ["COMP_LINE"]
         comp_point = int(os.environ["COMP_POINT"])
 
@@ -222,6 +227,12 @@ def __call__(self, argument_parser, always_complete_options=True, exit_method=os
 
         completions = self._get_completions(comp_words, cword_prefix, cword_prequote, last_wordbreak_pos)
 
+        if dfs:
+            display_completions = {key_part: value
+                                   for key, value in self.get_display_completions().items()
+                                   for key_part in key.split(" ")}
+            completions = ["\t".join((key, display_completions.get(key) or "")) for key in completions]
+
         debug("\nReturning completions:", completions)
         output_stream.write(ifs.join(completions).encode(sys_encoding))
         output_stream.flush()

argcomplete/shellintegration.py

@@ -46,6 +46,7 @@
 fishcode = r'''
 function __fish_%(executable)s_complete
     set -x _ARGCOMPLETE 1
+    set -x _ARGCOMPLETE_DFS \t
     set -x _ARGCOMPLETE_IFS \n
     set -x _ARGCOMPLETE_SUPPRESS_SPACE 1
     set -x _ARGCOMPLETE_SHELL fish

test/prog

@@ -31,12 +31,12 @@ def get_comp_point(*args, **kwargs):
 
 parser = argparse.ArgumentParser()
 subparsers = parser.add_subparsers()
-subparsers.add_parser('basic').add_argument('arg', choices=['foo', 'bar', 'baz'])
+subparsers.add_parser('basic', help="basic help").add_argument('arg', choices=['foo', 'bar', 'baz'])
 subparsers.add_parser('space').add_argument('arg', choices=['foo bar', 'baz'])
 subparsers.add_parser('cont').add_argument('arg').completer = complete_cont
 subparsers.add_parser('spec').add_argument('arg', choices=['d$e$f', 'd$e$g', 'x!x', r'y\y'])
 subparsers.add_parser('quote').add_argument('arg', choices=["1'1", '2"2'])
-subparsers.add_parser('break').add_argument('arg', choices=['a:b:c', 'a:b:d'])
+subparsers.add_parser('break', help="break help").add_argument('arg', choices=['a:b:c', 'a:b:d'])
 subparsers.add_parser('env').add_argument('arg').completer = check_environ
 subparsers.add_parser('debug').add_argument('arg').completer = print_output
 subparsers.add_parser('point', add_help=False).add_argument('arg', nargs='*').completer = get_comp_point