feat(cmd2): display tab completion hints in bottom toolbar

Updated ArgparseCompleter integration to display required argument hints in the prompt-toolkit bottom toolbar. This ensures hints like 'Hint: name name of this alias' are visible below the prompt when no completion matches are available. Restored printing of hint tables above the prompt for other argument types.

Author: tleonhardt

cmd2/cmd2.py

@@ -1629,6 +1629,8 @@ def _reset_completion_defaults(self) -> None:
 
     def _bottom_toolbar(self) -> Any:
         """Get the bottom toolbar content."""
+        if self.completion_hint:
+            return self.completion_hint.strip()
         if self.include_bottom_toolbar:
             return sys.argv[0]
         return None
@@ -3240,6 +3242,7 @@ def read_input(
         :param parser: optional argparse parser
         :return: the line read from input
         """
+        self._reset_completion_defaults()
         if self.use_rawinput and self.stdin.isatty():
             # Determine completer
             completer_to_use: Completer
@@ -3288,13 +3291,13 @@ def get_prompt() -> Any:
                     return temp_session1.prompt(
                         prompt_to_use,
                         completer=completer_to_use,
-                        bottom_toolbar=self._bottom_toolbar if self.include_bottom_toolbar else None,
+                        bottom_toolbar=self._bottom_toolbar,
                     )
 
                 return self.session.prompt(
                     prompt_to_use,
                     completer=completer_to_use,
-                    bottom_toolbar=self._bottom_toolbar if self.include_bottom_toolbar else None,
+                    bottom_toolbar=self._bottom_toolbar,
                 )
 
         # Otherwise read from self.stdin
@@ -3308,7 +3311,7 @@ def get_prompt() -> Any:
             )
             line = temp_session2.prompt(
                 prompt,
-                bottom_toolbar=self._bottom_toolbar if self.include_bottom_toolbar else None,
+                bottom_toolbar=self._bottom_toolbar,
             )
             if len(line) == 0:
                 raise EOFError
@@ -3322,7 +3325,7 @@ def get_prompt() -> Any:
                 complete_while_typing=self.session.complete_while_typing,
             )
             line = temp_session3.prompt(
-                bottom_toolbar=self._bottom_toolbar if self.include_bottom_toolbar else None,
+                bottom_toolbar=self._bottom_toolbar,
             )
             if len(line) == 0:
                 raise EOFError

cmd2/pt_utils.py

@@ -6,11 +6,15 @@
     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 (
@@ -67,6 +71,14 @@ 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 (tables) above the prompt if present
+        if self.cmd_app.formatted_completions:
+            print_formatted_text(ANSI("\n" + self.cmd_app.formatted_completions))
+            self.cmd_app.formatted_completions = ""
+
+        # completion_hint will be displayed in the bottom toolbar by cmd2.py
+        # and cleared by _reset_completion_defaults() on the next completion attempt.
+
         # 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

@@ -3374,6 +3374,10 @@ def test_bottom_toolbar(base_app, monkeypatch):
     monkeypatch.setattr(sys, 'argv', ['myapp.py'])
     assert base_app._bottom_toolbar() == 'myapp.py'
 
+    # Test hint priority
+    base_app.completion_hint = 'My Hint'
+    assert base_app._bottom_toolbar() == 'My Hint'
+
 
 def test_multiline_complete_statement_keyboard_interrupt(multiline_app, monkeypatch):
     # Mock read_input to raise KeyboardInterrupt