Enrich (Rich Extensions)

1.2.7 · active · verified Sat Apr 11

The `enrich` library extends the functionality of the popular `rich` library, providing additional features not natively included in `rich`. It offers a custom `Console` class with support for redirecting `sys.stdout`/`sys.stderr` and implicit soft wrapping, as well as an alternative `RichHandler` for logging that prioritizes soft wrapping. The current stable version is 1.2.7, with releases occurring periodically to maintain compatibility with `rich` and add minor enhancements.

Warnings

breaking Future versions (v1.3.0+) will require Python 3.9 or newer. Version 1.2.7 (and earlier) supports Python 3.6+.
Fix: Ensure your project uses Python 3.9 or higher when upgrading to `enrich` version 1.3.0 or later. For current versions (1.2.x), Python 3.6+ is sufficient.
gotcha The `Console` and `RichHandler` classes from `enrich` are distinct from their `rich` counterparts. Using `from rich.console import Console` will *not* provide the `enrich`-specific features like `redirect` or `soft_wrap` parameters.
Fix: Always import `Console` and `RichHandler` from `enrich.console` and `enrich.logging` respectively, to access the extended functionality.
gotcha The `enrich` library is built upon `rich`, and breaking changes or incompatibilities in `rich` itself can affect `enrich` users. Specific versions of `enrich` might pin compatible `rich` versions.
Fix: Refer to `enrich`'s release notes (e.g., 'Avoid incompatible version of rich' in v1.2.4) and its `pyproject.toml` or `setup.py` for exact `rich` version compatibility. Upgrade `rich` cautiously or allow `enrich` to manage its `rich` dependency.

Install

pip install enrich Install stable version

Imports

Console
```
from enrich.console import Console
```
The `enrich` Console class includes additional features like `redirect` and `soft_wrap` parameters not present in the original `rich.console.Console`.
RichHandler
```
from enrich.logging import RichHandler
```
The `enrich` RichHandler provides an alternative logging handler, notably with soft-wrapping behavior, differing from the standard `rich` handler.

Quickstart

This quickstart demonstrates key features of the `enrich` library: a `Console` instance configured to redirect `sys.stdout` and capture output, another `Console` instance with implicit soft-wrapping enabled for print statements, and the `RichHandler` configured for soft-wrapping in standard Python logging.

import logging
from enrich.console import Console
from enrich.logging import RichHandler
import sys

# Example 1: Console with redirect support
console_redirect = Console(redirect=True, record=True)
original_stdout = sys.stdout
sys.stdout = console_redirect.fileproxy

print("This output is redirected and recorded.")
sys.stdout = original_stdout # Restore stdout

# print(f"Captured output: {console_redirect.export_text()}") # Use this to see recorded text

# Example 2: Console with implicit soft wrapping
console_soft_wrap = Console(soft_wrap=True)
console_soft_wrap.print("This is a very long line of text that will be soft-wrapped by the console instance, ensuring it fits within any terminal width without explicit print arguments.")

# Example 3: Soft-wrapping logger
FORMAT = "%(message)s"
logging.basicConfig(
    level="INFO", format=FORMAT, handlers=[RichHandler(soft_wrap=True)]
)
log = logging.getLogger("my_app")
log.info("This log message will also be soft-wrapped.")
log.info("Another long message demonstrating the soft-wrapping logger functionality.")

view raw JSON →