Skip to content

Using rich to enhance your console output

The rich package helps make console/terminal output look nicer. It has colorization, animations, and more.

Details

Examples

Simple CLI spinner context manager

This example uses the rich.console.Console and rich.spinner.Spinner classes. The first context manager, get_console(), yields a rich.Console() object, which can be used with the rich.Spinner() class to display a spinner on the command line.

get_console() function
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from contextlib import contextmanager
import typing as t
from rich.console import Console

@contextmanager
def get_console() -> t.Generator[Console, t.Any, None]:
    """Yield a `rich.Console`.

    Usage:
        `with get_console() as console:`

    """
    try:
        console: Console = Console()

        yield console

    except Exception as exc:
        msg = Exception(f"Unhandled exception getting rich Console. Details: {exc}")
        log.error(msg)

        raise exc

The simple_spinner() context manager yields a rich.Spinner() instance. Wrap a function in with simple_spinner(msg="Some message") as spinner: to show a spinner while the function executes.

simple_spinner()
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
from contextlib import contextmanager
from rich.spinner import Spinner

@contextmanager
def simple_spinner(text: str = "Processing... \n", animation: str = "dots"):
    if not text:
        text: str = "Processing... \n"
    assert isinstance(text, str), TypeError(
        f"Expected spinner text to be a string. Got type: ({type(text)})"
    )

    if not text.endswith("\n"):
        text += " \n"

    if not animation:
        animation: str = "dots"
    assert isinstance(animation, str), TypeError(
        f"Expected spinner animation to be a string. Got type: ({type(text)})"
    )

    try:
        _spinner = Spinner(animation, text=text)
    except Exception as exc:
        msg = Exception(f"Unhandled exception getting console spinner. Details: {exc}")
        log.error(msg)

        raise exc

    ## Display spinner
    try:
        with get_console() as console:
            with console.status(text, spinner=animation):
                yield console
    except Exception as exc:
        msg = Exception(
            f"Unhandled exception yielding spinner. Continuing without animation. Details: {exc}"
        )
        log.error(msg)

        pass

Putting both of these functions in the same file allows you to import just the simple_spinner method, which calls get_console() for you. You can also get a console using with get_console() as console:, and write custom spinner/rich logic.

Usage

Example CLI spinner
1
2
3
4
5
from some_modules import simple_spinner

with simple_spinner(text="Thinking... "):
    ## Some long-running code/function
    ...