Das Console-Objekt hat eine log()-Methode, die die gleiche Schnittstelle wie print() hat, aber zusätzlich eine Spalte für die aktuelle Zeit und die Datei und Zeile, die den Aufruf gemacht hat, ausgibt. Standardmäßig führt Rich die Syntaxhervorhebung für Python-Strukturen und für repr-Strings durch. Wenn du eine Sammlung (z.B. ein Diktat oder eine Liste) protokollierst, wird Rich diese so hübsch ausgeben, dass sie in den verfügbaren Platz passt. Hier ein Beispiel für einige dieser Funktionen.

from rich.console import Console
console = Console()

test_data = [
    {"jsonrpc": "2.0", "method": "sum", "params": [None, 1, 2, 4, False, True], "id": "1",},
    {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]},
    {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": "2"},
]

def test_log():
    enabled = False
    context = {
        "foo": "bar",
    }
    movies = ["Deadpool", "Rise of the Skywalker"]
    console.log("Hello from", console, "!")
    console.log(test_data, log_locals=True)


test_log()

Die obige Funktion erzeugt die folgende Ausgabe:

Beachte das Argument log_locals, das eine Tabelle mit den lokalen Variablen ausgibt, in der die log-Methode aufgerufen wurde.

Die log-Methode kann für die Protokollierung auf dem Terminal für langlaufende Anwendungen wie Server verwendet werden, ist aber auch eine sehr schöne Hilfe bei der Fehlersuche.

Du kannst auch die eingebaute Handler-Klasse verwenden, um die Ausgabe von Pythons Logging-Modul zu formatieren und einzufärben. Hier ein Beispiel für die Ausgabe:

Um ein Emoji in die Konsolenausgabe einzufügen, setze den Namen zwischen zwei Doppelpunkte. Hier ein Beispiel:

>>> console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")
😃 🧛 💩 👍 🦝

Bitte verwenden Sie diese Funktion mit Bedacht.

Rich kann flexible Tabellen mit Unicode-Box-Characters darstellen. Es gibt eine Vielzahl von Formatierungsmöglichkeiten für Rahmen, Stile, Zellausrichtung usw.

Die obige Animation wurde mit table_movie.py im Verzeichnis examples erzeugt.

Hier ist ein einfacheres Tabellenbeispiel:

from rich.console import Console
from rich.table import Table

console = Console()

table = Table(show_header=True, header_style="bold magenta")
table.add_column("Date", style="dim", width=12)
table.add_column("Title")
table.add_column("Production Budget", justify="right")
table.add_column("Box Office", justify="right")
table.add_row(
    "Dec 20, 2019", "Star Wars: The Rise of Skywalker", "$275,000,000", "$375,126,118"
)
table.add_row(
    "May 25, 2018",
    "[red]Solo[/red]: A Star Wars Story",
    "$275,000,000",
    "$393,151,347",
)
table.add_row(
    "Dec 15, 2017",
    "Star Wars Ep. VIII: The Last Jedi",
    "$262,000,000",
    "[bold]$1,332,539,889[/bold]",
)

console.print(table)

Dies erzeugt diese Ausgabe:

Beachte, dass das Konsolen-Markup auf die gleiche Weise gerendert wird wie print() und log(). Tatsächlich kann alles, was von Rich gerendert werden kann, in den Kopfzeilen/Zeilen enthalten sein (sogar andere Tabellen).

Die Klasse Table ist intelligent genug, um die Größe der Spalten an die verfügbare Breite des Terminals anzupassen und den Text wie erforderlich umzubrechen. Hier ist das gleiche Beispiel, wobei das Terminal kleiner als bei der obigen Tabelle ist:

Rich kann mehrere flackerfreie Fortschrittsbalken darstellen, um langlaufende Aufgaben zu verfolgen.

Einfachste Anwendung ist, eine beliebige Sequenz in die Funktion track einzupacken und über das Ergebnis zu iterieren. Hier ein Beispiel:

from rich.progress import track

for step in track(range(100)):
    do_step(step)

Es ist nicht viel schwieriger, mehrere Fortschrittsbalken hinzuzufügen. Hier ein Beispiel aus der Doku:

Die Spalten können so konfiguriert werden, dass sie alle gewünschten Details anzeigen. Zu den eingebauten Spalten gehören Prozentsatz der Fertigstellung, Dateigröße, Downloadgeschwindigkeit und verbleibende Zeit. Hier ist ein weiteres Beispiel, das einen laufenden Download anzeigt:

Um dies selbst auszuprobieren, sieh dir examples/downloader.py an, das mehrere URLs gleichzeitig herunterladen kann und dabei den Fortschritt anzeigt.

Für Situationen, in denen es schwierig ist, den Fortschritt zu berechnen, kannst du die Methode status verwenden, die eine 'Spinner'-Animation und eine Meldung anzeigt. Die Animation hindert dich nicht daran, die Konsole wie gewohnt zu verwenden. Hier ein Beispiel:

from time import sleep
from rich.console import Console

console = Console()
tasks = [f"task {n}" for n in range(1, 11)]

with console.status("[bold green]Working on tasks...") as status:
    while tasks:
        task = tasks.pop(0)
        sleep(1)
        console.log(f"{task} complete")

Dies erzeugt diese Ausgabe im Terminal.

Die Spinner-Animationen wurden von cli-spinners geliehen. Du kannst einen Spinner auswählen, indem du den Parameter spinner angibst. Führe den folgenden Befehl aus, um die verfügbaren Werte zu sehen:

python -m rich.spinner

Der obige Befehl erzeugt die folgende Ausgabe im Terminal:

Rich kann einen Baum mit Hilfslinien darstellen. Ein Baum ist ideal, um eine Dateistruktur oder andere hierarchische Daten darzustellen.

Die Beschriftungen des Baums können einfacher Text oder alles andere sein, was Rich rendern kann. Führe den folgenden Befehl zur Demonstration aus:

python -m rich.tree

Dies erzeugt diese Ausgabe:

Siehe das Beispiel tree.py für ein Skript, das eine Baumansicht eines beliebigen Verzeichnisses anzeigt, ähnlich dem Linux-Befehl tree.

Rich kann Inhalte sauber in Spalten mit gleicher oder optimaler Breite darstellen. Hier ist ein sehr einfacher Klon des (MacOS / Linux) ls-Befehls, der eine Verzeichnisliste in Spalten anzeigt:

import os
import sys

from rich import print
from rich.columns import Columns

directory = os.listdir(sys.argv[1])
print(Columns(directory))

Der folgende Screenshot ist die Ausgabe von Spalten-Beispiel, das Daten, die aus einer API kommen, in Spalten anzeigt:

Rich kann Markdown rendern und leistet vernünftige Arbeit bei der Übersetzung der Formatierung ins Terminal.

Um Markdown zu rendern, importiere die Klasse Markdown und konstruiere einen String mit Markdown-Code. Gib ihn dann auf der Konsole aus. Hier ein Beispiel:

from rich.console import Console
from rich.markdown import Markdown

console = Console()
with open("README.md") as readme:
    markdown = Markdown(readme.read())
console.print(markdown)

Dies erzeugt diese Ausgabe:

Rich verwendet die Bibliothek pygments zur Implementierung von Syntax-Hervorhebung. Die Verwendung ist gleich dem Rendern von Markdown; konstruieren Sie ein Syntax-Objekt und gib es auf der Konsole aus. Hier ein Beispiel:

from rich.console import Console
from rich.syntax import Syntax

my_code = '''
def iter_first_last(values: Iterable[T]) -> Iterable[Tuple[bool, bool, T]]:
    """Iterate and generate a tuple with a flag for first and last value."""
    iter_values = iter(values)
    try:
        previous_value = next(iter_values)
    except StopIteration:
        return
    first = True
    for value in iter_values:
        yield first, False, previous_value
        first = False
        previous_value = value
    yield first, True, previous_value
'''
syntax = Syntax(my_code, "python", theme="monokai", line_numbers=True)
console = Console()
console.print(syntax)

Dies erzeugt die folgende Ausgabe:

Rich kann schöne Tracebacks rendern, die einfacher zu lesen sind und mehr Code anzeigen, als die Standard-Python-Tracebacks. Du kannst Rich als Standard-Traceback-Handler festlegen, so dass alle nicht abgefangenen Exceptions von Rich gerendert werden.

So sieht es unter OSX aus (ähnlich unter Linux):