Small shell improvements (slcli shell)

sudorandom · sudorandom · commit ed7b2812cf41 · 2015-12-18T09:07:25.000-06:00
* Adds descriptions to autocomplete list commands and options
* Adds autosuggestion to slcli shell
* Enable mouse support for slcli shell
diff --git a/SoftLayer/CLI/core.py b/SoftLayer/CLI/core.py
@@ -44,11 +44,17 @@ def __init__(self, *path, **attrs):
         click.MultiCommand.__init__(self, **attrs)
         self.path = path
 
-    def list_commands(self, ctx):
-        """Get module for click."""
+    def list_commands(self, ctx, **kwargs):
+        """List all sub-commands."""
         env = ctx.ensure_object(environment.Environment)
         env.load()
-        return sorted(env.list_commands(*self.path))
+
+        commands = env.list_commands(*self.path)
+
+        if kwargs.get('with_aliases', False) and len(self.path) == 0:
+            commands.extend(env.aliases.keys())
+
+        return sorted(commands)
 
     def get_command(self, ctx, name):
         """Get command for click."""
diff --git a/SoftLayer/CLI/routes.py b/SoftLayer/CLI/routes.py
@@ -198,7 +198,6 @@
     'vm': 'vs',
     'hardware': 'server',
     'hw': 'server',
-    'bmetal': 'bmc',
     'virtual': 'vs',
     'lb': 'loadbal',
 }
diff --git a/SoftLayer/shell/completer.py b/SoftLayer/shell/completer.py
@@ -5,6 +5,7 @@
 
     :license: MIT, see LICENSE for more details.
 """
+import itertools
 import shlex
 
 import click
@@ -27,30 +28,29 @@ def _click_autocomplete(root, text):
     try:
         parts = shlex.split(text)
     except ValueError:
-        return []
+        raise StopIteration
 
     location, incomplete = _click_resolve_command(root, parts)
 
     if not text.endswith(' ') and not incomplete and text:
-        return []
+        raise StopIteration
 
-    options = []
     if incomplete and not incomplete[0:2].isalnum():
         for param in location.params:
             if not isinstance(param, click.Option):
                 continue
-            options.extend(param.opts)
-            options.extend(param.secondary_opts)
+            for opt in itertools.chain(param.opts, param.secondary_opts):
+                if opt.startswith(incomplete):
+                    yield completion.Completion(opt, -len(incomplete),
+                                                display_meta=param.help)
+
     elif isinstance(location, (click.MultiCommand, click.core.Group)):
-        options.extend(location.list_commands(click.Context(location)))
-
-    # collect options that starts with the incomplete section
-    completions = []
-    for option in options:
-        if option.startswith(incomplete):
-            completions.append(
-                completion.Completion(option, -len(incomplete)))
-    return completions
+        ctx = click.Context(location)
+        for command in location.list_commands(ctx):
+            if command.startswith(incomplete):
+                cmd = location.get_command(ctx, command)
+                yield completion.Completion(command, -len(incomplete),
+                                            display_meta=cmd.short_help)
 
 
 def _click_resolve_command(root, parts):
diff --git a/SoftLayer/shell/core.py b/SoftLayer/shell/core.py
@@ -13,6 +13,7 @@
 import traceback
 
 import click
+from prompt_toolkit import auto_suggest as p_auto_suggest
 from prompt_toolkit import history as p_history
 from prompt_toolkit import shortcuts as p_shortcuts
 
@@ -52,10 +53,12 @@ def cli(ctx, env):
 
     while True:
         try:
-            line = p_shortcuts.get_input(
+            line = p_shortcuts.prompt(
                 u"(%s)> " % env.vars['last_exit_code'],
                 completer=complete,
                 history=history,
+                auto_suggest=p_auto_suggest.AutoSuggestFromHistory(),
+                mouse_support=True,
             )
             try:
                 args = shlex.split(line)
diff --git a/setup.py b/setup.py
@@ -35,7 +35,7 @@
         'prettytable >= 0.7.0',
         'click >= 5',
         'requests >= 2.7.0',
-        'prompt_toolkit',
+        'prompt_toolkit >= 0.53',
     ],
     keywords=['softlayer', 'cloud'],
     classifiers=[

Original file line number	Diff line number	Diff line change
`@@ -198,7 +198,6 @@`
`198`	`198`	`'vm': 'vs',`
`199`	`199`	`'hardware': 'server',`
`200`	`200`	`'hw': 'server',`
`201`		`- 'bmetal': 'bmc',`
`202`	`201`	`'virtual': 'vs',`
`203`	`202`	`'lb': 'loadbal',`
`204`	`203`	`}`