Generate string with markup from highlighter and theme rules

[mrvkino]

Hi,

I am trying to document my Typer cli app. For my cli, I have a configuration with multiple values.

In my help, I want to show an example of a config file and its values. Typer uses string with markup as its way to generate the help message. Since, I would like to reuse one of my config file used for testing as the example in the help, I was looking for a way to insert markup in the text of the config automatically.

I found a way using a highlighter and a manual string replace to obtain a markup string accepted by Typer. But, I was wondering if there was a better way I missed.

Here is an example code of my solution:

from textwrap import dedent

import typer
from rich.console import Console
from rich.highlighter import RegexHighlighter
from rich.style import Style
from rich.theme import Theme

app = typer.Typer(rich_markup_mode="rich")


class ConfigTOMLlHighlighter(RegexHighlighter):
    """Apply style to toml file."""

    base_style = "toml."
    highlights = [
        r"(?P<variable>\w+)\=",
        r"(?P<string>[\'\"].*?[\"\'])",
    ]


def highlight():
    # config represent the config file I want to colorize
    config = "#Config used for testing and docs\nvariable='/complex/path'"
    theme_dict = {
        "toml.variable": "white",
        "toml.string": "green",
    }
    highlighter = ConfigTOMLlHighlighter()
    highlight_text = highlighter(config)
    raw_string = highlight_text.markup
    for k, v in theme_dict.items():
        raw_string = raw_string.replace(k, v)
    return raw_string


def help_string():
    help_string = dedent(
        """
        This [blue]help string[/blue] supports [yellow]rich[/yellow]
        """
    )
    return f"{help_string}\n{highlight()}"


@app.command(help=help_string())
def main():
    pass


if __name__ == "__main__":
    app()

P.S.: I looked at using console, theme and highlighter together, but they all returned markup converted to ANSI code or Style object.