cmd2.styles

Defines custom Rich styles and their corresponding names for cmd2.

This module provides a centralized and discoverable way to manage Rich styles used within the cmd2 framework. It defines a StrEnum for style names and a dictionary that maps these names to their default style objects.

Notes

Cmd2 uses Rich for its terminal output, and while this module defines a set of cmd2-specific styles, it's important to understand that these aren't the only styles that can appear. Components like Rich tracebacks and the rich-argparse library, which cmd2 uses for its help output, also apply their own built-in styles. Additionally, app developers may use other Rich objects that have their own default styles.

For a complete theming experience, you can create a custom theme that includes styles from Rich and rich-argparse. The cmd2.theme.update_theme() function automatically updates rich-argparse's styles with any custom styles provided in your theme dictionary, so you don't have to modify them directly.

You can find Rich's default styles in the rich.default_styles module. For rich-argparse, the style names are defined in the rich_argparse.RichHelpFormatter.styles dictionary.

For prompt-toolkit default styles, see: https://github.com/prompt-toolkit/python-prompt-toolkit/blob/main/src/prompt_toolkit/styles/defaults.py

DEFAULT_CMD2_STYLES = {
    COMMAND_LINE: Style(color=CYAN, bold=True),
    COMPLETION_MENU: Style(
        color="#000000", bgcolor="#bbbbbb"
    ),
    COMPLETION_MENU_COMPLETION: Style(),
    COMPLETION_MENU_CURRENT: Style(
        color=GREEN, bgcolor=BLACK
    ),
    COMPLETION_MENU_META: Style(
        color="#000000", bgcolor="#bbbbbb"
    ),
    COMPLETION_MENU_META_CURRENT: Style(
        color=BLACK, bgcolor=BRIGHT_GREEN
    ),
    ERROR: Style(color=BRIGHT_RED),
    HELP_HEADER: Style(color=BRIGHT_GREEN),
    HELP_LEADER: Style(color=CYAN),
    LEXER_COMMAND: Style(color=GREEN),
    LEXER_ALIAS: Style(color=CYAN),
    LEXER_MACRO: Style(color=MAGENTA),
    LEXER_FLAG: Style(color=RED),
    LEXER_ARGUMENT: Style(color=YELLOW),
    SUCCESS: Style(color=GREEN),
    TABLE_BORDER: Style(color=BRIGHT_GREEN),
    WARNING: Style(color=BRIGHT_YELLOW),
}

DEFAULT_ARGPARSE_STYLES = copy()

COMMAND_LINE = 'cmd2.example'

COMPLETION_MENU = 'cmd2.completion-menu'

COMPLETION_MENU_COMPLETION = (
    "cmd2.completion-menu.completion"
)

COMPLETION_MENU_CURRENT = (
    "cmd2.completion-menu.completion.current"
)

COMPLETION_MENU_META = (
    "cmd2.completion-menu.meta.completion"
)

COMPLETION_MENU_META_CURRENT = (
    "cmd2.completion-menu.meta.completion.current"
)

ERROR = 'cmd2.error'

HELP_HEADER = 'cmd2.help.header'

HELP_LEADER = 'cmd2.help.leader'

LEXER_COMMAND = 'cmd2.lexer.command'

LEXER_ALIAS = 'cmd2.lexer.alias'

LEXER_MACRO = 'cmd2.lexer.macro'

LEXER_FLAG = 'cmd2.lexer.flag'

LEXER_ARGUMENT = 'cmd2.lexer.argument'

SUCCESS = 'cmd2.success'

TABLE_BORDER = 'cmd2.table_border'

WARNING = 'cmd2.warning'