feat(cmd2): print completion hints above prompt and allow optional bottom toolbar

Removed completion hints from the bottom toolbar and implemented printing them above the prompt with ANSI support. Added an optional 'include_bottom_toolbar' parameter to Cmd.__init__ which displays the application name (sys.argv[0]) in the bottom toolbar when enabled.

Author: tleonhardt

cmd2/cmd2.py

@@ -306,6 +306,7 @@ def __init__(
         auto_load_commands: bool = False,
         allow_clipboard: bool = True,
         suggest_similar_command: bool = False,
+        include_bottom_toolbar: bool = False,
         intro: RenderableType = '',
     ) -> None:
         """Easy but powerful framework for writing line-oriented command interpreters, extends Python's cmd package.
@@ -354,10 +355,10 @@ def __init__(
                                    instantiate and register all commands. If False, CommandSets
                                    must be manually installed with `register_command_set`.
         :param allow_clipboard: If False, cmd2 will disable clipboard interactions
-        :param suggest_similar_command: If ``True``, ``cmd2`` will attempt to suggest the most
-                                        similar command when the user types a command that does
-                                        not exist. Default: ``False``.
-        "param intro: Intro banner to print when starting the application.
+        :param suggest_similar_command: if ``True``, then when a command is not found,
+                                        [cmd2.Cmd][] will look for similar commands and suggest them.
+        :param include_bottom_toolbar: if ``True``, then a bottom toolbar will be displayed.
+        :param intro: introduction to display at startup
         """
         # Check if py or ipy need to be disabled in this instance
         if not include_py:
@@ -438,6 +439,7 @@ def __init__(
         # Initialize prompt-toolkit PromptSession
         self.history_adapter = Cmd2History(self)
         self.completer = Cmd2Completer(self)
+        self.include_bottom_toolbar = include_bottom_toolbar
 
         try:
             self.session: PromptSession[str] = PromptSession(
@@ -1625,10 +1627,8 @@ def _reset_completion_defaults(self) -> None:
 
     def _bottom_toolbar(self) -> Any:
         """Get the bottom toolbar content."""
-        if self.formatted_completions:
-            return ANSI(self.formatted_completions.rstrip())
-        if self.completion_hint:
-            return ANSI(self.completion_hint.rstrip())
+        if self.include_bottom_toolbar:
+            return sys.argv[0]
         return None
 
     def tokens_for_completion(self, line: str, begidx: int, endidx: int) -> tuple[list[str], list[str]]:

cmd2/pt_utils.py

@@ -6,11 +6,13 @@
     TYPE_CHECKING,
 )
 
+from prompt_toolkit import print_formatted_text
 from prompt_toolkit.completion import (
     Completer,
     Completion,
 )
 from prompt_toolkit.document import Document
+from prompt_toolkit.formatted_text import ANSI
 from prompt_toolkit.history import History
 
 from . import (
@@ -64,6 +66,12 @@ def get_completions(self, document: Document, _complete_event: object) -> Iterab
         # We pass state=0 to trigger the completion calculation.
         self.cmd_app.complete(text, 0, line=line, begidx=begidx, endidx=endidx, custom_settings=self.custom_settings)
 
+        # Print formatted completions or hints above the prompt if present
+        if self.cmd_app.formatted_completions:
+            print_formatted_text(ANSI(self.cmd_app.formatted_completions.rstrip()))
+        elif self.cmd_app.completion_hint:
+            print_formatted_text(ANSI(self.cmd_app.completion_hint.rstrip()))
+
         # Now we iterate over self.cmd_app.completion_matches and self.cmd_app.display_matches
         matches = self.cmd_app.completion_matches
         display_matches = self.cmd_app.display_matches

tests/test_cmd2.py

@@ -3365,41 +3365,14 @@ def run_alert():
     assert "another thread holds terminal_lock" in str(exceptions[0])
 
 
-def test_bottom_toolbar(base_app):
-    from prompt_toolkit.formatted_text import ANSI
-
-    # Test when both are empty
-    base_app.formatted_completions = ''
-    base_app.completion_hint = ''
+def test_bottom_toolbar(base_app, monkeypatch):
+    # Test default (disabled)
     assert base_app._bottom_toolbar() is None
 
-    # Test when formatted_completions is set
-    text = 'completions'
-    base_app.formatted_completions = text + '\n'
-    base_app.completion_hint = ''
-    result = base_app._bottom_toolbar()
-    assert isinstance(result, ANSI)
-
-    # Test when completion_hint is set
-    hint = 'hint'
-    base_app.formatted_completions = ''
-    base_app.completion_hint = hint + '  '
-    result = base_app._bottom_toolbar()
-    assert isinstance(result, ANSI)
-
-    # Test prioritization and rstrip
-    with mock.patch('cmd2.cmd2.ANSI', wraps=ANSI) as mock_ansi:
-        # formatted_completions takes precedence
-        base_app.formatted_completions = 'formatted\n'
-        base_app.completion_hint = 'hint'
-        base_app._bottom_toolbar()
-        mock_ansi.assert_called_with('formatted')
-
-        # completion_hint used when formatted_completions is empty
-        base_app.formatted_completions = ''
-        base_app.completion_hint = 'hint  '
-        base_app._bottom_toolbar()
-        mock_ansi.assert_called_with('hint')
+    # Test enabled
+    base_app.include_bottom_toolbar = True
+    monkeypatch.setattr(sys, 'argv', ['myapp.py'])
+    assert base_app._bottom_toolbar() == 'myapp.py'
 
 
 def test_multiline_complete_statement_keyboard_interrupt(multiline_app, monkeypatch):

tests/test_pt_utils.py

@@ -18,6 +18,8 @@ def __init__(self):
         self.completion_matches = []
         self.display_matches = []
         self.history = []
+        self.formatted_completions = ''
+        self.completion_hint = ''
 
 
 @pytest.fixture