From dfedeba916d517ad735ab889bd5569d6d765ad72 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Fri, 24 Apr 2026 19:17:41 -0400 Subject: [PATCH 1/8] Add styles to theme for completion item and meta foreground and background color This is an attempt to provide higher-contrast color options and to make them configurable as part of a theme. --- CHANGELOG.md | 2 ++ cmd2/cmd2.py | 45 +++++++++++++++++++++++++++++++++++++ cmd2/styles.py | 4 ++++ docs/features/completion.md | 7 ++++++ docs/features/theme.md | 14 ++++++++++++ docs/upgrades.md | 10 +++++++++ 6 files changed, 82 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b5e563151..f4f52e6f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -135,6 +135,8 @@ prompt is displayed. full type hints and IDE autocompletion for `self._cmd` without needing to override and cast the property. - Added `traceback_kwargs` attribute to allow customization of Rich-based tracebacks. + - Added ability to customize `prompt-toolkit` completion menu colors by overriding + `Cmd2Style.COMPLETION_MENU_ITEM` and `Cmd2Style.COMPLETION_MENU_META` in the `cmd2` theme. ## 3.5.1 (April 24, 2026) diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index f2ab98944..dba825041 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -78,6 +78,8 @@ from prompt_toolkit.output import DummyOutput, create_output from prompt_toolkit.patch_stdout import patch_stdout from prompt_toolkit.shortcuts import CompleteStyle, PromptSession, choice, set_title +from prompt_toolkit.styles import DynamicStyle +from prompt_toolkit.styles import Style as PtStyle from rich.console import ( Group, JustifyMethod, @@ -714,6 +716,46 @@ def _should_continue_multiline(self) -> bool: # No macro found or already processed. The statement is complete. return False + def _get_pt_style(self) -> "PtStyle": + """Return the prompt_toolkit style for the completion menu.""" + + def to_pt_style(rich_style: Style | None) -> str: + """Convert a rich Style object to a prompt_toolkit style string.""" + if not rich_style: + return "" + parts = ["noreverse"] + if rich_style.color: + c = rich_style.color.get_truecolor() + parts.append(f"fg:#{c.red:02x}{c.green:02x}{c.blue:02x}") + else: + parts.append("fg:default") + + if rich_style.bgcolor: + c = rich_style.bgcolor.get_truecolor() + parts.append(f"bg:#{c.red:02x}{c.green:02x}{c.blue:02x}") + else: + parts.append("bg:default") + + if rich_style.bold is not None: + parts.append("bold" if rich_style.bold else "nobold") + if rich_style.italic is not None: + parts.append("italic" if rich_style.italic else "noitalic") + if rich_style.underline is not None: + parts.append("underline" if rich_style.underline else "nounderline") + return " ".join(parts) + + theme = ru.get_theme() + item_style = to_pt_style(theme.styles.get(Cmd2Style.COMPLETION_MENU_ITEM)) + meta_style = to_pt_style(theme.styles.get(Cmd2Style.COMPLETION_MENU_META)) + + return PtStyle.from_dict( + { + "completion-menu.completion.current": item_style, + "completion-menu.meta.completion.current": meta_style, + "completion-menu.multi-column-meta": meta_style, + } + ) + def _create_main_session(self, auto_suggest: bool, completekey: str) -> PromptSession[str]: """Create and return the main PromptSession for the application. @@ -755,6 +797,7 @@ def _(event: Any) -> None: # pragma: no cover "multiline": filters.Condition(self._should_continue_multiline), "prompt_continuation": self.continuation_prompt, "rprompt": self.get_rprompt, + "style": DynamicStyle(self._get_pt_style), } if self.stdin.isatty() and self.stdout.isatty(): @@ -3578,6 +3621,7 @@ def read_input( key_bindings=self.main_session.key_bindings, input=self.main_session.input, output=self.main_session.output, + style=DynamicStyle(self._get_pt_style), ) return self._read_raw_input(prompt, temp_session) @@ -3596,6 +3640,7 @@ def read_secret( temp_session: PromptSession[str] = PromptSession( input=self.main_session.input, output=self.main_session.output, + style=DynamicStyle(self._get_pt_style), ) return self._read_raw_input(prompt, temp_session, is_password=True) diff --git a/cmd2/styles.py b/cmd2/styles.py index 15489d46e..4d015d30b 100644 --- a/cmd2/styles.py +++ b/cmd2/styles.py @@ -51,6 +51,8 @@ class Cmd2Style(StrEnum): """ COMMAND_LINE = "cmd2.example" # Command line examples in help text + COMPLETION_MENU_ITEM = "cmd2.completion_menu.item" # Selected completion item + COMPLETION_MENU_META = "cmd2.completion_menu.meta" # Selected completion help/meta text ERROR = "cmd2.error" # Error text (used by perror()) HELP_HEADER = "cmd2.help.header" # Help table header text HELP_LEADER = "cmd2.help.leader" # Text right before the help tables are listed @@ -63,6 +65,8 @@ class Cmd2Style(StrEnum): # Tightly coupled with the Cmd2Style enum. DEFAULT_CMD2_STYLES: dict[str, StyleType] = { Cmd2Style.COMMAND_LINE: Style(color=Color.CYAN, bold=True), + Cmd2Style.COMPLETION_MENU_ITEM: Style(color=Color.BLACK, bgcolor=Color.GREEN), + Cmd2Style.COMPLETION_MENU_META: Style(color=Color.BLACK, bgcolor=Color.LIGHT_GREEN), Cmd2Style.ERROR: Style(color=Color.BRIGHT_RED), Cmd2Style.HELP_HEADER: Style(color=Color.BRIGHT_GREEN), Cmd2Style.HELP_LEADER: Style(color=Color.CYAN), diff --git a/docs/features/completion.md b/docs/features/completion.md index 85143650b..1def16f23 100644 --- a/docs/features/completion.md +++ b/docs/features/completion.md @@ -116,6 +116,13 @@ demonstration of how this is used. [read_input](https://github.com/python-cmd2/cmd2/blob/main/examples/read_input.py) example for a demonstration. +## Custom Completion Menu Colors + +`cmd2` provides the ability to customize the foreground and background colors of the completion menu +items and their associated help text. See +[Customizing Completion Menu Colors](./theme.md#customizing-completion-menu-colors) in the Theme +documentation for more details. + ## For More Information See [cmd2's argparse_utils API](../api/argparse_utils.md) for a more detailed discussion of argparse diff --git a/docs/features/theme.md b/docs/features/theme.md index 064178fa7..cd348f061 100644 --- a/docs/features/theme.md +++ b/docs/features/theme.md @@ -6,5 +6,19 @@ information. You can use this to brand your application and set an overall consistent look and feel that is appealing to your user base. +## Customizing Completion Menu Colors + +`cmd2` leverages `prompt-toolkit` for its tab completion menu. You can customize the colors of the +completion menu by overriding the following styles in your `cmd2` theme: + +- `Cmd2Style.COMPLETION_MENU_ITEM`: The background and foreground color of the selected completion + item. +- `Cmd2Style.COMPLETION_MENU_META`: The background and foreground color of the selected completion + item's help/meta text. + +By default, these are styled with black text on a green background to provide contrast. + +## Example + See [rich_theme.py](https://github.com/python-cmd2/cmd2/blob/main/examples/rich_theme.py) for a simple example of configuring a custom theme for your `cmd2` application. diff --git a/docs/upgrades.md b/docs/upgrades.md index a89e248f2..2d10a7a44 100644 --- a/docs/upgrades.md +++ b/docs/upgrades.md @@ -46,6 +46,16 @@ See the example for a demonstration of how to implement a background thread that refreshes the toolbar periodically. +### Custom Completion Menu Colors + +`cmd2` now leverages `prompt-toolkit` for its tab completion menu and provides the ability to +customize its appearance using the `cmd2` theme. + +- **Customization**: Override the `Cmd2Style.COMPLETION_MENU_ITEM` and + `Cmd2Style.COMPLETION_MENU_META` styles using `cmd2.rich_utils.set_theme()`. See + [Customizing Completion Menu Colors](features/theme.md#customizing-completion-menu-colors) for + more details. + ### Deleted Modules Removed `rl_utils.py` and `terminal_utils.py` since `prompt-toolkit` provides this functionality. From 1a73c22b29c454c55924ff2830b02d014e7d2657 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sat, 25 Apr 2026 14:54:20 -0400 Subject: [PATCH 2/8] Moved to_pt_style function to pt_utils.py and added unit tests for it Also: - Cache prompt-toolkit completion menu styles for efficiency - Fixed color check bug related to default terminal style --- cmd2/cmd2.py | 45 ++++++++++---------------- cmd2/pt_utils.py | 27 ++++++++++++++++ tests/test_pt_utils.py | 73 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 117 insertions(+), 28 deletions(-) diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index dba825041..0ab5ad430 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -192,6 +192,7 @@ def __init__(self, msg: str = "") -> None: Cmd2History, Cmd2Lexer, pt_filter_style, + to_pt_style, ) from .utils import ( Settable, @@ -523,6 +524,10 @@ def __init__( self._persistent_history_length = persistent_history_length self._initialize_history(persistent_history_file) + # Cache for prompt_toolkit completion menu styles + self._cached_pt_style: PtStyle | None = None + self._cached_pt_style_params: tuple[Style | None, Style | None] | None = None + # Create the main PromptSession self.bottom_toolbar = bottom_toolbar self.main_session = self._create_main_session(auto_suggest, completekey) @@ -718,37 +723,19 @@ def _should_continue_multiline(self) -> bool: def _get_pt_style(self) -> "PtStyle": """Return the prompt_toolkit style for the completion menu.""" + theme = ru.get_theme() + rich_item_style = theme.styles.get(Cmd2Style.COMPLETION_MENU_ITEM) + rich_meta_style = theme.styles.get(Cmd2Style.COMPLETION_MENU_META) - def to_pt_style(rich_style: Style | None) -> str: - """Convert a rich Style object to a prompt_toolkit style string.""" - if not rich_style: - return "" - parts = ["noreverse"] - if rich_style.color: - c = rich_style.color.get_truecolor() - parts.append(f"fg:#{c.red:02x}{c.green:02x}{c.blue:02x}") - else: - parts.append("fg:default") - - if rich_style.bgcolor: - c = rich_style.bgcolor.get_truecolor() - parts.append(f"bg:#{c.red:02x}{c.green:02x}{c.blue:02x}") - else: - parts.append("bg:default") - - if rich_style.bold is not None: - parts.append("bold" if rich_style.bold else "nobold") - if rich_style.italic is not None: - parts.append("italic" if rich_style.italic else "noitalic") - if rich_style.underline is not None: - parts.append("underline" if rich_style.underline else "nounderline") - return " ".join(parts) + current_params = (rich_item_style, rich_meta_style) + if self._cached_pt_style is not None and self._cached_pt_style_params == current_params: + return self._cached_pt_style - theme = ru.get_theme() - item_style = to_pt_style(theme.styles.get(Cmd2Style.COMPLETION_MENU_ITEM)) - meta_style = to_pt_style(theme.styles.get(Cmd2Style.COMPLETION_MENU_META)) + item_style = to_pt_style(rich_item_style) + meta_style = to_pt_style(rich_meta_style) - return PtStyle.from_dict( + self._cached_pt_style_params = current_params + self._cached_pt_style = PtStyle.from_dict( { "completion-menu.completion.current": item_style, "completion-menu.meta.completion.current": meta_style, @@ -756,6 +743,8 @@ def to_pt_style(rich_style: Style | None) -> str: } ) + return self._cached_pt_style + def _create_main_session(self, auto_suggest: bool, completekey: str) -> PromptSession[str]: """Create and return the main PromptSession for the application. diff --git a/cmd2/pt_utils.py b/cmd2/pt_utils.py index 8ebdb9f3e..62ffe7f72 100644 --- a/cmd2/pt_utils.py +++ b/cmd2/pt_utils.py @@ -20,6 +20,7 @@ from prompt_toolkit.formatted_text import ANSI from prompt_toolkit.history import History from prompt_toolkit.lexers import Lexer +from rich.style import Style from . import ( constants, @@ -50,6 +51,32 @@ def pt_filter_style(text: str | ANSI) -> str | ANSI: return text if isinstance(text, ANSI) else ANSI(text) +def to_pt_style(rich_style: Style | None) -> str: + """Convert a rich Style object to a prompt_toolkit style string.""" + if not rich_style: + return "" + parts = ["noreverse"] + if rich_style.color and not rich_style.color.is_default: + c = rich_style.color.get_truecolor() + parts.append(f"fg:#{c.red:02x}{c.green:02x}{c.blue:02x}") + else: + parts.append("fg:default") + + if rich_style.bgcolor and not rich_style.bgcolor.is_default: + c = rich_style.bgcolor.get_truecolor() + parts.append(f"bg:#{c.red:02x}{c.green:02x}{c.blue:02x}") + else: + parts.append("bg:default") + + if rich_style.bold is not None: + parts.append("bold" if rich_style.bold else "nobold") + if rich_style.italic is not None: + parts.append("italic" if rich_style.italic else "noitalic") + if rich_style.underline is not None: + parts.append("underline" if rich_style.underline else "nounderline") + return " ".join(parts) + + class Cmd2Completer(Completer): """Completer that delegates to cmd2's completion logic.""" diff --git a/tests/test_pt_utils.py b/tests/test_pt_utils.py index 146ab81c8..54ffe5957 100644 --- a/tests/test_pt_utils.py +++ b/tests/test_pt_utils.py @@ -624,3 +624,76 @@ def test_clear(self): history.clear() assert not history.get_strings() + + +class TestToPtStyle: + def test_to_pt_style_none(self): + assert pt_utils.to_pt_style(None) == "" + + def test_to_pt_style_color(self): + from rich.style import Style + + style = Style(color="#123456") + pt_style = pt_utils.to_pt_style(style) + assert "fg:#123456" in pt_style + assert "bg:default" in pt_style + assert "noreverse" in pt_style + + def test_to_pt_style_bgcolor(self): + from rich.style import Style + + style = Style(bgcolor="#654321") + pt_style = pt_utils.to_pt_style(style) + assert "fg:default" in pt_style + assert "bg:#654321" in pt_style + + def test_to_pt_style_default_color(self): + from rich.style import Style + + style = Style(color="default", bgcolor="default") + pt_style = pt_utils.to_pt_style(style) + assert "fg:default" in pt_style + assert "bg:default" in pt_style + + def test_to_pt_style_bold(self): + from rich.style import Style + + style = Style(bold=True) + pt_style = pt_utils.to_pt_style(style) + assert "bold" in pt_style + assert "nobold" not in pt_style + + def test_to_pt_style_nobold(self): + from rich.style import Style + + style = Style(bold=False) + pt_style = pt_utils.to_pt_style(style) + assert "nobold" in pt_style + + def test_to_pt_style_italic(self): + from rich.style import Style + + style = Style(italic=True) + pt_style = pt_utils.to_pt_style(style) + assert "italic" in pt_style + + def test_to_pt_style_noitalic(self): + from rich.style import Style + + style = Style(italic=False) + pt_style = pt_utils.to_pt_style(style) + assert "noitalic" in pt_style + + def test_to_pt_style_underline(self): + from rich.style import Style + + style = Style(underline=True) + pt_style = pt_utils.to_pt_style(style) + assert "underline" in pt_style + + def test_to_pt_style_nounderline(self): + from rich.style import Style + + style = Style(underline=False) + pt_style = pt_utils.to_pt_style(style) + assert "nounderline" in pt_style From 0b5e443ee2cf4cefc53ef039c348cffd6d83d137 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sat, 25 Apr 2026 15:07:21 -0400 Subject: [PATCH 3/8] Add a unit test for _get_pt_style method --- tests/test_cmd2.py | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/tests/test_cmd2.py b/tests/test_cmd2.py index d8093eed1..7ff54ec27 100644 --- a/tests/test_cmd2.py +++ b/tests/test_cmd2.py @@ -1889,6 +1889,48 @@ def do_orate(self, opts, arg) -> None: self.stdout.write(arg + "\n") +def test_get_pt_style_caching(base_app) -> None: + # Get the initial style (populates the cache) + style1 = base_app._get_pt_style() + + # Getting it again should return the exact same object from the cache + style2 = base_app._get_pt_style() + assert style1 is style2 + + # Change the theme which should invalidate the cache + from rich.style import Style + + import cmd2.rich_utils as ru + from cmd2.styles import Cmd2Style + + # Save the original theme to restore later + orig_theme = ru.get_theme() + + try: + ru.set_theme({Cmd2Style.COMPLETION_MENU_ITEM: Style(color="red")}) + + # Getting the style now should return a new object + style3 = base_app._get_pt_style() + assert style3 is not style1 + + # Getting it again should return the new cached object + style4 = base_app._get_pt_style() + assert style4 is style3 + + # Verify the style reflects the change + # In prompt_toolkit 3, styles are accessed differently + attrs = style3.class_names_and_attrs + found = False + for classes, attr in attrs: + if "completion-menu.completion.current" in classes and attr.color in ("800000", "darkred", "ff0000", "#800000"): + found = True + break + assert found, "Color change not found in cached style" + + finally: + ru._APP_THEME = orig_theme + + @pytest.fixture def multiline_app(): return MultilineApp() From a6927c3ba889aaaa40cc63d6523c58a6911cd3a3 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sun, 26 Apr 2026 14:32:35 -0400 Subject: [PATCH 4/8] Change metadata default color to BRIGHT_GREEN instead of LIGHT_GREEN BRIGHT_GREEN is one of the standard 16 colors typically configured by a user's terminal theme. LIGHT_GREEN is from the extended 256-color range. --- cmd2/styles.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd2/styles.py b/cmd2/styles.py index 4d015d30b..ff08bbf3a 100644 --- a/cmd2/styles.py +++ b/cmd2/styles.py @@ -66,7 +66,7 @@ class Cmd2Style(StrEnum): DEFAULT_CMD2_STYLES: dict[str, StyleType] = { Cmd2Style.COMMAND_LINE: Style(color=Color.CYAN, bold=True), Cmd2Style.COMPLETION_MENU_ITEM: Style(color=Color.BLACK, bgcolor=Color.GREEN), - Cmd2Style.COMPLETION_MENU_META: Style(color=Color.BLACK, bgcolor=Color.LIGHT_GREEN), + Cmd2Style.COMPLETION_MENU_META: Style(color=Color.BLACK, bgcolor=Color.BRIGHT_GREEN), Cmd2Style.ERROR: Style(color=Color.BRIGHT_RED), Cmd2Style.HELP_HEADER: Style(color=Color.BRIGHT_GREEN), Cmd2Style.HELP_LEADER: Style(color=Color.CYAN), From 339b73db7cbed449d6d3ea9b9473af08c1246161 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sun, 26 Apr 2026 14:59:00 -0400 Subject: [PATCH 5/8] Added `rich_to_pt_color` conversion helper function Created a new converter function to safely extract the correct string representation for prompt-toolkit: - For `ColorSystem.STANDARD` colors (0-15), it maps directly to `prompt-toolkit`'s `ansicolor` names (e.g. `ansired`, `ansibrightred`). This ensures that `prompt-toolkit` delegates to the terminal's theme for the basic 16 colors. - For `ColorSystem.EIGHT_BIT` and `ColorSystem.TRUECOLOR`, it falls back to parsing the RGB hex code (e.g., `#ff0000`), which `prompt-toolkit` supports natively. Also: - Renamed `to_pt_style` to `rich_to_pt_style` to make its intent more obvious - Added tests for the new `rich_to_pt_color` conversion function --- cmd2/cmd2.py | 6 ++-- cmd2/pt_utils.py | 55 ++++++++++++++++++++++------- tests/test_cmd2.py | 8 ++++- tests/test_pt_utils.py | 78 ++++++++++++++++++++++++++++++------------ 4 files changed, 110 insertions(+), 37 deletions(-) diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index 030acd8be..e82569c5b 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -192,7 +192,7 @@ def __init__(self, msg: str = "") -> None: Cmd2History, Cmd2Lexer, pt_filter_style, - to_pt_style, + rich_to_pt_style, ) from .utils import ( Settable, @@ -731,8 +731,8 @@ def _get_pt_style(self) -> "PtStyle": if self._cached_pt_style is not None and self._cached_pt_style_params == current_params: return self._cached_pt_style - item_style = to_pt_style(rich_item_style) - meta_style = to_pt_style(rich_meta_style) + item_style = rich_to_pt_style(rich_item_style) + meta_style = rich_to_pt_style(rich_meta_style) self._cached_pt_style_params = current_params self._cached_pt_style = PtStyle.from_dict( diff --git a/cmd2/pt_utils.py b/cmd2/pt_utils.py index a898effba..d43db62c6 100644 --- a/cmd2/pt_utils.py +++ b/cmd2/pt_utils.py @@ -30,6 +30,8 @@ from . import string_utils as su if TYPE_CHECKING: # pragma: no cover + from rich.color import Color + from .cmd2 import Cmd @@ -51,22 +53,51 @@ def pt_filter_style(text: str | ANSI) -> str | ANSI: return text if isinstance(text, ANSI) else ANSI(text) -def to_pt_style(rich_style: Style | None) -> str: +def rich_to_pt_color(color: "Color | None") -> str: + """Convert a rich Color object to a prompt_toolkit color string.""" + if not color or color.is_default: + return "default" + + # Use prompt_toolkit's 16 standard ansi color names if applicable. + # This prevents overriding terminal themes with absolute RGB values. + if color.number is not None and 0 <= color.number <= 15: + # prompt_toolkit accepts these standard names directly + ansi_names = [ + "ansiblack", + "ansired", + "ansigreen", + "ansiyellow", + "ansiblue", + "ansimagenta", + "ansicyan", + "ansiwhite", + "ansibrightblack", + "ansibrightred", + "ansibrightgreen", + "ansibrightyellow", + "ansibrightblue", + "ansibrightmagenta", + "ansibrightcyan", + "ansibrightwhite", + ] + return ansi_names[color.number] + + # For 8-bit and truecolor, we fallback to hex RGB strings which prompt-toolkit supports natively + c = color.get_truecolor() + return f"#{c.red:02x}{c.green:02x}{c.blue:02x}" + + +def rich_to_pt_style(rich_style: Style | None) -> str: """Convert a rich Style object to a prompt_toolkit style string.""" if not rich_style: return "" parts = ["noreverse"] - if rich_style.color and not rich_style.color.is_default: - c = rich_style.color.get_truecolor() - parts.append(f"fg:#{c.red:02x}{c.green:02x}{c.blue:02x}") - else: - parts.append("fg:default") - - if rich_style.bgcolor and not rich_style.bgcolor.is_default: - c = rich_style.bgcolor.get_truecolor() - parts.append(f"bg:#{c.red:02x}{c.green:02x}{c.blue:02x}") - else: - parts.append("bg:default") + + fg_color = rich_to_pt_color(rich_style.color) + parts.append(f"fg:{fg_color}") + + bg_color = rich_to_pt_color(rich_style.bgcolor) + parts.append(f"bg:{bg_color}") if rich_style.bold is not None: parts.append("bold" if rich_style.bold else "nobold") diff --git a/tests/test_cmd2.py b/tests/test_cmd2.py index 155927b09..10e46e726 100644 --- a/tests/test_cmd2.py +++ b/tests/test_cmd2.py @@ -1922,7 +1922,13 @@ def test_get_pt_style_caching(base_app) -> None: attrs = style3.class_names_and_attrs found = False for classes, attr in attrs: - if "completion-menu.completion.current" in classes and attr.color in ("800000", "darkred", "ff0000", "#800000"): + if "completion-menu.completion.current" in classes and attr.color in ( + "800000", + "darkred", + "ff0000", + "#800000", + "ansired", + ): found = True break assert found, "Color change not found in cached style" diff --git a/tests/test_pt_utils.py b/tests/test_pt_utils.py index 486bd70b2..a044fc693 100644 --- a/tests/test_pt_utils.py +++ b/tests/test_pt_utils.py @@ -602,74 +602,110 @@ def test_clear(self): assert not history.get_strings() -class TestToPtStyle: - def test_to_pt_style_none(self): - assert pt_utils.to_pt_style(None) == "" +class TestRichToPtColor: + def test_rich_to_pt_color_none(self): + assert pt_utils.rich_to_pt_color(None) == "default" - def test_to_pt_style_color(self): + def test_rich_to_pt_color_default(self): + from rich.color import Color + + c = Color.parse("default") + assert pt_utils.rich_to_pt_color(c) == "default" + + def test_rich_to_pt_color_standard(self): + from rich.color import Color + + c = Color.parse("red") + assert pt_utils.rich_to_pt_color(c) == "ansired" + c = Color.parse("bright_red") + assert pt_utils.rich_to_pt_color(c) == "ansibrightred" + # Test a standard color initialized by number + c = Color.from_ansi(2) + assert pt_utils.rich_to_pt_color(c) == "ansigreen" + + def test_rich_to_pt_color_eight_bit(self): + from rich.color import Color + + # 155 is an 8-bit color + c = Color.from_ansi(155) + # Should convert to truecolor hex equivalent #afff5f + assert pt_utils.rich_to_pt_color(c) == "#afff5f" + + def test_rich_to_pt_color_truecolor(self): + from rich.color import Color + + c = Color.parse("#123456") + assert pt_utils.rich_to_pt_color(c) == "#123456" + + +class TestRichToPtStyle: + def test_rich_to_pt_style_none(self): + assert pt_utils.rich_to_pt_style(None) == "" + + def test_rich_to_pt_style_color(self): from rich.style import Style style = Style(color="#123456") - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "fg:#123456" in pt_style assert "bg:default" in pt_style assert "noreverse" in pt_style - def test_to_pt_style_bgcolor(self): + def test_rich_to_pt_style_bgcolor(self): from rich.style import Style style = Style(bgcolor="#654321") - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "fg:default" in pt_style assert "bg:#654321" in pt_style - def test_to_pt_style_default_color(self): + def test_rich_to_pt_style_default_color(self): from rich.style import Style style = Style(color="default", bgcolor="default") - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "fg:default" in pt_style assert "bg:default" in pt_style - def test_to_pt_style_bold(self): + def test_rich_to_pt_style_bold(self): from rich.style import Style style = Style(bold=True) - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "bold" in pt_style assert "nobold" not in pt_style - def test_to_pt_style_nobold(self): + def test_rich_to_pt_style_nobold(self): from rich.style import Style style = Style(bold=False) - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "nobold" in pt_style - def test_to_pt_style_italic(self): + def test_rich_to_pt_style_italic(self): from rich.style import Style style = Style(italic=True) - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "italic" in pt_style - def test_to_pt_style_noitalic(self): + def test_rich_to_pt_style_noitalic(self): from rich.style import Style style = Style(italic=False) - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "noitalic" in pt_style - def test_to_pt_style_underline(self): + def test_rich_to_pt_style_underline(self): from rich.style import Style style = Style(underline=True) - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "underline" in pt_style - def test_to_pt_style_nounderline(self): + def test_rich_to_pt_style_nounderline(self): from rich.style import Style style = Style(underline=False) - pt_style = pt_utils.to_pt_style(style) + pt_style = pt_utils.rich_to_pt_style(style) assert "nounderline" in pt_style From 2bcda9a7bb63e2f888f9a8f6b66fe8e38bd96d89 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sun, 26 Apr 2026 15:06:37 -0400 Subject: [PATCH 6/8] Move ansi_names list to ANSI_NAMES tuple constant to cleanup function --- cmd2/pt_utils.py | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/cmd2/pt_utils.py b/cmd2/pt_utils.py index d43db62c6..11362dd81 100644 --- a/cmd2/pt_utils.py +++ b/cmd2/pt_utils.py @@ -37,6 +37,26 @@ BASE_DELIMITERS = " \t\n" + "".join(constants.QUOTES) + "".join(constants.REDIRECTION_CHARS) +# prompt_toolkit accepts these standard ANSI color names directly +ANSI_NAMES = ( + "ansiblack", + "ansired", + "ansigreen", + "ansiyellow", + "ansiblue", + "ansimagenta", + "ansicyan", + "ansiwhite", + "ansibrightblack", + "ansibrightred", + "ansibrightgreen", + "ansibrightyellow", + "ansibrightblue", + "ansibrightmagenta", + "ansibrightcyan", + "ansibrightwhite", +) + def pt_filter_style(text: str | ANSI) -> str | ANSI: """Strip styles if disallowed by ru.ALLOW_STYLE. Otherwise return an ANSI object. @@ -61,26 +81,7 @@ def rich_to_pt_color(color: "Color | None") -> str: # Use prompt_toolkit's 16 standard ansi color names if applicable. # This prevents overriding terminal themes with absolute RGB values. if color.number is not None and 0 <= color.number <= 15: - # prompt_toolkit accepts these standard names directly - ansi_names = [ - "ansiblack", - "ansired", - "ansigreen", - "ansiyellow", - "ansiblue", - "ansimagenta", - "ansicyan", - "ansiwhite", - "ansibrightblack", - "ansibrightred", - "ansibrightgreen", - "ansibrightyellow", - "ansibrightblue", - "ansibrightmagenta", - "ansibrightcyan", - "ansibrightwhite", - ] - return ansi_names[color.number] + return ANSI_NAMES[color.number] # For 8-bit and truecolor, we fallback to hex RGB strings which prompt-toolkit supports natively c = color.get_truecolor() From f10f42b72ca7d6b162c98acf1875331a507fbac7 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sun, 26 Apr 2026 15:38:41 -0400 Subject: [PATCH 7/8] Change rich_to_pt_style to take a StyleType instead of Style where StyleType = Style | str --- cmd2/cmd2.py | 6 +++--- cmd2/pt_utils.py | 8 ++++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index e82569c5b..c67779a2e 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -526,7 +526,7 @@ def __init__( # Cache for prompt_toolkit completion menu styles self._cached_pt_style: PtStyle | None = None - self._cached_pt_style_params: tuple[Style | None, Style | None] | None = None + self._cached_pt_style_params: tuple[StyleType, StyleType] | None = None # Create the main PromptSession self.bottom_toolbar = bottom_toolbar @@ -724,8 +724,8 @@ def _should_continue_multiline(self) -> bool: def _get_pt_style(self) -> "PtStyle": """Return the prompt_toolkit style for the completion menu.""" theme = ru.get_theme() - rich_item_style = theme.styles.get(Cmd2Style.COMPLETION_MENU_ITEM) - rich_meta_style = theme.styles.get(Cmd2Style.COMPLETION_MENU_META) + rich_item_style = theme.styles.get(Cmd2Style.COMPLETION_MENU_ITEM, "") + rich_meta_style = theme.styles.get(Cmd2Style.COMPLETION_MENU_META, "") current_params = (rich_item_style, rich_meta_style) if self._cached_pt_style is not None and self._cached_pt_style_params == current_params: diff --git a/cmd2/pt_utils.py b/cmd2/pt_utils.py index 11362dd81..d71c84c28 100644 --- a/cmd2/pt_utils.py +++ b/cmd2/pt_utils.py @@ -20,7 +20,7 @@ from prompt_toolkit.formatted_text import ANSI from prompt_toolkit.history import History from prompt_toolkit.lexers import Lexer -from rich.style import Style +from rich.style import Style, StyleType from . import ( constants, @@ -88,10 +88,14 @@ def rich_to_pt_color(color: "Color | None") -> str: return f"#{c.red:02x}{c.green:02x}{c.blue:02x}" -def rich_to_pt_style(rich_style: Style | None) -> str: +def rich_to_pt_style(rich_style: StyleType) -> str: """Convert a rich Style object to a prompt_toolkit style string.""" if not rich_style: return "" + + if isinstance(rich_style, str): + rich_style = Style.parse(rich_style) + parts = ["noreverse"] fg_color = rich_to_pt_color(rich_style.color) From 3bc0070a720f0a6ad2b205907dcb410f06f84f21 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Sun, 26 Apr 2026 15:52:42 -0400 Subject: [PATCH 8/8] Add unit test for case when a str is passed to rich-to_pt_style --- tests/test_pt_utils.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tests/test_pt_utils.py b/tests/test_pt_utils.py index a044fc693..9b5bdfe3a 100644 --- a/tests/test_pt_utils.py +++ b/tests/test_pt_utils.py @@ -642,6 +642,13 @@ class TestRichToPtStyle: def test_rich_to_pt_style_none(self): assert pt_utils.rich_to_pt_style(None) == "" + def test_rich_to_pt_style_string(self): + pt_style = pt_utils.rich_to_pt_style("bold red on blue") + assert "fg:ansired" in pt_style + assert "bg:ansiblue" in pt_style + assert "bold" in pt_style + assert "nobold" not in pt_style + def test_rich_to_pt_style_color(self): from rich.style import Style