Detect case where non-consecutive chars occur

Shouldn't happen with normal prompt_toolkit invocations,
but still want to handle this gracefully.

Author: jamesls

awsshell/__init__.py

@@ -63,7 +63,7 @@ def main():
     index_data = load_index(index_file)
     doc_data = docs.load_doc_index(doc_index_file)
     completer = shellcomplete.AWSShellCompleter(
-        autocomplete.AWSCLICompleter(index_data))
+        autocomplete.AWSCLIModelCompleter(index_data))
     history = InMemoryHistory()
     shell = app.create_aws_shell(completer, history, doc_data)
     shell.run()

awsshell/autocomplete.py

@@ -1,7 +1,13 @@
 from awsshell.fuzzy import fuzzy_search
 
 
-class AWSCLICompleter(object):
+class AWSCLIModelCompleter(object):
+    """Autocompletion based on the JSON models for AWS services.
+
+    This class consumes indexed data based on the JSON models from
+    AWS service (which we pull through botocore's data loaders).
+
+    """
     def __init__(self, index_data):
         self._index = index_data
         self._root_name = 'aws'
@@ -42,6 +48,8 @@ def autocomplete(self, line):
             # The user has hit backspace.  We'll need to check
             # the current words.
             return self._handle_backspace()
+        elif current_length != self._last_position + 1:
+            return self._complete_from_full_parse()
 
         # This position is important.  We only update the _last_position
         # after we've checked the special cases above where that value
@@ -108,7 +116,7 @@ def _complete_from_full_parse(self):
         # can be optimized.
         self.reset()
         line = self._current_line
-        for i in range(len(self._current_line)):
+        for i in range(1, len(self._current_line)):
             self.autocomplete(line[:i])
         return self.autocomplete(line)
 

awsshell/shellcomplete.py

@@ -16,7 +16,7 @@ class AWSShellCompleter(Completer):
     """Completer class for the aws-shell.
 
     This is the completer used specifically for the aws shell.
-    Not to be confused with the AWSCLICompleter, which is more
+    Not to be confused with the AWSCLIModelCompleter, which is more
     low level, and can be reused in contexts other than the
     aws shell.
     """
@@ -43,10 +43,12 @@ def get_completions(self, document, complete_event):
         text_before_cursor = document.text_before_cursor
         word_before_cursor = ''
         if text_before_cursor.strip():
-            word_before_cursor = text_before_cursor.split()[-1]
+            word_before_cursor = text_before_cursor.strip().split()[-1]
         completions = self._completer.autocomplete(text_before_cursor)
         arg_meta = self._completer.arg_metadata
         for completion in completions:
+            # Go through the completions and add inline docs and
+            # mark which options are required.
             if completion.startswith('--') and completion in arg_meta:
                 # TODO: Need to handle merging in global options as well.
                 meta = arg_meta[completion]

tests/test_completions.py

@@ -1,5 +1,5 @@
 import pytest
-from awsshell.autocomplete import AWSCLICompleter
+from awsshell.autocomplete import AWSCLIModelCompleter
 
 @pytest.fixture
 def index_data():
@@ -14,19 +14,19 @@ def index_data():
 
 def test_completes_service_names(index_data):
     index_data['aws']['commands'] = ['first', 'second']
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     assert completer.autocomplete('fi') == ['first']
 
 
 def test_completes_multiple_service_names(index_data):
     index_data['aws']['commands'] = ['abc', 'acd', 'b']
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     assert completer.autocomplete('a') == ['abc', 'acd']
 
 
 def test_no_completion(index_data):
     index_data['aws']['commands'] = ['foo', 'bar']
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     assert completer.autocomplete('baz') == []
 
 
@@ -39,7 +39,7 @@ def test_can_complete_subcommands(index_data):
             'children': {},
         }
     }
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     # The completer tracks state to optimize lookups,
     # so we simulate exactly how it's called.
     completer.autocomplete('e')
@@ -61,7 +61,7 @@ def test_everything_completed_on_space(index_data):
             'children': {},
         }
     }
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     completer.autocomplete('e')
     completer.autocomplete('ec')
     completer.autocomplete('ec2')
@@ -71,13 +71,13 @@ def test_everything_completed_on_space(index_data):
 
 def test_autocomplete_top_leve_services_on_space(index_data):
     index_data['aws']['commands'] = ['first', 'second']
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     assert completer.autocomplete(' ') == ['first', 'second']
 
 
 def test_reset_auto_complete(index_data):
     index_data['aws']['commands'] = ['first', 'second']
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     completer.autocomplete('f')
     completer.autocomplete('fi')
     completer.autocomplete('fir')
@@ -95,7 +95,7 @@ def test_reset_after_subcommand_completion(index_data):
             'children': {},
         }
     }
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     # The completer tracks state to optimize lookups,
     # so we simulate exactly how it's called.
     completer.autocomplete('e')
@@ -127,7 +127,7 @@ def test_can_handle_entire_line_deleted(index_data):
             'children': {},
         }
     }
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     c = completer.autocomplete
     c('e')
     c('ec')
@@ -145,7 +145,7 @@ def test_can_handle_entire_line_deleted(index_data):
 
 def test_autocompletes_argument_names(index_data):
     index_data['aws']['arguments'] = ['--query', '--debug']
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     # These should only appear once in the output.  So we need
     # to know if we're a top level argument or not.
     assert completer.autocomplete('-') == ['--query', '--debug']
@@ -162,7 +162,7 @@ def test_autocompletes_global_and_service_args(index_data):
             'children': {},
         }
     }
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     c = completer.autocomplete
     c('e')
     c('ec')
@@ -184,10 +184,10 @@ def test_can_mix_options_and_commands(index_data):
             'children': {},
         }
     }
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     c = completer.autocomplete
     partial_cmd = 'ec2 --no-validate-ssl'
-    for i in range(len(partial_cmd)):
+    for i in range(1, len(partial_cmd)):
         c(partial_cmd[:i])
 
     assert c('ec2 --no-validate-ssl ') == ['create-tags', 'describe-instances']
@@ -209,12 +209,46 @@ def test_only_change_context_when_in_index(index_data):
             'arguments': [],
         }
     }
-    completer = AWSCLICompleter(index_data)
+    completer = AWSCLIModelCompleter(index_data)
     c = completer.autocomplete
     partial_cmd = 'ec2 --region us-west-2'
-    for i in range(len(partial_cmd)):
+    for i in range(1, len(partial_cmd)):
         c(partial_cmd[:i])
 
     # We should ignore "us-west-2" because it's not a child
     # of ec2.
     assert c('ec2 --region us-west-2 ') == ['create-tags', 'describe-instances']
+
+
+def test_can_handle_skips_in_completion(index_data):
+    # Normally, completion is always requested char by char.
+    # Typing "ec2 describe-inst"
+    # will subsequent calls to the autocompleter:
+    # 'e', 'ec', 'ec2', 'ec2 ', 'ec2 d', 'ec2 de' ... all the way
+    # up to 'ec2 describe-inst'.
+    # However, the autocompleter should gracefully handle when there's
+    # skips, so two subsequent calls are 'ec' and then 'ec2 describe-ta',
+    # the autocompleter should still do the right thing.  The tradeoff
+    # will just be that this case will be slower than the common case
+    # of char by char additions.
+    index_data['aws']['commands'] = ['ec2']
+    index_data['aws']['children'] = {
+        'ec2': {
+            'commands': ['create-tags', 'describe-instances'],
+            'argument_metadata': {},
+            'arguments': [],
+            'children': {
+                'create-tags': {
+                    'argument_metadata': {
+                        '--resources': {'example': '', 'minidoc': 'foo'},
+                        '--tags': {'example': 'bar', 'minidoc': 'baz'},
+                    },
+                    'arguments': ['--resources', '--tags'],
+                }
+            },
+        }
+    }
+    completer = AWSCLIModelCompleter(index_data)
+    c = completer.autocomplete
+    result = c('ec2 create-ta')
+    assert result == ['create-tags']