Flag which options are required

Author: jamesls

awsshell/__init__.py

@@ -45,9 +45,14 @@ def get_completions(self, document, complete_event):
         if text_before_cursor.strip():
             word_before_cursor = text_before_cursor.split()[-1]
         completions = self._completer.autocomplete(text_before_cursor)
+        required_args = set(self._completer.required_args)
         for completion in completions:
+            if completion.startswith('--') and completion in required_args:
+                display_text = '%s (required)' % completion
+            else:
+                display_text = completion
             yield Completion(completion, -len(word_before_cursor),
-                             display_meta='')
+                             display=display_text)
 
 
 def main():
@@ -61,6 +66,7 @@ def main():
     while True:
         try:
             text = get_input('aws> ', completer=completer,
+                             display_completions_in_columns=True,
                              history=history)
         except (KeyboardInterrupt, EOFError):
             break

awsshell/autocomplete.py

@@ -28,6 +28,11 @@ def __init__(self, index_data):
         self._last_position = 0
         self._current_line = ''
 
+    @property
+    def required_args(self):
+        # Returns the required arguments for the current level.
+        return self._current['required_arguments']
+
     def reset(self):
         # Resets all the state.  Called after a user runs
         # a command.

awsshell/makeindex.py

@@ -13,18 +13,21 @@
 from awsshell import determine_index_filename
 
 
-# arguments/commands are used for completions
-# children is used for further indexing of subcommands.
-INDEX = {'aws': {'arguments': [], 'commands': [], 'children': {}}}
+def new_index():
+    return {'arguments': [], 'required_arguments': [],
+            'commands': [], 'children': {}}
 
 
 def index_command(index_dict, help_command):
-    for arg in help_command.arg_table:
+    arg_table = help_command.arg_table
+    for arg in arg_table:
+        if arg_table[arg].required:
+            index_dict['required_arguments'].append('--%s' % arg)
         index_dict['arguments'].append('--%s' % arg)
     for cmd in help_command.command_table:
         index_dict['commands'].append(cmd)
         # Each sub command will trigger a recurse.
-        child = {'arguments': [], 'commands': [], 'children': {}}
+        child = new_index()
         index_dict['children'][cmd] = child
         sub_command = help_command.command_table[cmd]
         sub_help_command = sub_command.create_help_command()
@@ -40,10 +43,11 @@ def main():
         args.output = determine_index_filename()
     driver = awscli.clidriver.create_clidriver()
     help_command = driver.create_help_command()
-    current = INDEX['aws']
+    index = {'aws': new_index()}
+    current = index['aws']
     index_command(current, help_command)
 
-    result = pprint.pformat(INDEX)
+    result = pprint.pformat(index)
     if not os.path.isdir(os.path.dirname(args.output)):
         os.makedirs(os.path.dirname(args.output))
     with open(args.output, 'w') as f: