Revert "Remove bottom_toolbar parameter from cmd2.Cmd.__init__ and make default implementation of get_bottom_toolbar just return None."

This reverts commit 4d113c5.

Author: tleonhardt

CHANGELOG.md

@@ -32,6 +32,10 @@ shell, and the option for a persistent bottom bar that can display realtime stat
         - **auto_suggest**: (boolean) if `True`, provide fish shell style auto-suggestions. These
           are grayed-out hints based on history. User can press right-arrow key to accept the
           provided suggestion.
+        - **bottom toolbar**: (boolean) if `True`, present a persistent bottom toolbar capable of
+          displaying realtime status information while the prompt is displayed, see the
+          `cmd2.Cmd2.get_bottom_toolbar` method that can be overridden as well as the updated
+          `getting_started.py` example
         - **complete_style**: (enum) style of prompt-toolkit tab completion to use, 3 valid options
           are:
             -   1. `CompleteStyle.COLUMN` (default) - displays hints with help next to them in one
@@ -46,8 +50,7 @@ shell, and the option for a persistent bottom bar that can display realtime stat
     - Added `cmd2.Cmd._in_prompt` flag that is set to `True` when the prompt is displayed and the
       application is waiting for user input
     - New `cmd2.Cmd` methods
-        - **get_bottom_toolbar**: override to create and populates a bottom toolbar capable of
-          displaying realtime status information while the prompt is displayed
+        - **get_bottom_toolbar**: populates bottom toolbar if `bottom_toolbar` is `True`
         - **get_rprompt**: override to populate right prompt
         - **pre_prompt**: hook method that is called before the prompt is displayed, but after
           `prompt-toolkit` event loop has started

cmd2/cmd2.py

@@ -299,6 +299,7 @@ def __init__(
         allow_redirection: bool = True,
         auto_load_commands: bool = False,
         auto_suggest: bool = True,
+        bottom_toolbar: bool = False,
         command_sets: Iterable[CommandSet] | None = None,
         complete_style: CompleteStyle = CompleteStyle.COLUMN,
         include_ipy: bool = False,
@@ -337,6 +338,7 @@ def __init__(
                                    must be manually installed with `register_command_set`.
         :param auto_suggest: If True, cmd2 will provide fish shell style auto-suggestions
                             based on history. If False, these will not be provided.
+        :param bottom_toolbar: if ``True``, then a bottom toolbar will be displayed.
         :param command_sets: Provide CommandSet instances to load during cmd2 initialization.
                              This allows CommandSets with custom constructor parameters to be
                              loaded.  This also allows the a set of CommandSets to be provided
@@ -467,6 +469,7 @@ def _(event: Any) -> None:  # pragma: no cover
         self.history_adapter = Cmd2History(self)
         self.completer = Cmd2Completer(self)
         self.lexer = Cmd2Lexer(self)
+        self.bottom_toolbar = bottom_toolbar
 
         self.auto_suggest = None
         if auto_suggest:
@@ -475,7 +478,7 @@ def _(event: Any) -> None:  # pragma: no cover
         try:
             self.session: PromptSession[str] = PromptSession(
                 auto_suggest=self.auto_suggest,
-                bottom_toolbar=self.get_bottom_toolbar,
+                bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                 complete_in_thread=True,
                 complete_style=complete_style,
                 complete_while_typing=False,
@@ -490,7 +493,7 @@ def _(event: Any) -> None:  # pragma: no cover
             # where isatty() is True but there is no real console.
             self.session = PromptSession(
                 auto_suggest=self.auto_suggest,
-                bottom_toolbar=self.get_bottom_toolbar,
+                bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                 complete_in_thread=True,
                 complete_style=complete_style,
                 complete_while_typing=False,
@@ -1698,14 +1701,35 @@ def _reset_completion_defaults(self) -> None:
     def get_bottom_toolbar(self) -> list[str | tuple[str, str]] | None:
         """Get the bottom toolbar content.
 
-        Override this if you want a bottom toolbar to be displayed.
+        If self.bottom_toolbar is False, returns None.
 
-        :return: tokens for prompt-toolkit to populate in the bottom toolbar
-                or None for no bottom toolbar.
+        Otherwise returns tokens for prompt-toolkit to populate in the bottom toolbar.
 
         NOTE: This content can extend over multiple lines.  However we would recommend
         keeping it to a single line or two lines maximum.
         """
+        if self.bottom_toolbar:
+            import datetime
+            import shutil
+
+            # Get the current time in ISO format with 0.01s precision
+            dt = datetime.datetime.now(datetime.timezone.utc).astimezone()
+            now = dt.strftime('%Y-%m-%dT%H:%M:%S.%f')[:-4] + dt.strftime('%z')
+            left_text = sys.argv[0]
+
+            # Get terminal width to calculate padding for right-alignment
+            cols, _ = shutil.get_terminal_size()
+            padding_size = cols - len(left_text) - len(now) - 1
+            if padding_size < 1:
+                padding_size = 1
+            padding = ' ' * padding_size
+
+            # Return formatted text for prompt-toolkit
+            return [
+                ('ansigreen', left_text),
+                ('', padding),
+                ('ansicyan', now),
+            ]
         return None
 
     def get_rprompt(self) -> str | FormattedText | None:
@@ -3408,7 +3432,7 @@ def get_prompt() -> ANSI | str:
 
                         return temp_session1.prompt(
                             prompt_to_use,
-                            bottom_toolbar=self.get_bottom_toolbar,
+                            bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                             completer=completer_to_use,
                             lexer=self.lexer,
                             pre_run=self.pre_prompt,
@@ -3418,7 +3442,7 @@ def get_prompt() -> ANSI | str:
                     # history is None
                     return self.session.prompt(
                         prompt_to_use,
-                        bottom_toolbar=self.get_bottom_toolbar,
+                        bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                         completer=completer_to_use,
                         lexer=self.lexer,
                         pre_run=self.pre_prompt,
@@ -3437,7 +3461,7 @@ def get_prompt() -> ANSI | str:
                 )
                 line = temp_session2.prompt(
                     prompt,
-                    bottom_toolbar=self.get_bottom_toolbar,
+                    bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                     pre_run=self.pre_prompt,
                     rprompt=self.get_rprompt,
                 )
@@ -3454,7 +3478,7 @@ def get_prompt() -> ANSI | str:
                     output=self.session.output,
                 )
                 line = temp_session3.prompt(
-                    bottom_toolbar=self.get_bottom_toolbar,
+                    bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                     pre_run=self.pre_prompt,
                     rprompt=self.get_rprompt,
                 )

docs/features/initialization.md

@@ -25,6 +25,7 @@ The `cmd2.Cmd` class provides a large number of public instance attributes which
 Here are instance attributes of `cmd2.Cmd` which developers might wish to override:
 
 - **always_show_hint**: if `True`, display tab completion hint even when completion suggestions print (Default: `False`)
+- **bottom_toolbar**: if `True`, then a bottom toolbar will be displayed (Default: `False`)
 - **complete_style**: style to display tab-completion hints in (from `CompleteStyle` options in `prompt-toolkit`)
 - **broken_pipe_warning**: if non-empty, this string will be displayed if a broken pipe error occurs
 - **continuation_prompt**: used for multiline commands on 2nd+ line of input

docs/upgrades.md

@@ -36,9 +36,10 @@ While we have strived to maintain compatibility, there are some differences:
 `cmd2` now supports an optional, persistent bottom toolbar. This can be used to display information
 such as the application name, current state, or even a real-time clock.
 
-- **Enablement and Customization**: Override the [cmd2.Cmd.get_bottom_toolbar][] method to return
-  the content you wish to display. The content can be a simple string or a list of `(style, text)`
-  tuples for formatted text with colors.
+- **Enablement**: Set `bottom_toolbar=True` in the [cmd2.Cmd.__init__][] constructor.
+- **Customization**: Override the [cmd2.Cmd.get_bottom_toolbar][] method to return the content you
+  wish to display. The content can be a simple string or a list of `(style, text)` tuples for
+  formatted text with colors.
 
 See the
 [getting_started.py](https://github.com/python-cmd2/cmd2/blob/main/examples/getting_started.py)

examples/getting_started.py

@@ -14,12 +14,9 @@
 10) How to make custom attributes settable at runtime.
 11) Shortcuts for commands
 12) Persistent bottom toolbar with realtime status updates
-13) Right prompt contextual information display
 """
 
-import datetime
 import pathlib
-import shutil
 import threading
 import time
 
@@ -48,6 +45,7 @@ def __init__(self) -> None:
         shortcuts.update({'&': 'intro'})
         super().__init__(
             auto_suggest=True,
+            bottom_toolbar=True,
             include_ipy=True,
             multiline_commands=['echo'],
             persistent_history_file='cmd2_history.dat',
@@ -98,26 +96,6 @@ def __init__(self) -> None:
             )
         )
 
-    def get_bottom_toolbar(self) -> list[str | tuple[str, str]] | None:
-        # Get the current time in ISO format with 0.01s precision
-        dt = datetime.datetime.now(datetime.timezone.utc).astimezone()
-        now = dt.strftime('%Y-%m-%dT%H:%M:%S.%f')[:-4] + dt.strftime('%z')
-        left_text = sys.argv[0]
-
-        # Get terminal width to calculate padding for right-alignment
-        cols, _ = shutil.get_terminal_size()
-        padding_size = cols - len(left_text) - len(now) - 1
-        if padding_size < 1:
-            padding_size = 1
-        padding = ' ' * padding_size
-
-        # Return formatted text for prompt-toolkit
-        return [
-            ('ansigreen', left_text),
-            ('', padding),
-            ('ansicyan', now),
-        ]
-
     def get_rprompt(self) -> str | FormattedText | None:
         current_working_directory = pathlib.Path.cwd()
         style = 'bg:ansired fg:ansiwhite'

tests/test_cmd2.py

@@ -3623,39 +3623,14 @@ def run_alert():
     assert "Main thread is not at the prompt" in str(exceptions[0])
 
 
-class ToolbarApp(cmd2.Cmd):
-    def get_bottom_toolbar(self) -> list[str | tuple[str, str]] | None:
-        import datetime
-        import shutil
-
-        # Get the current time in ISO format with 0.01s precision
-        dt = datetime.datetime.now(datetime.timezone.utc).astimezone()
-        now = dt.strftime('%Y-%m-%dT%H:%M:%S.%f')[:-4] + dt.strftime('%z')
-        left_text = sys.argv[0]
-
-        # Get terminal width to calculate padding for right-alignment
-        cols, _ = shutil.get_terminal_size()
-        padding_size = cols - len(left_text) - len(now) - 1
-        if padding_size < 1:
-            padding_size = 1
-        padding = ' ' * padding_size
-
-        # Return formatted text for prompt-toolkit
-        return [
-            ('ansigreen', left_text),
-            ('', padding),
-            ('ansicyan', now),
-        ]
-
-
 def test_get_bottom_toolbar(base_app, monkeypatch):
     # Test default (disabled)
     assert base_app.get_bottom_toolbar() is None
 
-    # Test overridden via custom class
+    # Test enabled
+    base_app.bottom_toolbar = True
     monkeypatch.setattr(sys, 'argv', ['myapp.py'])
-    app = ToolbarApp()
-    toolbar = app.get_bottom_toolbar()
+    toolbar = base_app.get_bottom_toolbar()
     assert isinstance(toolbar, list)
     assert toolbar[0] == ('ansigreen', 'myapp.py')
     assert toolbar[2][0] == 'ansicyan'
@@ -3836,19 +3811,19 @@ def my_pre_prompt():
         assert loop_check['running']
 
 
-def test_get_bottom_toolbar_narrow_terminal(monkeypatch):
+def test_get_bottom_toolbar_narrow_terminal(base_app, monkeypatch):
     """Test get_bottom_toolbar when terminal is too narrow for calculated padding"""
     import shutil
 
+    base_app.bottom_toolbar = True
     monkeypatch.setattr(sys, 'argv', ['myapp.py'])
 
     # Mock shutil.get_terminal_size to return a very small width (e.g. 5)
     # Calculated padding_size = 5 - len('myapp.py') - len(now) - 1
     # Since len(now) is ~29, this will definitely be < 1
     monkeypatch.setattr(shutil, 'get_terminal_size', lambda: os.terminal_size((5, 20)))
 
-    app = ToolbarApp()
-    toolbar = app.get_bottom_toolbar()
+    toolbar = base_app.get_bottom_toolbar()
     assert isinstance(toolbar, list)
 
     # The padding (index 1) should be exactly 1 space