Made tokens_for_completion() method public since a couple of our examples use it

Author: tleonhardt

cmd2/cmd2.py

@@ -724,7 +724,7 @@ def _reset_completion_defaults(self) -> None:
             # noinspection PyUnresolvedReferences
             readline.rl.mode._display_completions = self._display_matches_pyreadline
 
-    def _tokens_for_completion(self, line: str, begidx: int, endidx: int) -> Tuple[List[str], List[str]]:
+    def tokens_for_completion(self, line: str, begidx: int, endidx: int) -> Tuple[List[str], List[str]]:
         """
         Used by tab completion functions to get all tokens through the one being completed
         :param line: the current input line with leading whitespace removed
@@ -938,7 +938,7 @@ def flag_based_complete(self, text: str, line: str, begidx: int, endidx: int,
         :return: a list of possible tab completions
         """
         # Get all tokens through the one being completed
-        tokens, _ = self._tokens_for_completion(line, begidx, endidx)
+        tokens, _ = self.tokens_for_completion(line, begidx, endidx)
         if not tokens:
             return []
 
@@ -980,7 +980,7 @@ def index_based_complete(self, text: str, line: str, begidx: int, endidx: int,
         :return: a list of possible tab completions
         """
         # Get all tokens through the one being completed
-        tokens, _ = self._tokens_for_completion(line, begidx, endidx)
+        tokens, _ = self.tokens_for_completion(line, begidx, endidx)
         if not tokens:
             return []
 
@@ -1192,7 +1192,7 @@ def _redirect_complete(self, text: str, line: str, begidx: int, endidx: int, com
 
             # Get all tokens through the one being completed. We want the raw tokens
             # so we can tell if redirection strings are quoted and ignore them.
-            _, raw_tokens = self._tokens_for_completion(line, begidx, endidx)
+            _, raw_tokens = self.tokens_for_completion(line, begidx, endidx)
             if not raw_tokens:
                 return []
 
@@ -1397,7 +1397,7 @@ def _complete_worker(self, text: str, state: int) -> Optional[str]:
                 line = expanded_line
 
                 # Get all tokens through the one being completed
-                tokens, raw_tokens = self._tokens_for_completion(line, begidx, endidx)
+                tokens, raw_tokens = self.tokens_for_completion(line, begidx, endidx)
 
                 # Check if we either had a parsing error or are trying to complete the command token
                 # The latter can happen if " or ' was entered as the command
@@ -1570,7 +1570,7 @@ def _autocomplete_default(self, text: str, line: str, begidx: int, endidx: int,
         """Default completion function for argparse commands."""
         completer = AutoCompleter(argparser, self)
 
-        tokens, _ = self._tokens_for_completion(line, begidx, endidx)
+        tokens, _ = self.tokens_for_completion(line, begidx, endidx)
         if not tokens:
             return []
 
@@ -2607,7 +2607,7 @@ def complete_help_subcommand(self, text: str, line: str, begidx: int, endidx: in
         """Completes the subcommand argument of help"""
 
         # Get all tokens through the one being completed
-        tokens, _ = self._tokens_for_completion(line, begidx, endidx)
+        tokens, _ = self.tokens_for_completion(line, begidx, endidx)
 
         if not tokens:
             return []

examples/tab_autocompletion.py

@@ -382,7 +382,7 @@ def complete_media(self, text, line, begidx, endidx):
                                                      self,
                                                      arg_choices=choices)
 
-        tokens, _ = self._tokens_for_completion(line, begidx, endidx)
+        tokens, _ = self.tokens_for_completion(line, begidx, endidx)
         results = completer.complete_command(tokens, text, line, begidx, endidx)
 
         return results
@@ -443,7 +443,7 @@ def _filter_library(self, text, line, begidx, endidx, full, exclude=()):
     # Demonstrates a custom completion function that does more with the command line than is
     # allowed by the standard completion functions
     def _filter_episodes(self, text, line, begidx, endidx, show_db, user_lib):
-        tokens, _ = self._tokens_for_completion(line, begidx, endidx)
+        tokens, _ = self.tokens_for_completion(line, begidx, endidx)
         show_id = tokens[3]
         if show_id:
             if show_id in show_db:
@@ -530,7 +530,7 @@ def complete_library(self, text, line, begidx, endidx):
                                                      self,
                                                      subcmd_args_lookup=library_subcommand_groups)
 
-        tokens, _ = self._tokens_for_completion(line, begidx, endidx)
+        tokens, _ = self.tokens_for_completion(line, begidx, endidx)
         results = completer.complete_command(tokens, text, line, begidx, endidx)
 
         return results

tests/test_completion.py

@@ -658,7 +658,7 @@ def test_tokens_for_completion_quoted(cmd2_app):
     expected_tokens = ['list_food', 'Pi', '']
     expected_raw_tokens = ['list_food', '"Pi"', '']
 
-    tokens, raw_tokens = cmd2_app._tokens_for_completion(line, begidx, endidx)
+    tokens, raw_tokens = cmd2_app.tokens_for_completion(line, begidx, endidx)
     assert expected_tokens == tokens
     assert expected_raw_tokens == raw_tokens
 
@@ -671,7 +671,7 @@ def test_tokens_for_completion_unclosed_quote(cmd2_app):
     expected_tokens = ['list_food', 'Pi']
     expected_raw_tokens = ['list_food', '"Pi']
 
-    tokens, raw_tokens = cmd2_app._tokens_for_completion(line, begidx, endidx)
+    tokens, raw_tokens = cmd2_app.tokens_for_completion(line, begidx, endidx)
     assert expected_tokens == tokens
     assert expected_raw_tokens == raw_tokens
 
@@ -685,7 +685,7 @@ def test_tokens_for_completion_redirect(cmd2_app):
     expected_tokens = ['command', '|', '<', '>>', 'file']
     expected_raw_tokens = ['command', '|', '<', '>>', 'file']
 
-    tokens, raw_tokens = cmd2_app._tokens_for_completion(line, begidx, endidx)
+    tokens, raw_tokens = cmd2_app.tokens_for_completion(line, begidx, endidx)
     assert expected_tokens == tokens
     assert expected_raw_tokens == raw_tokens
 
@@ -699,7 +699,7 @@ def test_tokens_for_completion_quoted_redirect(cmd2_app):
     expected_tokens = ['command', '>file']
     expected_raw_tokens = ['command', '">file']
 
-    tokens, raw_tokens = cmd2_app._tokens_for_completion(line, begidx, endidx)
+    tokens, raw_tokens = cmd2_app.tokens_for_completion(line, begidx, endidx)
     assert expected_tokens == tokens
     assert expected_raw_tokens == raw_tokens
 
@@ -713,7 +713,7 @@ def test_tokens_for_completion_redirect_off(cmd2_app):
     expected_tokens = ['command', '>file']
     expected_raw_tokens = ['command', '>file']
 
-    tokens, raw_tokens = cmd2_app._tokens_for_completion(line, begidx, endidx)
+    tokens, raw_tokens = cmd2_app.tokens_for_completion(line, begidx, endidx)
     assert expected_tokens == tokens
     assert expected_raw_tokens == raw_tokens