pom11 / rich_format

Replicates python string formatting to rich Text instances

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rich_format

PyPI PyPI

rich_format replicates python string formatting for rich Text instances adding the possibility to substitute also with Text.

>>> from rich.console import Console
>>> from rich.text import Text
>>> import rich_format
>>> console = Console()
>>> text = Text("Hello {name}",style="red on white")
>>> formatted_text = t.format(name=Text("pom11"))
>>> console.print(text)
Hello {name}
>>> console.print(formatted_text)
Hello pom11

See more examples running rich_format.test or inspect this.

Usage

First you need to import Text from rich so that rich_format works.

from rich.text import Text
import rich_format

Textual

You can use rich_format in textual to format easier reactive in custom widgets

rich_format.demo

from textual.reactive import reactive
from textual.app import App, ComposeResult
from textual.widgets import Footer
from textual.widgets import Static
from rich.text import Text
import rich_format
import random

city = [
    Text.from_markup("from [blue on red]London[/]"),
    Text.from_markup("from [magenta on blue]New York[/]"),
    Text.from_markup("from [green]Bucharest[/]"),
    Text.from_markup("from [red on white]Tokyo[/]")
]

class CustomHeader(Static):
    banner : Text = reactive(Text(""))
    world : str = reactive("")

    def __init__(self, template: str) -> None:
        self.template = template
        super().__init__()

    def watch_banner(self, banner: Text) -> None:
        self.update(banner)

    def watch_world(self, world: str) -> None:
        self.banner = Text(self.template).format(world=world)

class DemoApp(App):

    BINDINGS = [
    ("q","quit","Quit"),
    ("h", "toggle_header", "Random header")
    ]

    def compose(self) -> ComposeResult:
        yield CustomHeader(template="Hello {world}")
        yield Footer()

    def action_toggle_header(self) -> None:
        widget = self.query_one(CustomHeader)
        widget.world = random.choice(city)


if __name__ == "__main__":
    app = DemoApp()
    app.run()

Installation

Stable release - pypi

To install rich_format run this command in your terminal

pip install rich_format

From sources

The sources for rich_format can be downloaded from Github

  • clone the public repository
git clone https://github.com/pom11/rich_format
  • install from source
python setup.py install

About

Replicates python string formatting to rich Text instances

License:MIT License


Languages

Language:Python 100.0%