Renamed ColorName enum to Color.

Author: kmvanbrunt

cmd2/__init__.py

@@ -20,7 +20,7 @@
     set_default_argument_parser_type,
 )
 from .cmd2 import Cmd
-from .colors import ColorName
+from .colors import Color
 from .command_definition import (
     CommandSet,
     with_default_category,
@@ -68,8 +68,8 @@
     'CommandResult',
     'CommandSet',
     'Statement',
-    # Color
-    "ColorName",
+    # Colors
+    "Color",
     # Decorators
     'with_argument_list',
     'with_argparser',

cmd2/colors.py

@@ -8,7 +8,7 @@
     from backports.strenum import StrEnum
 
 
-class ColorName(StrEnum):
+class Color(StrEnum):
     """An enumeration of all color names supported by the Rich library.
 
     Using this enum allows for autocompletion and prevents typos when

cmd2/styles.py

@@ -17,7 +17,7 @@
 else:
     from backports.strenum import StrEnum
 
-from .colors import ColorName
+from .colors import Color
 
 
 class Cmd2Style(StrEnum):
@@ -41,11 +41,11 @@ class Cmd2Style(StrEnum):
 
 # Default styles used by cmd2. Tightly coupled with the Cmd2Style enum.
 DEFAULT_CMD2_STYLES: dict[str, StyleType] = {
-    Cmd2Style.ERROR: Style(color=ColorName.BRIGHT_RED),
-    Cmd2Style.EXAMPLE: Style(color=ColorName.CYAN, bold=True),
-    Cmd2Style.HELP_HEADER: Style(color=ColorName.CYAN, bold=True),
-    Cmd2Style.HELP_TITLE: Style(color=ColorName.BRIGHT_GREEN, bold=True),
-    Cmd2Style.RULE_LINE: Style(color=ColorName.BRIGHT_GREEN),
-    Cmd2Style.SUCCESS: Style(color=ColorName.GREEN),
-    Cmd2Style.WARNING: Style(color=ColorName.BRIGHT_YELLOW),
+    Cmd2Style.ERROR: Style(color=Color.BRIGHT_RED),
+    Cmd2Style.EXAMPLE: Style(color=Color.CYAN, bold=True),
+    Cmd2Style.HELP_HEADER: Style(color=Color.CYAN, bold=True),
+    Cmd2Style.HELP_TITLE: Style(color=Color.BRIGHT_GREEN, bold=True),
+    Cmd2Style.RULE_LINE: Style(color=Color.BRIGHT_GREEN),
+    Cmd2Style.SUCCESS: Style(color=Color.GREEN),
+    Cmd2Style.WARNING: Style(color=Color.BRIGHT_YELLOW),
 }

docs/api/index.md

@@ -30,7 +30,7 @@ incremented according to the [Semantic Version Specification](https://semver.org
 - [cmd2.rl_utils](./rl_utils.md) - imports the proper Readline for the platform and provides utility
   functions for it
 - [cmd2.string_utils](./string_utils.md) - string utility functions
-- [cmd2.styles](./styles.md) - custom Rich styles and their corresponding names for cmd2.
+- [cmd2.styles](./styles.md) - cmd2-specific Rich styles and a StrEnum of their corresponding names
 - [cmd2.terminal_utils](./terminal_utils.md) - support for terminal control escape sequences
 - [cmd2.transcript](./transcript.md) - functions and classes for running and validating transcripts
 - [cmd2.utils](./utils.md) - various utility classes and functions

tests/test_cmd2.py

@@ -21,7 +21,7 @@
 from cmd2 import (
     COMMAND_NAME,
     Cmd2Style,
-    ColorName,
+    Color,
     clipboard,
     constants,
     exceptions,
@@ -1224,7 +1224,7 @@ def test_escaping_prompt() -> None:
     assert rl_escape_prompt(prompt) == prompt
 
     # This prompt has color which needs to be escaped
-    prompt = stylize('InColor', style=ColorName.CYAN)
+    prompt = stylize('InColor', style=Color.CYAN)
 
     escape_start = "\x01"
     escape_end = "\x02"

tests/test_string_utils.py

@@ -3,7 +3,7 @@
 from rich.style import Style
 
 from cmd2 import (
-    ColorName,
+    Color,
     rich_utils,
 )
 from cmd2 import (
@@ -59,7 +59,7 @@ def test_align_left_wide_text() -> None:
 def test_align_left_with_style() -> None:
     character = '-'
 
-    styled_text = su.stylize('table', style=ColorName.BRIGHT_BLUE)
+    styled_text = su.stylize('table', style=Color.BRIGHT_BLUE)
     width = 8
 
     aligned = su.align_left(styled_text, width=width, character=character)
@@ -85,7 +85,7 @@ def test_align_center_wide_text() -> None:
 def test_align_center_with_style() -> None:
     character = '-'
 
-    styled_text = su.stylize('table', style=ColorName.BRIGHT_BLUE)
+    styled_text = su.stylize('table', style=Color.BRIGHT_BLUE)
     width = 8
 
     aligned = su.align_center(styled_text, width=width, character=character)
@@ -111,7 +111,7 @@ def test_align_right_wide_text() -> None:
 def test_align_right_with_style() -> None:
     character = '-'
 
-    styled_text = su.stylize('table', style=ColorName.BRIGHT_BLUE)
+    styled_text = su.stylize('table', style=Color.BRIGHT_BLUE)
     width = 8
 
     aligned = su.align_right(styled_text, width=width, character=character)
@@ -122,8 +122,8 @@ def test_stylize() -> None:
     styled_str = su.stylize(
         HELLO_WORLD,
         style=Style(
-            color=ColorName.GREEN,
-            bgcolor=ColorName.BLUE,
+            color=Color.GREEN,
+            bgcolor=Color.BLUE,
             bold=True,
             underline=True,
         ),
@@ -134,15 +134,15 @@ def test_stylize() -> None:
 
 def test_strip_style() -> None:
     base_str = HELLO_WORLD
-    styled_str = su.stylize(base_str, style=ColorName.GREEN)
+    styled_str = su.stylize(base_str, style=Color.GREEN)
     assert base_str != styled_str
     assert base_str == su.strip_style(styled_str)
 
 
 def test_str_width() -> None:
     # Include a full-width character
     base_str = HELLO_WORLD + "深"
-    styled_str = su.stylize(base_str, style=ColorName.GREEN)
+    styled_str = su.stylize(base_str, style=Color.GREEN)
     expected_width = len(HELLO_WORLD) + 2
     assert su.str_width(base_str) == su.str_width(styled_str) == expected_width
 

tests/test_terminal_utils.py

@@ -3,7 +3,7 @@
 import pytest
 
 from cmd2 import (
-    ColorName,
+    Color,
     string_utils,
 )
 from cmd2 import (
@@ -24,7 +24,7 @@ def test_set_title() -> None:
             '(Cmd) ',
             'help his',
             12,
-            string_utils.stylize('Hello World!', style=ColorName.MAGENTA),
+            string_utils.stylize('Hello World!', style=Color.MAGENTA),
             '\x1b[2K\r\x1b[35mHello World!\x1b[0m',
         ),
         (127, '\n(Cmd) ', 'help ', 5, 'foo', '\x1b[2K\x1b[1A\x1b[2K\rfoo'),