Began work to minimize public API

Author: tleonhardt

cmd2/cmd2.py

@@ -24,3 +24,5 @@
 COLORS_NEVER = 'Never'
 COLORS_TERMINAL = 'Terminal'
 COLORS_ALWAYS = 'Always'
+
+DEFAULT_SHORTCUTS = {'?': 'help', '!': 'shell', '@': 'run_script', '@@': '_relative_run_script'}

cmd2/constants.py

@@ -324,7 +324,7 @@ def is_valid_command(self, word: str) -> Tuple[bool, str]:
         This string is suitable for inclusion in an error message of your
         choice:
 
-        valid, errmsg = statement_parser.is_valid_command('>')
+        valid, errmsg = _statement_parser.is_valid_command('>')
         if not valid:
             errmsg = "Alias {}".format(errmsg)
         """
@@ -494,7 +494,7 @@ def parse(self, line: str, expand: bool = True) -> Statement:
                 output = constants.REDIRECTION_APPEND
                 output_index = append_index
 
-            # Check if we are redirecting to a file
+            # Check if we are _redirecting to a file
             if len(tokens) > output_index + 1:
                 unquoted_path = utils.strip_quotes(tokens[output_index + 1])
                 if unquoted_path:

cmd2/parsing.py

@@ -97,7 +97,7 @@ def __call__(self, command: str, echo: Optional[bool] = None) -> CommandResult:
                 with redirect_stderr(copy_stderr):
                     stop = self._cmd2_app.onecmd_plus_hooks(command, pyscript_bridge_call=True)
         finally:
-            with self._cmd2_app.sigint_protection:
+            with self._cmd2_app._sigint_protection:
                 self._cmd2_app.stdout = copy_cmd_stdout.inner_stream
                 self.stop = stop or self.stop
 

cmd2/pyscript_bridge.py

@@ -348,6 +348,35 @@ def files_from_glob_patterns(patterns: List[str], access=os.F_OK) -> List[str]:
     return files
 
 
+def get_exes_in_path(starts_with: str) -> List[str]:
+    """Returns names of executables in a user's path
+
+    :param starts_with: what the exes should start with. leave blank for all exes in path.
+    :return: a list of matching exe names
+    """
+    # Purposely don't match any executable containing wildcards
+    wildcards = ['*', '?']
+    for wildcard in wildcards:
+        if wildcard in starts_with:
+            return []
+
+    # Get a list of every directory in the PATH environment variable and ignore symbolic links
+    paths = [p for p in os.getenv('PATH').split(os.path.pathsep) if not os.path.islink(p)]
+
+    # Use a set to store exe names since there can be duplicates
+    exes_set = set()
+
+    # Find every executable file in the user's path that matches the pattern
+    for path in paths:
+        full_path = os.path.join(path, starts_with)
+        matches = files_from_glob_pattern(full_path + '*', access=os.X_OK)
+
+        for match in matches:
+            exes_set.add(os.path.basename(match))
+
+    return list(exes_set)
+
+
 class StdSim(object):
     """
     Class to simulate behavior of sys.stdout or sys.stderr.
@@ -586,7 +615,7 @@ def __init__(self, self_stdout: Union[StdSim, TextIO], sys_stdout: Union[StdSim,
         self.saved_sys_stdout = sys_stdout
         self.saved_pipe_proc_reader = pipe_proc_reader
 
-        # Tells if the command is redirecting
+        # Tells if the command is _redirecting
         self.redirecting = False
 
         # If the command created a process to pipe to, then then is its reader

cmd2/utils.py

@@ -48,7 +48,7 @@ def __init__(self, *args, **kwargs) -> None:
 
     def _preloop_hook(self) -> None:
         """ Start the alerter thread """
-        # This runs after cmdloop() acquires self.terminal_lock, which will be locked until the prompt appears.
+        # This runs after cmdloop() acquires self._terminal_lock, which will be locked until the prompt appears.
         # Therefore this is the best place to start the alerter thread since there is no risk of it alerting
         # before the prompt is displayed. You can also start it via a command if its not something that should
         # be running during the entire application. See do_start_alerts().
@@ -60,7 +60,7 @@ def _preloop_hook(self) -> None:
     def _postloop_hook(self) -> None:
         """ Stops the alerter thread """
 
-        # After this function returns, cmdloop() releases self.terminal_lock which could make the alerter
+        # After this function returns, cmdloop() releases self._terminal_lock which could make the alerter
         # thread think the prompt is on screen. Therefore this is the best place to stop the alerter thread.
         # You can also stop it via a command. See do_stop_alerts().
         self._stop_thread = True
@@ -169,9 +169,9 @@ def _alerter_thread_func(self) -> None:
         self._next_alert_time = 0
 
         while not self._stop_thread:
-            # Always acquire terminal_lock before printing alerts or updating the prompt
+            # Always acquire _terminal_lock before printing alerts or updating the prompt
             # To keep the app responsive, do not block on this call
-            if self.terminal_lock.acquire(blocking=False):
+            if self._terminal_lock.acquire(blocking=False):
 
                 # Get any alerts that need to be printed
                 alert_str = self._generate_alert_str()
@@ -191,7 +191,7 @@ def _alerter_thread_func(self) -> None:
                     self.async_update_prompt(new_prompt)
 
                 # Don't forget to release the lock
-                self.terminal_lock.release()
+                self._terminal_lock.release()
 
             time.sleep(0.5)
 

examples/async_printing.py

@@ -66,7 +66,7 @@ def add_whitespace_hook(self, data: cmd2.plugin.PostparsingData) -> cmd2.plugin.
         command_pattern = re.compile(r'^([^\s\d]+)(\d+)')
         match = command_pattern.search(command)
         if match:
-            data.statement = self.statement_parser.parse("{} {} {}".format(
+            data.statement = self._statement_parser.parse("{} {} {}".format(
                 match.group(1),
                 match.group(2),
                 '' if data.statement.args is None else data.statement.args
@@ -76,7 +76,7 @@ def add_whitespace_hook(self, data: cmd2.plugin.PostparsingData) -> cmd2.plugin.
     def downcase_hook(self, data: cmd2.plugin.PostparsingData) -> cmd2.plugin.PostparsingData:
         """A hook to make uppercase commands lowercase."""
         command = data.statement.command.lower()
-        data.statement = self.statement_parser.parse("{} {}".format(
+        data.statement = self._statement_parser.parse("{} {}".format(
             command,
             '' if data.statement.args is None else data.statement.args
         ))
@@ -90,7 +90,7 @@ def abbrev_hook(self, data: cmd2.plugin.PostparsingData) -> cmd2.plugin.Postpars
             possible_cmds = [cmd for cmd in self.get_all_commands() if cmd.startswith(data.statement.command)]
             if len(possible_cmds) == 1:
                 raw = data.statement.raw.replace(data.statement.command, possible_cmds[0], 1)
-                data.statement = self.statement_parser.parse(raw)
+                data.statement = self._statement_parser.parse(raw)
         return data
 
     @cmd2.with_argument_list

examples/hooks.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

examples/tab_autocompletion.py

@@ -176,7 +176,7 @@ def complete_tester(text: str, line: str, begidx: int, endidx: int, app) -> Opti
     :param endidx: the ending index of the prefix text
     :param app: the cmd2 app that will run completions
     :return: The first matched string or None if there are no matches
-             Matches are stored in app.completion_matches
+             Matches are stored in app._completion_matches
              These matches also have been sorted by complete()
     """
     def get_line():

tests/conftest.py

@@ -77,7 +77,7 @@ def test_autocomp_flags(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['--duration', '--help', '--type', '-d', '-h', '-t']
+           cmd2_app._completion_matches == ['--duration', '--help', '--type', '-d', '-h', '-t']
 
 def test_autcomp_hint(cmd2_app, capsys):
     text = ''
@@ -106,7 +106,7 @@ def test_autcomp_flag_comp(cmd2_app, capsys):
     out, err = capsys.readouterr()
 
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['--duration ']
+           cmd2_app._completion_matches == ['--duration ']
 
 
 def test_autocomp_flags_choices(cmd2_app):
@@ -117,7 +117,7 @@ def test_autocomp_flags_choices(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['movie', 'show']
+           cmd2_app._completion_matches == ['movie', 'show']
 
 
 def test_autcomp_hint_in_narg_range(cmd2_app, capsys):
@@ -160,7 +160,7 @@ def test_autocomp_subcmd_nested(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['add', 'delete', 'list', 'load']
+           cmd2_app._completion_matches == ['add', 'delete', 'list', 'load']
 
 
 def test_autocomp_subcmd_flag_choices_append(cmd2_app):
@@ -171,7 +171,7 @@ def test_autocomp_subcmd_flag_choices_append(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['G', 'NC-17', 'PG', 'PG-13', 'R']
+           cmd2_app._completion_matches == ['G', 'NC-17', 'PG', 'PG-13', 'R']
 
 def test_autocomp_subcmd_flag_choices_append_exclude(cmd2_app):
     text = ''
@@ -181,7 +181,7 @@ def test_autocomp_subcmd_flag_choices_append_exclude(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['G', 'NC-17', 'R']
+           cmd2_app._completion_matches == ['G', 'NC-17', 'R']
 
 
 def test_autocomp_subcmd_flag_comp_func(cmd2_app):
@@ -192,7 +192,7 @@ def test_autocomp_subcmd_flag_comp_func(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['Adam Driver', 'Alec Guinness', 'Andy Serkis', 'Anthony Daniels']
+           cmd2_app._completion_matches == ['Adam Driver', 'Alec Guinness', 'Andy Serkis', 'Anthony Daniels']
 
 
 def test_autocomp_subcmd_flag_comp_list(cmd2_app):
@@ -213,7 +213,7 @@ def test_autocomp_subcmd_flag_comp_func_attr(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['Adam Driver', 'Alec Guinness', 'Andy Serkis', 'Anthony Daniels']
+           cmd2_app._completion_matches == ['Adam Driver', 'Alec Guinness', 'Andy Serkis', 'Anthony Daniels']
 
 
 def test_autocomp_subcmd_flag_comp_list_attr(cmd2_app):
@@ -244,7 +244,7 @@ def test_autocomp_pos_after_flag(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['John Boyega" ']
+           cmd2_app._completion_matches == ['John Boyega" ']
 
 
 def test_autocomp_custom_func_list_arg(cmd2_app):
@@ -255,7 +255,7 @@ def test_autocomp_custom_func_list_arg(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['SW_CW', 'SW_REB', 'SW_TCW']
+           cmd2_app._completion_matches == ['SW_CW', 'SW_REB', 'SW_TCW']
 
 
 def test_autocomp_custom_func_list_and_dict_arg(cmd2_app):
@@ -266,7 +266,7 @@ def test_autocomp_custom_func_list_and_dict_arg(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['S01E02', 'S01E03', 'S02E01', 'S02E03']
+           cmd2_app._completion_matches == ['S01E02', 'S01E03', 'S02E01', 'S02E03']
 
 
 def test_autocomp_custom_func_dict_arg(cmd2_app):
@@ -277,7 +277,7 @@ def test_autocomp_custom_func_dict_arg(cmd2_app):
 
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is not None and \
-           cmd2_app.completion_matches == ['/home/user/another.db', '/home/user/file space.db', '/home/user/file.db']
+           cmd2_app._completion_matches == ['/home/user/another.db', '/home/user/file space.db', '/home/user/file.db']
 
 
 def test_argparse_remainder_flag_completion(cmd2_app):
@@ -333,7 +333,7 @@ def test_completion_after_double_dash(cmd2_app):
 
     # Since -- is the last token, then it should show flag choices
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
-    assert first_match is not None and '--help' in cmd2_app.completion_matches
+    assert first_match is not None and '--help' in cmd2_app._completion_matches
 
     # Test -- to end all flag completion
     text = '--'