English readme • 简体中文 readme • 正體中文 readme • Lengua española readme • Deutsche readme • Läs på svenska • 日本語 readme • 한국어 readme • Français readme • Schwizerdütsch readme • हिन्दी readme • Português brasileiro readme • Italian readme • Русский readme • فارسی readme • Türkçe readme • Polskie readme

Rich est une bibliothèque Python pour le rich texte et la mise en forme dans le terminal.

L'API Rich permet d'ajouter facilement de la couleur et du style sur le texte du terminal. Rich peut également rendre de jolis tableaux, des barres de progression, du markdown, du code source avec de la coloration syntaxique, des messages d'erreurs et bien d'autres choses encore, et ce dès le départ.

Pour une introduction vidéo à Rich, voir camelcode.io par @ fishnets88

Voyez ce que les gens disent de Rich

Compatibilité

Rich fonctionne avec Linux, OSX et Windows. True color / emoji fonctionne avec le nouveau Terminal Windows, le terminal classique est limité à 16 couleurs. Rich nécessite Python 3.6.3 ou plus.

Rich fonctionne avec les notebooks Jupyter sans configuration supplémentaire.

Installation

Installez avec pip ou votre gestionnaire de paquets PyPI préféré.

python -m pip install rich

Exécutez ce qui suit pour tester la sortie de Rich sur votre terminal :

python -m rich

Rich Print

Pour ajouter sans effort une sortie Rich à votre application, vous pouvez importer la méthode rich print, qui a la même signature que la fonction Python intégrée. Essayez ceci :

from rich import print

print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())

Rich REPL

Rich peut être installé dans le REPL de Python, de sorte que toutes les structures de données soient joliment affichées et mises en évidence.

>>> from rich import pretty
>>> pretty.install()

Utilisation de Console

Pour mieux contrôler le contenu rich du terminal, importez et construisez une classe Console

from rich.console import Console

console = Console()

La classe Console possède une méthode print dont l'interface est intentionnellement similaire à celle de la fonction print native. Voici un exemple d'utilisation :

console.print("Hello", "World!")

Comme vous pouvez vous y attendre, cela va afficher "Hello World !" sur le terminal. Notez que, contrairement à la fonction d'affichage intégrée, Rich mettra votre texte en forme pour qu'il tienne dans la largeur du terminal.

Il y a plusieurs façons d'ajouter de la couleur et du style à votre sortie de texte. Vous pouvez définir un style pour l'ensemble de la sortie de texte en ajoutant un argument de mot-clé style. Voici un exemple :

console.print("Hello", "World!", style="bold red")

La sortie de texte sera quelque chose comme ce qui suit :

C'est très bien pour styliser une ligne de texte à la fois. Pour un style plus fin, Rich rend un balisage spécial dont la syntaxe est similaire à celle du bbcode. Voici un exemple :

console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")

Vous pouvez utiliser un objet Console pour générer une sortie sophistiquée avec un effort minimal. Consultez la documentation de l'API Console pour plus de détails.

Rich Inspect

Rich possède une fonction inspect qui peut produire un rapport sur n'importe quel objet Python, comme une classe, une instance ou une fonction intégrée.

>>> my_list = ["foo", "bar"]
>>> from rich import inspect
>>> inspect(my_list, methods=True)

Consultez la documentation d'inspect pour plus de détails.

Bibliothèque Rich

Rich contient un certain nombre d'éléments de rendu intégrés que vous pouvez utiliser pour créer une sortie élégante dans votre CLI et vous aider à déboguer votre code.

Cliquez sur les rubriques suivantes pour plus de détails :

Log

L'objet Console a une méthode log() qui a une interface similaire à print(), mais qui rend aussi une colonne pour l'heure actuelle, le fichier et la ligne qui ont fait l'appel. Par défaut, Rich fera la coloration syntaxique des structures Python et des chaînes repr. Si vous enregistrez une collection (i.e. un dict ou une liste) Rich affichera la collection de façon à ce qu'elle tienne dans l'espace disponible. Voici un exemple de certaines de ces fonctionnalités.

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()

L'opération ci-dessus produit le résultat suivant :

Notez l'argument log_locals, qui produit un tableau contenant les variables locales où la méthode log a été appelée.

La méthode log peut être utilisée pour la journalisation vers le terminal pour les applications qui tournent longtemps, comme les serveurs, mais c'est aussi une très bonne aide au débogage.

Journalisation

Vous pouvez également utiliser la classe intégrée Handler pour formater et coloriser les textes de sortie du module de journalisation de Python. Voici un exemple de texte de sortie :

Emoji

Pour insérer un emoji dans la sortie de la console, placez le nom entre deux points. Voici un exemple :

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

Veuillez utiliser cette fonction à bon escient.

Tableaux

Rich peut rendre des tableaux flexibles avec des caractères unicodes. Il existe une grande variété d'options de formatage pour les bordures, les styles, l'alignement des cellules, etc.

L'animation ci-dessus a été générée avec table_movie.py dans le répertoire des exemples.

Voici un exemple de tableau plus simple :

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)

Cela produit le résultat suivant :

Notez que les balises de la console sont rendues de la même manière que print() et log(). De fait, tout ce qui peut être rendu par Rich peut être inclus dans les en-têtes / lignes (même d'autres tables).

La classe Table est suffisamment intelligente pour redimensionner les colonnes en fonction de la largeur disponible du terminal, en enveloppant et en réduisant le texte si nécessaire. Voici le même exemple, avec un terminal plus petit que le tableau ci-dessus :

Barres de progression

Rich peut afficher plusieurs barres de progression sans scintillement pour suivre les tâches de longue périodes.

Pour une utilisation basique, créez une boucle sur n'importe quelle séquence dans la fonction track et itérez sur le résultat. Voici un exemple :

from rich.progress import track

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

Il n'est pas beaucoup plus difficile d'ajouter plusieurs barres de progression. Voici un exemple tiré de la documentation :

Les colonnes peuvent être configurées pour afficher tous les détails que vous souhaitez. Les colonnes intégrées comprennent le pourcentage d'achèvement, la taille du fichier, la vitesse du fichier et le temps restant. Voici un autre exemple montrant un téléchargement en cours :

Pour l'essayer vous-même, testez examples/downloader.py qui peut télécharger plusieurs URL simultanément tout en affichant la progression au fil du temps.

Statut

Pour les situations où il est difficile de calculer la progression, vous pouvez utiliser la méthode status qui affichera une animation et un message de type "spinner". L'animation ne vous empêchera pas d'utiliser la console normalement. Voici un exemple :

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")

Cela génère la sortie suivante dans le terminal.

Les animations des characteres d'animations ont été empruntées à cli-spinners. Vous pouvez en sélectionner un en spécifiant le paramètre spinner. Exécutez la commande suivante pour voir les valeurs disponibles :

python -m rich.spinner

La commande ci-dessus génère la sortie suivante dans le terminal :

Arborescence

Rich peut affiché une arborescence avec des lignes de repère. Une arborescence est idéale pour afficher une structure de fichiers, ou toute autre donnée hiérarchique.

Les étiquettes de cette arborescence peuvent être du texte simple ou tout autre élément que Rich peut rendre. Exécutez ce qui suit pour une démonstration :

python -m rich.tree

La commande ci-dessus génère la sortie suivante dans le terminal :

Voir l'exemple tree.py pour un script qui affiche une vue arborescente de n'importe quel répertoire, similaire à la commande linux tree.

Colonnes

Rich peut rendre du contenu en colonnes avec une largeur égale ou optimale. Voici un clone très basique de la commande ls (MacOS / Linux) qui affiche une liste de répertoires en colonnes :

import os
import sys

from rich import print
from rich.columns import Columns

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

La capture d'écran suivante est le résultat de columns example qui affiche les données extraites d'une API en colonnes :

Markdown

Rich peut rendre le markdown et fait un travail raisonnable pour traduire le formatage dans le terminal.

Pour rendre du markdown, importez la classe Markdown et construisez-la avec une chaîne contenant du code markdown. Ensuite, affichez-la dans la console. Voici un exemple :

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)

Cela produira un résultat semblable à ce qui suit :

Mise en couleur de la syntaxe

Rich utilise la bibliothèque pygments pour implémenter la coloration syntaxique. L'utilisation est similaire au rendu de markdown ; construire un objet Syntax et afficher celui-ci sur la console. Voici un exemple :

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)

Cela produira le résultat suivant :

Tracebacks

Rich peut rendre des traçages d'erreurs plus faciles à lire et qui montrent plus de code que les traçages d'erreurs standard de Python. Vous pouvez définir Rich comme le gestionnaire d'erreurs par défaut afin que toutes les exceptions/erreurs non capturées soient rendues par Rich.

Voici à quoi cela ressemble sous OSX (similaire sous Linux) :

Tous les éléments de rendu utilisent le Console Protocol, que vous pouvez également utiliser pour mettre en œuvre votre propre contenu Rich.

Rich pour les entreprises

Disponible dans le cadre de l'abonnement Tidelift.

Les mainteneurs de Rich et de milliers d'autres paquets collaborent avec Tidelift pour fournir un support et une maintenance commerciale pour les paquets open source que vous utilisez pour construire vos applications. Gagnez du temps, réduisez les risques et améliorez votre qualité de code, tout en payant les mainteneurs des paquets que vous utilisez. En savoir plus

Projets utilisant Rich

BrancoLab/BrainRender un package python pour la visualisation de données neuro-anatomiques tridimensionnelles
Ciphey/Ciphey Outil de déchiffrage automatisé
emeryberger/scalene un profileur de CPU et de mémoire haute performance et haute précision pour Python
hedythedev/StarCli Parcourir les projets tendances de GitHub à partir de votre ligne de commande
intel/cve-bin-tool Cet outil recherche un certain nombre de composants courants et vulnérables (openssl, libpng, libxml2, expat et quelques autres) pour vous indiquer si votre système comprend des bibliothèques présentant des vulnérabilités connues.
nf-core/tools Paquet Python contenant des outils d'aide pour la communauté nf-core.
cansarigol/pdbr pdb + bibliothèque Rich pour un débogage amélioré
plant99/felicette L'imagerie satellite pour les nuls.
seleniumbase/SeleniumBase Automatisez et testez 10 fois plus vite avec Selenium et pytest. Piles incluses.
smacke/ffsubsync Synchronisation automatique des sous-titres avec la vidéo.
tryolabs/norfair Bibliothèque Python légère pour ajouter le suivi d'objets 2D en temps réel à n'importe quel détecteur.
ansible/ansible-lint Ansible-lint vérifie dans les playbooks les pratiques et comportements qui pourraient être améliorés.
ansible-community/molecule Cadre de test Ansible Molecule.
Beaucoup d'autres !