Rich Console Utilities

A small utility module built on top of Rich for producing colourful, prettified drop-in replacement of built-in print() function.

The main contens are:

• A drop-in replacement for print
• A decorator for running functions with a spinner/status indicator like npm

Installation

This module depends on Rich:

pip install themed-print

Usage

Pretty Print (Drop-in Replacement)

themed_print.print can be used as a drop-in replacement for the built-in print() function

from themed_print import print

print({
    "name": "Alice",
    "values": [1, 2, 3],
    "active": True,
})

With custom indentation:

print(data, indent=2, show_guideline=True)

Arguments:

Status Spinner Decorator

Run a function with a live spinner:

from themed_print import show_status
import time

@show_status("Running task…", exit_message="Done ✔")
def task():
    for i in range(3):
        time.sleep(0.5)
        print("step", i)

task()

Supported parameters:

Instance Method Behaviour

If the decorated function is an instance method, logging is skipped when:

self._show_status = False

This allows silent execution in batch or test modes.

Customisation

The colour schemed is implemented through rich.theme.Theme object with customised regex highlighter themed_print.DTypeRegexHighlighter.

Currently, colour schemes are defined in themed_print.config.DEFAULT_THEME Support for custom theming is planned for future releases.

Author

Yiheng Yu Created: Jan 1, 2025