Remove complete_style parameter from cmd2.Cmd.__init__

prompt-toolkit complete_style argument now gets set automatically based on the number of completion results based on the max_column_completion_items parameter and settable.

Author: tleonhardt

CHANGELOG.md

@@ -36,15 +36,6 @@ shell, and the option for a persistent bottom bar that can display realtime stat
           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
-                   big column
-            -   2. `CompleteStyle.MULTI_COLUMN` - displays hints across multiple columns, with help
-                   when selected
-            -   3. `CompleteStyle.READLINE_LIKE` - displays like readline; WARNING:
-                   `complete_in_thread` doesn't work for background completion when this option is
-                   selected
         - **max_column_completion_items**: (int) the maximum number of completion results to display
           in a single column, used to provide the initial value for a settable with the same name
     - Added `cmd2.Cmd._in_prompt` flag that is set to `True` when the prompt is displayed and the

cmd2/cmd2.py

@@ -301,7 +301,6 @@ def __init__(
         auto_suggest: bool = True,
         bottom_toolbar: bool = False,
         command_sets: Iterable[CommandSet] | None = None,
-        complete_style: CompleteStyle = CompleteStyle.COLUMN,
         include_ipy: bool = False,
         include_py: bool = False,
         intro: RenderableType = '',
@@ -343,10 +342,6 @@ def __init__(
                              This allows CommandSets with custom constructor parameters to be
                              loaded.  This also allows the a set of CommandSets to be provided
                              when `auto_load_commands` is set to False
-        :param complete_style: 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 big column
-                               2. CompleteStyle.MULTI_COLUMN - displays hints across multiple columns, with help when selected
-                               3. CompleteStyle.READLINE_LIKE - displays like readline, complete_in_thread doesn't work
         :param include_ipy: should the "ipy" command be included for an embedded IPython shell
         :param include_py: should the "py" command be included for an embedded Python shell
         :param intro: introduction to display at startup
@@ -480,7 +475,7 @@ def _(event: Any) -> None:  # pragma: no cover
                 auto_suggest=self.auto_suggest,
                 bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                 complete_in_thread=True,
-                complete_style=complete_style,
+                complete_style=CompleteStyle.MULTI_COLUMN,
                 complete_while_typing=False,
                 completer=self.completer,
                 history=self.history_adapter,
@@ -495,7 +490,7 @@ def _(event: Any) -> None:  # pragma: no cover
                 auto_suggest=self.auto_suggest,
                 bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                 complete_in_thread=True,
-                complete_style=complete_style,
+                complete_style=CompleteStyle.MULTI_COLUMN,
                 complete_while_typing=False,
                 completer=self.completer,
                 history=self.history_adapter,
@@ -2539,11 +2534,10 @@ def complete(
                     self.matches_sorted = True
 
                 # Swap between COLUMN and MULTI_COLUMN style based on the number of matches if not using READLINE_LIKE
-                if self.session.complete_style != CompleteStyle.READLINE_LIKE:
-                    if len(self.completion_matches) > self.max_column_completion_items:
-                        self.session.complete_style = CompleteStyle.MULTI_COLUMN
-                    else:
-                        self.session.complete_style = CompleteStyle.COLUMN
+                if len(self.completion_matches) > self.max_column_completion_items:
+                    self.session.complete_style = CompleteStyle.MULTI_COLUMN
+                else:
+                    self.session.complete_style = CompleteStyle.COLUMN
 
             try:
                 return self.completion_matches[state]

docs/features/initialization.md

@@ -26,7 +26,6 @@ Here are instance attributes of `cmd2.Cmd` which developers might wish to overri
 
 - **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
 - **debug**: if `True`, show full stack trace on error (Default: `False`)

examples/basic_completion.py

@@ -13,8 +13,6 @@
 
 import functools
 
-from prompt_toolkit.shortcuts import CompleteStyle
-
 import cmd2
 
 # List of strings used with completion functions
@@ -33,7 +31,7 @@
 
 class BasicCompletion(cmd2.Cmd):
     def __init__(self) -> None:
-        super().__init__(auto_suggest=False, complete_style=CompleteStyle.MULTI_COLUMN, include_py=True)
+        super().__init__(auto_suggest=False, include_py=True)
 
     def do_flag_based(self, statement: cmd2.Statement) -> None:
         """Tab completes arguments based on a preceding flag using flag_based_complete

examples/hello_cmd2.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 """This is intended to be a completely bare-bones cmd2 application suitable for rapid testing and debugging."""
 
-from prompt_toolkit.shortcuts import CompleteStyle
-
 from cmd2 import (
     cmd2,
 )
@@ -12,7 +10,6 @@
 
     # If run as the main application, simply start a bare-bones cmd2 application with only built-in functionality.
     app = cmd2.Cmd(
-        complete_style=CompleteStyle.READLINE_LIKE,  # Use readline style tab completion instead of prompt-toolkit style
         include_ipy=True,  # Enable support for interactive Python shell via py command
         include_py=True,  # Enable support for interactive IPython shell via ipy command
         persistent_history_file='cmd2_history.dat',  # Persist history between runs