Fixed a bug with duplicate options

Author: joguSD

awsshell/interaction.py

@@ -75,11 +75,12 @@ def execute(self, data):
             raise InteractionException('SimpleSelect expects a non-empty list')
         if self._model.get('Path') is not None:
             display_data = jmespath.search(self._model['Path'], data)
-            option_dict = dict(zip(display_data, data))
-            selected = self._prompter('%s ' % self.prompt, display_data)
-            return option_dict[selected]
+            result = self._prompter('%s ' % self.prompt, display_data)
+            (selected, index) = result
+            return data[index]
         else:
-            return self._prompter('%s ' % self.prompt, data)
+            (selected, index) = self._prompter('%s ' % self.prompt, data)
+            return selected
 
 
 class SimplePrompt(Interaction):

awsshell/selectmenu.py

@@ -50,6 +50,9 @@ def __init__(self, options):
         self.height = len(options)
         self._selection = None
 
+    def get_index(self):
+        return self._selection
+
     def get_selection(self):
         """Return the currently selected option, if there is one."""
         if self._selection is not None:
@@ -77,6 +80,7 @@ def select_up(self, event=None):
 
     def _insert_text(self, event):
         if event is not None:
+            event.current_buffer.reset()
             event.current_buffer.document = Document(self.get_selection())
 
     def preferred_width(self, cli, max_available_width):
@@ -121,7 +125,27 @@ def _get_menu_item_tokens(self, option, is_current):
 def create_select_menu_layout(msg, menu_control,
                               show_meta=False,
                               reserve_space_for_menu=True):
-    """Construct a layout for the given message and menu control."""
+    """Construct a layout for the given message and menu control.
+
+    :type msg: str
+    :param msg: The message to be used when showing the prompt.
+
+    :type msg: :class:`SelectMenuControl`
+    :param msg: The menu controller that manages the state and rendering of the
+    currently selected option.
+
+    :type show_meta: bool
+    :param show_meta: (Optional) Whether or not the meta information should be
+    displayed below the prompt.
+
+    :type reserve_space_for_menu: bool
+    :param reserve_space_for_menu: (Optional) Whether or not the prompt should
+    force that there be enough lines for the completion menu to completely
+    render.
+
+    :rtype: :class:`prompt_toolkit.layout.containers.Container`
+    :return: The layout to be used for a select menu prompt.
+    """
     def get_prompt_tokens(cli):
         return [(Token.Prompt, msg)]
 
@@ -201,7 +225,7 @@ def __init__(self, message, options, *args, **kwargs):
 
         # create and apply the default and info buffers
         options_meta = kwargs.pop('options_meta', None)
-        kwargs['buffers'] = self._initialize_buffers(options_meta)
+        kwargs['buffers'] = self._initialize_buffers(options, options_meta)
 
         # create and apply the new layout
         kwargs['layout'] = create_select_menu_layout(
@@ -212,10 +236,12 @@ def __init__(self, message, options, *args, **kwargs):
 
         super(SelectMenuApplication, self).__init__(*args, **kwargs)
 
-    def _initialize_buffers(self, options_meta):
+    def _initialize_buffers(self, options, options_meta):
         # Return the currently selected option
         def return_selection(cli, buf):
-            cli.set_return_value(self.menu_control.get_selection())
+            selection = self.menu_control.get_selection()
+            index = self.menu_control.get_index()
+            cli.set_return_value((selection, index))
 
         buffers = {}
 
@@ -228,11 +254,13 @@ def return_selection(cli, buf):
 
         # Optionally show meta information if present
         if options_meta is not None:
+            assert len(options) == len(options_meta)
             info_buf = Buffer(is_multiline=True)
             buffers['INFO'] = info_buf
 
             def selection_changed(cli):
-                info = options_meta[buffers[DEFAULT_BUFFER].text]
+                index = self.menu_control.get_index()
+                info = options_meta[index]
                 formatted_info = json.dumps(info, indent=4, sort_keys=True,
                                             ensure_ascii=False)
                 buffers['INFO'].text = formatted_info
@@ -277,7 +305,22 @@ def _(_):
 
 
 def select_prompt(message, options, *args, **kwargs):
-    """Construct and run the select menu application, returning the result."""
+    """Construct and run the select menu application, returning the result.
+
+    :type message: str
+    :param message: The message to be used when showing the prompt.
+
+    :type options: list of str
+    :param options: The options to be displayed in the drop down list.
+
+    :type options_meta: list of dict
+    :param options_meta: (Optional) List of detailed objects for each option in
+    the list. This list is parallel to options and must equal in length.
+
+    :rtype: tuple of (str, int)
+    :return: The tuple containing the selected option, and its index in the
+    list of options.
+    """
     runner = kwargs.pop('runner', run_application)
     app = SelectMenuApplication(message, options, *args, **kwargs)
     return runner(app)

tests/integration/test_selectmenu.py

@@ -88,7 +88,7 @@ def test_select_menu_application_accept(cli):
     # move selection down then accept
     feed_key(cli, Keys.Down)
     feed_key(cli, Keys.ControlJ)
-    assert cli.return_value() == '1'
+    assert cli.return_value() == ('1', 0)
 
 
 def test_select_menu_application_any(cli):
@@ -104,7 +104,7 @@ def test_select_menu_application_any(cli):
 
 def test_select_menu_application_with_meta(pipe_input, make_cli):
     # test that selecting an option when theres info will render it
-    meta = {'opt': {'key': u'val'}}
+    meta = [{'key': u'val'}]
     app = SelectMenuApplication(u'prompt', [u'opt'], options_meta=meta)
     cli = make_cli(app=app, cli_input=pipe_input)
     feed_key(cli, Keys.Down)

tests/unit/test_interaction.py

@@ -79,7 +79,7 @@ def test_simple_select():
     prompt = mock.Mock()
     selector = SimpleSelect({}, 'one or two?', prompt)
     options = ['one', 'two']
-    prompt.return_value = options[1]
+    prompt.return_value = (options[1], 1)
     xformed = selector.execute(options)
     assert prompt.call_count == 1
     assert xformed == options[1]
@@ -92,7 +92,7 @@ def test_simple_select_with_path():
     model = {'Path': '[].a'}
     simple_selector = SimpleSelect(model, 'Promptingu', prompt)
     options = [{'a': '1', 'b': 'one'}, {'a': '2', 'b': 'two'}]
-    prompt.return_value = '2'
+    prompt.return_value = ('2', 1)
     xformed = simple_selector.execute(options)
     assert prompt.call_count == 1
     assert xformed == options[1]