Sorting all completion results. Added unit tests for help command.

Author: kmvanbrunt

cmd2.py

@@ -182,14 +182,15 @@ def flag_based_complete(text, line, begidx, endidx, flag_dict, default_completer
                                          being completed
     :return: List[str] - a list of possible tab completions
     """
-    completions = []
 
     # Get all tokens prior to text being completed
     try:
         tokens = shlex.split(line[:begidx], posix=POSIX_SHLEX)
     except ValueError:
         # Invalid syntax for shlex (Probably due to missing closing quote)
-        return completions
+        return []
+
+    completions = []
 
     # Must have at least the command and one argument
     if len(tokens) > 1:
@@ -218,6 +219,7 @@ def flag_based_complete(text, line, begidx, endidx, flag_dict, default_completer
         elif default_completer is not None:
             completions = default_completer(text, line, begidx, endidx)
 
+    completions.sort()
     return completions
 
 
@@ -238,14 +240,15 @@ def index_based_complete(text, line, begidx, endidx, index_dict, default_complet
                                          any index in index_dict
     :return: List[str] - a list of possible tab completions
     """
-    completions = []
 
     # Get all tokens prior to text being completed
     try:
         tokens = shlex.split(line[:begidx], posix=POSIX_SHLEX)
     except ValueError:
         # Invalid syntax for shlex (Probably due to missing closing quote)
-        return completions
+        return []
+
+    completions = []
 
     # Must have at least the command
     if len(tokens) > 0:
@@ -274,6 +277,7 @@ def index_based_complete(text, line, begidx, endidx, index_dict, default_complet
         elif default_completer is not None:
             completions = default_completer(text, line, begidx, endidx)
 
+    completions.sort()
     return completions
 
 
@@ -350,8 +354,8 @@ def path_complete(text, line, begidx, endidx, dir_exe_only=False, dir_only=False
         elif os.path.isdir(path_completions[0]) and add_sep_after_tilde:
             completions[0] = os.path.sep + completions[0]
 
-    # If there are multiple completions, then sort them alphabetically
-    return sorted(completions)
+    completions.sort()
+    return completions
 
 
 class OptionParser(optparse.OptionParser):
@@ -1336,14 +1340,15 @@ def complete_help(self, text, line, begidx, endidx):
         """
         Override of parent class method to handle tab completing subcommands
         """
-        completions = []
 
         # Get all tokens prior to text being completed
         try:
             tokens = shlex.split(line[:begidx], posix=POSIX_SHLEX)
         except ValueError:
             # Invalid syntax for shlex (Probably due to missing closing quote)
-            return completions
+            return []
+
+        completions = []
 
         # If we have "help" and a completed command token, then attempt to match subcommands
         if len(tokens) == 2:
@@ -1362,6 +1367,7 @@ def complete_help(self, text, line, begidx, endidx):
             if len(completions) == 1 and endidx == len(line) and self.get_subcommands(completions[0]) is not None:
                 completions[0] += ' '
 
+        completions.sort()
         return completions
 
     def precmd(self, statement):
@@ -2067,8 +2073,8 @@ def _shell_command_complete(text, line, begidx, endidx):
         if len(exes) == 1 and endidx == len(line):
             exes[0] += ' '
 
-        # If there are multiple completions, then sort them alphabetically
-        return sorted(exes)
+        exes.sort()
+        return exes
 
     def complete_shell(self, text, line, begidx, endidx):
         """Handles tab completion of executable commands and local file system paths.

tests/test_completion.py

@@ -181,28 +181,28 @@ def test_cmd2_help_completion_single_end(cmd2_app):
     endidx = len(line)
     begidx = endidx - len(text)
     # Even though it is at end of line, no extra space is present when tab completing a command name to get help on
-    assert cmd2_app.completenames(text, line, begidx, endidx) == ['help']
+    assert cmd2_app.complete_help(text, line, begidx, endidx) == ['help']
 
 def test_cmd2_help_completion_single_mid(cmd2_app):
     text = 'he'
     line = 'help he'
     begidx = 5
     endidx = 6
-    assert cmd2_app.completenames(text, line, begidx, endidx) == ['help']
+    assert cmd2_app.complete_help(text, line, begidx, endidx) == ['help']
 
 def test_cmd2_help_completion_multiple(cmd2_app):
     text = 'h'
     line = 'help h'
     endidx = len(line)
     begidx = endidx - len(text)
-    assert cmd2_app.completenames(text, line, begidx, endidx) == ['help', 'history']
+    assert cmd2_app.complete_help(text, line, begidx, endidx) == ['help', 'history']
 
 def test_cmd2_help_completion_nomatch(cmd2_app):
     text = 'z'
     line = 'help z'
     endidx = len(line)
     begidx = endidx - len(text)
-    assert cmd2_app.completenames(text, line, begidx, endidx) == []
+    assert cmd2_app.complete_help(text, line, begidx, endidx) == []
 
 def test_shell_command_completion(cmd2_app):
     if sys.platform == "win32":
@@ -539,7 +539,7 @@ def get_endidx():
                 # Run the readline tab-completion function with readline mocks in place
                 first_match = sc_app.complete(text, state)
 
-    assert first_match is not None and sc_app.completion_matches == ['foo', 'bar']
+    assert first_match is not None and sc_app.completion_matches == ['bar', 'foo']
 
 def test_cmd2_subcommand_completion_nomatch(sc_app):
     text = 'z'
@@ -612,3 +612,33 @@ def get_endidx():
                 first_match = sc_app.complete(text, state)
 
     assert first_match is not None and sc_app.completion_matches == ['foo ']
+
+def test_cmd2_help_subcommand_completion_single_end(sc_app):
+    text = 'base'
+    line = 'help base'
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    # Commands with subcommands have a space at the end when the cursor is at the end of the line
+    assert sc_app.complete_help(text, line, begidx, endidx) == ['base ']
+
+def test_cmd2_help_subcommand_completion_single_mid(sc_app):
+    text = 'ba'
+    line = 'help base'
+    begidx = 5
+    endidx = 6
+    assert sc_app.complete_help(text, line, begidx, endidx) == ['base']
+
+def test_cmd2_help_subcommand_completion_multiple(sc_app):
+    text = ''
+    line = 'help base'
+    endidx = len(line)
+    begidx = endidx - len(text)
+    assert sc_app.complete_help(text, line, begidx, endidx) == ['bar', 'foo']
+
+def test_cmd2_help_subcommand_completion_nomatch(sc_app):
+    text = 'z'
+    line = 'help base z'
+    endidx = len(line)
+    begidx = endidx - len(text)
+    assert sc_app.complete_help(text, line, begidx, endidx) == []