Python Typer Extensions

typer_extensions.py

"""Extensions for the Typer CLI."""

from typing import Optional

import typer


def command_category(command_category: str):
    """Modify the docstring of a function to mark it as a test command.

    Requires the function to have a docstring and rich markdown enabled for proper rendering
    """

    additional: Optional[str] = None

    dict_categories = {
        "test": "bold yellow",
        "demo": "bold blue",
        "management": "bold green",
        "debug": "bold green",
    }

    if command_category.lower().strip() not in dict_categories:
        raise ValueError(f"Unknown command category {command_category}")
    else:
        formatting = dict_categories[command_category]
        additional = f"[{formatting}]\[{command_category.upper()}][/{formatting}] "

    def decorator(func):
        func.__doc__ = additional + func.__doc__
        return func

    return decorator