Added function to strip styles for strings rendered by prompt-toolkit.

Author: kmvanbrunt

cmd2/cmd2.py

@@ -66,6 +66,7 @@
 )
 
 import rich.box
+from prompt_toolkit import print_formatted_text
 from rich.console import (
     Group,
     RenderableType,
@@ -182,6 +183,7 @@ def __init__(self, msg: str = '') -> None:
     Cmd2Completer,
     Cmd2History,
     Cmd2Lexer,
+    pt_filter_style,
 )
 from .utils import (
     Settable,
@@ -388,7 +390,7 @@ def __init__(
         self._initialize_plugin_system()
 
         # Configure a few defaults
-        self.prompt = Cmd.DEFAULT_PROMPT
+        self.prompt: str = Cmd.DEFAULT_PROMPT
         self.intro = intro
 
         # What to use for standard input
@@ -3239,6 +3241,8 @@ def _read_raw_input(
         # Check if the session is configured for interactive terminal use.
         if not isinstance(session.input, DummyInput):
             with patch_stdout():
+                if not callable(prompt):
+                    prompt = pt_filter_style(prompt)
                 return session.prompt(prompt, completer=completer, **prompt_kwargs)
 
         # We're not at a terminal, so we're likely reading from a file or a pipe.
@@ -3367,7 +3371,7 @@ def _process_alerts(self) -> None:
                 # Print and update
                 with patch_stdout():
                     if alert.msg:
-                        print(alert.msg)
+                        print_formatted_text(pt_filter_style(alert.msg))
 
                 # Only update if the alert was generated after the current prompt was drawn on the screen.
                 if (alert.prompt is not None and
@@ -3393,7 +3397,7 @@ def _read_command_line(self, prompt: str) -> str:
 
         # Use dynamic prompt if the prompt matches self.prompt
         def get_prompt() -> ANSI:
-            return ANSI(self.prompt)
+            return pt_filter_style(self.prompt)
 
         prompt_to_use: Callable[[], ANSI | str] | ANSI | str = ANSI(prompt)
         if prompt == self.prompt:

cmd2/pt_utils.py

@@ -26,6 +26,7 @@
     utils,
 )
 from . import rich_utils as ru
+from . import string_utils as su
 
 if TYPE_CHECKING:  # pragma: no cover
     from .cmd2 import Cmd
@@ -34,6 +35,21 @@
 BASE_DELIMITERS = " \t\n" + "".join(constants.QUOTES) + "".join(constants.REDIRECTION_CHARS)
 
 
+def pt_filter_style(text: str | ANSI) -> str | ANSI:
+    """Strip styles if disallowed by ru.ALLOW_STYLE. Otherwise return an ANSI object.
+
+    This function is intended specifically for text rendered by prompt-toolkit.
+    """
+    # We only use prompt-toolkit to write to a terminal. Therefore
+    # we only have to check if ALLOW_STYLE is Never.
+    if ru.ALLOW_STYLE == ru.AllowStyle.NEVER:
+        raw_text = text.value if isinstance(text, ANSI) else text
+        return su.strip_style(raw_text)
+
+    # String must be an ANSI object for prompt-toolkit to render ANSI style sequences.
+    return text if isinstance(text, ANSI) else ANSI(text)
+
+
 class Cmd2Completer(Completer):
     """Completer that delegates to cmd2's completion logic."""
 
@@ -72,16 +88,16 @@ def get_completions(self, document: Document, _complete_event: object) -> Iterab
         )
 
         if completions.completion_error:
-            print_formatted_text(ANSI(completions.completion_error))
+            print_formatted_text(pt_filter_style(completions.completion_error))
             return
 
         # Print completion table if present
         if completions.completion_table:
-            print_formatted_text(ANSI("\n" + completions.completion_table))
+            print_formatted_text(pt_filter_style("\n" + completions.completion_table))
 
         # Print hint if present and settings say we should
         if completions.completion_hint and (self.cmd_app.always_show_hint or not completions):
-            print_formatted_text(ANSI(completions.completion_hint))
+            print_formatted_text(pt_filter_style(completions.completion_hint))
 
         if not completions:
             return
@@ -103,9 +119,6 @@ def get_completions(self, document: Document, _complete_event: object) -> Iterab
             buffer.cursor_right(search_text_length)
             return
 
-        # Determine if we should remove style from completion text
-        remove_style = ru.ALLOW_STYLE == ru.AllowStyle.NEVER
-
         # Return the completions
         for item in completions:
             # Set offset to the start of the current word to overwrite it with the completion
@@ -134,8 +147,8 @@ def get_completions(self, document: Document, _complete_event: object) -> Iterab
             yield Completion(
                 match_text,
                 start_position=start_position,
-                display=item.display_plain if remove_style else ANSI(item.display),
-                display_meta=item.display_meta_plain if remove_style else ANSI(item.display_meta),
+                display=pt_filter_style(item.display),
+                display_meta=pt_filter_style(item.display_meta),
             )
 
 
@@ -215,8 +228,9 @@ def get_line(lineno: int) -> list[tuple[str, str]]:
             tokens: list[tuple[str, str]] = []
 
             # Use cmd2's command pattern to find the first word (the command)
-            match = self.cmd_app.statement_parser._command_pattern.search(line)
-            if match:
+            if ru.ALLOW_STYLE != ru.AllowStyle.NEVER and (
+                match := self.cmd_app.statement_parser._command_pattern.search(line)
+            ):
                 # Group 1 is the command, Group 2 is the character(s) that terminated the command match
                 command = match.group(1)
                 cmd_start = match.start(1)
@@ -277,7 +291,7 @@ def get_line(lineno: int) -> list[tuple[str, str]]:
                         else:
                             tokens.append(('', text))
             elif line:
-                # No command match found, add the entire line unstyled
+                # No command match found or colors aren't allowed, add the entire line unstyled
                 tokens.append(('', line))
 
             return tokens