rich，一个无敌的 Python 库！

大家好，我是涛哥，本文内容来自 涛哥聊Python ，转载请标原创。

更多Python学习内容：http://ipengtao.com

今天为大家分享一个无敌的 Python 库 - rich。

Github地址：https://github.com/Textualize/rich

---

在现代软件开发中，命令行界面（CLI）是与用户交互的常见方式之一。一个美观且功能丰富的 CLI 可以显著提升用户体验。Rich 是一个功能强大且易于使用的 Python 库，专为在命令行中创建美观的输出而设计。它支持丰富的文本样式、彩色输出、进度条、表格和日志等功能，帮助开发者快速构建出色的命令行应用程序。本文将详细介绍 Rich 库，包括其安装方法、主要特性、基本和高级功能，以及实际应用场景，帮助全面了解并掌握该库的使用。

安装

要使用 Rich 库，首先需要安装它。以下是安装步骤：

使用 pip 安装

可以通过 pip 直接安装 Rich：

pip install rich

特性

1. 丰富的文本样式：支持粗体、斜体、下划线、颜色等多种文本样式。
2. 彩色输出：在终端中输出彩色文本，提升可读性。
3. 进度条：方便地显示任务进度，支持多种样式和配置。
4. 表格：支持在终端中显示格式化的表格，提升数据展示效果。
5. 日志：提供丰富的日志输出功能，支持彩色和格式化的日志记录。
6. Markdown 支持：能够在终端中渲染 Markdown 格式文本。

基本功能

输出彩色文本

可以使用 print 函数配合 Rich 库输出彩色文本：

from rich import print

print("[bold magenta]Hello[/bold magenta] [green]World[/green]!")

输出表格

可以使用 Table 类在终端中输出格式化的表格：

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

console = Console()

table = Table(show_header=True, header_style="bold magenta")
table.add_column("ID", style="dim", width=6)
table.add_column("Name")
table.add_column("Age", justify="right")

table.add_row("1", "John Doe", "28")
table.add_row("2", "Jane Smith", "34")
table.add_row("3", "Mike Johnson", "45")

console.print(table)

显示进度条

可以使用 Progress 类在终端中显示任务进度条：

from rich.progress import Progress
import time

with Progress() as progress:
    task = progress.add_task("[cyan]Processing...", total=100)
    while not progress.finished:
        progress.update(task, advance=1)
        time.sleep(0.1)

输出日志

可以使用 Rich 库的日志功能输出格式化的日志：

from rich.console import Console
from rich.logging import RichHandler
import logging

console = Console()
logging.basicConfig(level="NOTSET", handlers=[RichHandler(console=console)])
log = logging.getLogger("rich")

log.info("This is an info message.")
log.warning("This is a warning message.")
log.error("This is an error message.")

渲染 Markdown

可以使用 Markdown 类在终端中渲染 Markdown 格式文本：

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

console = Console()

markdown = """
# Hello, World!

This is a sample markdown text.

- Item 1
- Item 2
- Item 3
"""

md = Markdown(markdown)
console.print(md)

高级功能

自定义进度条样式

可以自定义进度条的样式和行为：

from rich.progress import Progress, BarColumn, TextColumn, TimeRemainingColumn
import time

progress = Progress(
    TextColumn("[bold blue]{task.fields[task_name]}", justify="right"),
    BarColumn(),
    "[progress.percentage]{task.percentage:>3.1f}%",
    TimeRemainingColumn(),
)

with progress:
    task1 = progress.add_task("[cyan]Task 1...", total=100, task_name="Task 1")
    task2 = progress.add_task("[magenta]Task 2...", total=200, task_name="Task 2")

    while not progress.finished:
        progress.update(task1, advance=0.5)
        progress.update(task2, advance=1)
        time.sleep(0.1)

自定义日志格式

可以自定义日志输出的格式和样式：

from rich.logging import RichHandler
import logging

FORMAT = "%(message)s"
logging.basicConfig(level="DEBUG", format=FORMAT, datefmt="[%X]", handlers=[RichHandler()])
log = logging.getLogger("rich")

log.debug("This is a debug message.")
log.info("This is an info message.")
log.warning("This is a warning message.")
log.error("This is an error message.")
log.critical("This is a critical message.")

使用 Panel 显示信息

可以使用 Panel 类在终端中显示格式化的信息面板：

from rich.console import Console
from rich.panel import Panel

console = Console()

panel = Panel("This is a panel with [red]Rich[/red] text.", title="Panel Title")
console.print(panel)

实际应用场景

构建命令行工具

在构建命令行工具时，通过 Rich 提供美观的输出，提升用户体验。

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

console = Console()

def main():
    parser = argparse.ArgumentParser(description="Sample CLI Tool")
    parser.add_argument("--name", type=str, required=True, help="Your name")
    args = parser.parse_args()

    table = Table(show_header=True, header_style="bold magenta")
    table.add_column("Parameter", style="dim", width=12)
    table.add_column("Value")

    table.add_row("Name", args.name)

    console.print(table)

if __name__ == "__main__":
    main()

实时监控任务

在实时监控任务时，通过 Rich 提供实时更新的进度条，便于监控任务进度。

from rich.progress import Progress
import time

def monitor_task():
    with Progress() as progress:
        task = progress.add_task("[green]Processing...", total=100)
        while not progress.finished:
            progress.update(task, advance=1)
            time.sleep(0.1)

if __name__ == "__main__":
    monitor_task()

数据分析报告

在数据分析报告中，通过 Rich 提供格式化的表格和 Markdown 渲染，提升报告的可读性。

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

console = Console()

def generate_report(data):
    markdown = """
    # Data Analysis Report

    ## Summary
    """
    md = Markdown(markdown)
    console.print(md)

    table = Table(show_header=True, header_style="bold magenta")
    table.add_column("Metric", style="dim", width=12)
    table.add_column("Value")

    for metric, value in data.items():
        table.add_row(metric, str(value))

    console.print(table)

if __name__ == "__main__":
    data = {"Total Sales": 1000, "Revenue": 50000, "Growth": "5%"}
    generate_report(data)

总结

Rich 库是一个功能强大且易于使用的工具，能够帮助开发者在命令行中创建美观和功能丰富的输出。通过支持丰富的文本样式、彩色输出、进度条、表格、日志和 Markdown 渲染，Rich 提供了强大的功能和灵活的扩展能力。本文详细介绍了 Rich 库的安装方法、主要特性、基本和高级功能，以及实际应用场景。希望本文能帮助大家全面掌握 Rich 库的使用，并在实际项目中发挥其优势。无论是在构建命令行工具、实时监控任务还是数据分析报告中，Rich 库都将是一个得力的工具。