Function set_theme

cmd2/rich_utils.py:321–352

Set the Rich theme used by cmd2. This function performs an in-place update of the existing theme's styles. This ensures that any Console objects already using the theme will reflect the changes immediately without needing to be recreated. Call set_theme() with no arguments to reset

(styles: Mapping[str, StyleType] | None = None)

def set_theme(styles: Mapping[str, StyleType] | None = None) -> None:
    """Set the Rich theme used by cmd2.

    This function performs an in-place update of the existing theme's
    styles. This ensures that any Console objects already using the theme
    will reflect the changes immediately without needing to be recreated.

    Call set_theme() with no arguments to reset to the default theme.
    This will clear any custom styles that were previously applied.

    :param styles: optional mapping of style names to styles
    """
    theme = get_theme()

    # Start with a fresh copy of the default styles.
    unparsed_styles: dict[str, StyleType] = {}
    unparsed_styles.update(_create_default_theme().styles)

    # Add the custom styles, which may contain unparsed strings
    if styles is not None:
        unparsed_styles.update(styles)

    # Use Rich's Theme class to perform the parsing
    parsed_styles = Theme(unparsed_styles).styles

    # Perform the in-place update with the results
    theme.styles.clear()
    theme.styles.update(parsed_styles)

    # Synchronize rich-argparse styles with the main application theme.
    for name in Cmd2HelpFormatter.styles.keys() & theme.styles.keys():
        Cmd2HelpFormatter.styles[name] = theme.styles[name]


def _create_default_theme() -> Theme: