Cmd2Lexer colors are now part of the cmd2 rich theme

Author: tleonhardt

cmd2/pt_utils.py

@@ -28,6 +28,7 @@
 )
 from . import rich_utils as ru
 from . import string_utils as su
+from .styles import Cmd2Style
 
 if TYPE_CHECKING:  # pragma: no cover
     from rich.color import Color
@@ -259,28 +260,21 @@ class Cmd2Lexer(Lexer):
     def __init__(
         self,
         cmd_app: "Cmd",
-        command_color: str = "ansigreen",
-        alias_color: str = "ansicyan",
-        macro_color: str = "ansimagenta",
-        flag_color: str = "ansired",
-        argument_color: str = "ansiyellow",
     ) -> None:
         """Initialize the Lexer.
 
         :param cmd_app: cmd2.Cmd instance
-        :param command_color: color to use for commands, defaults to 'ansigreen'
-        :param alias_color: color to use for aliases, defaults to 'ansicyan'
-        :param macro_color: color to use for macros, defaults to 'ansimagenta'
-        :param flag_color: color to use for flags, defaults to 'ansired'
-        :param argument_color: color to use for arguments, defaults to 'ansiyellow'
         """
         super().__init__()
         self.cmd_app = cmd_app
-        self.command_color = command_color
-        self.alias_color = alias_color
-        self.macro_color = macro_color
-        self.flag_color = flag_color
-        self.argument_color = argument_color
+
+        # Retrieve styles dynamically from the current theme
+        theme = ru.get_theme()
+        self.command_color = rich_to_pt_style(theme.styles.get(Cmd2Style.LEXER_COMMAND, ""))
+        self.alias_color = rich_to_pt_style(theme.styles.get(Cmd2Style.LEXER_ALIAS, ""))
+        self.macro_color = rich_to_pt_style(theme.styles.get(Cmd2Style.LEXER_MACRO, ""))
+        self.flag_color = rich_to_pt_style(theme.styles.get(Cmd2Style.LEXER_FLAG, ""))
+        self.argument_color = rich_to_pt_style(theme.styles.get(Cmd2Style.LEXER_ARGUMENT, ""))
 
     def lex_document(self, document: Document) -> Callable[[int], Any]:
         """Lex the document."""

cmd2/styles.py

@@ -56,6 +56,11 @@ class Cmd2Style(StrEnum):
     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
+    LEXER_COMMAND = "cmd2.lexer.command"  # Lexer color for commands
+    LEXER_ALIAS = "cmd2.lexer.alias"  # Lexer color for aliases
+    LEXER_MACRO = "cmd2.lexer.macro"  # Lexer color for macros
+    LEXER_FLAG = "cmd2.lexer.flag"  # Lexer color for flags
+    LEXER_ARGUMENT = "cmd2.lexer.argument"  # Lexer color for arguments
     SUCCESS = "cmd2.success"  # Success text (used by psuccess())
     TABLE_BORDER = "cmd2.table_border"  # Applied to cmd2's table borders
     WARNING = "cmd2.warning"  # Warning text (used by pwarning())
@@ -70,6 +75,11 @@ class Cmd2Style(StrEnum):
     Cmd2Style.ERROR: Style(color=Color.BRIGHT_RED),
     Cmd2Style.HELP_HEADER: Style(color=Color.BRIGHT_GREEN),
     Cmd2Style.HELP_LEADER: Style(color=Color.CYAN),
+    Cmd2Style.LEXER_COMMAND: Style(color=Color.GREEN),
+    Cmd2Style.LEXER_ALIAS: Style(color=Color.CYAN),
+    Cmd2Style.LEXER_MACRO: Style(color=Color.MAGENTA),
+    Cmd2Style.LEXER_FLAG: Style(color=Color.RED),
+    Cmd2Style.LEXER_ARGUMENT: Style(color=Color.YELLOW),
     Cmd2Style.SUCCESS: Style(color=Color.GREEN),
     Cmd2Style.TABLE_BORDER: Style(color=Color.BRIGHT_GREEN),
     Cmd2Style.WARNING: Style(color=Color.BRIGHT_YELLOW),

examples/rich_theme.py

@@ -29,6 +29,13 @@ def __init__(self, *args, **kwargs):
             Cmd2Style.HELP_HEADER: Style(color=Color.CYAN, bgcolor="#44475a"),
             Cmd2Style.HELP_LEADER: Style(color="#f8f8f2", bgcolor="#282a36"),  # use RGB hex colors
             Cmd2Style.TABLE_BORDER: Style(color="turquoise2"),  # use a rich standard color
+            Cmd2Style.LEXER_COMMAND: Style(color=Color.LIGHT_GREEN),
+            Cmd2Style.LEXER_ALIAS: Style(color=Color.LIGHT_CYAN1),
+            Cmd2Style.LEXER_MACRO: Style(color=Color.LIGHT_CORAL),
+            Cmd2Style.LEXER_FLAG: Style(color=Color.LIGHT_PINK3),
+            Cmd2Style.LEXER_ARGUMENT: Style(color=Color.LIGHT_GOLDENROD1),
+            Cmd2Style.COMPLETION_MENU_ITEM: Style(color=Color.WHITE, bgcolor=Color.NAVY_BLUE),
+            Cmd2Style.COMPLETION_MENU_META: Style(color=Color.WHITE, bgcolor=Color.DARK_SLATE_GRAY2),
             "traceback.exc_type": Style(color=Color.RED, bgcolor=Color.LIGHT_YELLOW3, bold=True),
             "argparse.args": Style(color=Color.AQUAMARINE3, underline=True),
         }

tests/test_pt_utils.py

@@ -116,7 +116,11 @@ def test_lex_document_command(self, mock_cmd_app):
         get_line = lexer.lex_document(document)
         tokens = get_line(0)
 
-        assert tokens == [("ansigreen", "help"), ("", " "), ("ansiyellow", "something")]
+        assert tokens == [
+            ("noreverse fg:ansigreen bg:default", "help"),
+            ("", " "),
+            ("noreverse fg:ansiyellow bg:default", "something"),
+        ]
 
     def test_lex_document_alias(self, mock_cmd_app):
         """Test lexing an alias."""
@@ -128,7 +132,7 @@ def test_lex_document_alias(self, mock_cmd_app):
         get_line = lexer.lex_document(document)
         tokens = get_line(0)
 
-        assert tokens == [("ansicyan", "ls"), ("", " "), ("ansired", "-l")]
+        assert tokens == [("noreverse fg:ansicyan bg:default", "ls"), ("", " "), ("noreverse fg:ansired bg:default", "-l")]
 
     def test_lex_document_macro(self, mock_cmd_app):
         """Test lexing a macro."""
@@ -140,7 +144,11 @@ def test_lex_document_macro(self, mock_cmd_app):
         get_line = lexer.lex_document(document)
         tokens = get_line(0)
 
-        assert tokens == [("ansimagenta", "my_macro"), ("", " "), ("ansiyellow", "arg1")]
+        assert tokens == [
+            ("noreverse fg:ansimagenta bg:default", "my_macro"),
+            ("", " "),
+            ("noreverse fg:ansiyellow bg:default", "arg1"),
+        ]
 
     def test_lex_document_leading_whitespace(self, mock_cmd_app):
         """Test lexing with leading whitespace."""
@@ -152,7 +160,12 @@ def test_lex_document_leading_whitespace(self, mock_cmd_app):
         get_line = lexer.lex_document(document)
         tokens = get_line(0)
 
-        assert tokens == [("", "   "), ("ansigreen", "help"), ("", " "), ("ansiyellow", "something")]
+        assert tokens == [
+            ("", "   "),
+            ("noreverse fg:ansigreen bg:default", "help"),
+            ("", " "),
+            ("noreverse fg:ansiyellow bg:default", "something"),
+        ]
 
     def test_lex_document_unknown_command(self, mock_cmd_app):
         """Test lexing an unknown command."""
@@ -163,7 +176,7 @@ def test_lex_document_unknown_command(self, mock_cmd_app):
         get_line = lexer.lex_document(document)
         tokens = get_line(0)
 
-        assert tokens == [("", "unknown"), ("", " "), ("ansiyellow", "command")]
+        assert tokens == [("", "unknown"), ("", " "), ("noreverse fg:ansiyellow bg:default", "command")]
 
     def test_lex_document_no_command(self, mock_cmd_app):
         """Test lexing an empty line or line with only whitespace."""
@@ -200,17 +213,17 @@ def test_lex_document_arguments(self, mock_cmd_app):
         tokens = get_line(0)
 
         assert tokens == [
-            ("ansigreen", "help"),
+            ("noreverse fg:ansigreen bg:default", "help"),
             ("", " "),
-            ("ansired", "-v"),
+            ("noreverse fg:ansired bg:default", "-v"),
             ("", " "),
-            ("ansired", "--name"),
+            ("noreverse fg:ansired bg:default", "--name"),
             ("", " "),
-            ("ansiyellow", '"John Doe"'),
+            ("noreverse fg:ansiyellow bg:default", '"John Doe"'),
             ("", " "),
             ("", ">"),
             ("", " "),
-            ("ansiyellow", "out.txt"),
+            ("noreverse fg:ansiyellow bg:default", "out.txt"),
         ]
 
     def test_lex_document_unclosed_quote(self, mock_cmd_app):
@@ -223,7 +236,11 @@ def test_lex_document_unclosed_quote(self, mock_cmd_app):
         get_line = lexer.lex_document(document)
         tokens = get_line(0)
 
-        assert tokens == [("ansigreen", "echo"), ("", " "), ("ansiyellow", '"hello')]
+        assert tokens == [
+            ("noreverse fg:ansigreen bg:default", "echo"),
+            ("", " "),
+            ("noreverse fg:ansiyellow bg:default", '"hello'),
+        ]
 
     def test_lex_document_shortcut(self, mock_cmd_app):
         """Test lexing a shortcut."""
@@ -235,13 +252,13 @@ def test_lex_document_shortcut(self, mock_cmd_app):
         document = Document(line)
         get_line = lexer.lex_document(document)
         tokens = get_line(0)
-        assert tokens == [("ansigreen", "!"), ("ansiyellow", "ls")]
+        assert tokens == [("noreverse fg:ansigreen bg:default", "!"), ("noreverse fg:ansiyellow bg:default", "ls")]
 
         line = "! ls"
         document = Document(line)
         get_line = lexer.lex_document(document)
         tokens = get_line(0)
-        assert tokens == [("ansigreen", "!"), ("", " "), ("ansiyellow", "ls")]
+        assert tokens == [("noreverse fg:ansigreen bg:default", "!"), ("", " "), ("noreverse fg:ansiyellow bg:default", "ls")]
 
     def test_lex_document_multiline(self, mock_cmd_app):
         """Test lexing a multiline command."""
@@ -255,11 +272,11 @@ def test_lex_document_multiline(self, mock_cmd_app):
 
         # First line should have command
         tokens0 = get_line(0)
-        assert tokens0 == [("ansigreen", "orate")]
+        assert tokens0 == [("noreverse fg:ansigreen bg:default", "orate")]
 
         # Second line should have argument (not command)
         tokens1 = get_line(1)
-        assert tokens1 == [("ansiyellow", "help")]
+        assert tokens1 == [("noreverse fg:ansiyellow bg:default", "help")]
 
 
 class TestCmd2Completer: