Python终端美化库Rich

目录

 

一、简介与安装 

1.1、简介

1.2、安装

1.3、rich库描述

二、应用Demo

2.1、打印功能

2.2、使用控制台

2.3、log方法

2.4、表情符号

2.5、表格

2.6、进度条

2.7、列

2.8、markdown

2.9、语法突出显示

---

一、简介与安装 

1.1、简介

Rich 是一个 Python 库，用于在终端中提供富文本格式和精美的格式。

Rich 是一个非常强大的 Python 库，不仅在终端中提供丰富的文本和漂亮的格式，还可以显示表情符号、表格、进度条、标记，甚至语法突出显示的代码。可以在终端中提供富文本和精美格式。Rich API 可以很容易的在终端输出添加各种颜色和不同风格。Rich 还可以绘制漂亮的表格，进度条，markdown，突出显示语法的源代码及回溯等等，不胜枚举。

1.2、安装

pip install rich

1.3、rich库描述

python -m rich

 

二、应用Demo

2.1、打印功能

想毫不费力地将 Rich 的输出功能添加到您的应用程序中，只需导入rich 打印方法，该方法和其他 Python 的自带功能的参数类似。

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

2.2、使用控制台

想要对 Rich 终端内容进行更多控制，导入并构造一个控制台对象。

from rich.console import Console
console = Console()

Console 对象含有一个 print 方法，它的界面与 python 内置的 print 功能界面相似。

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

这时终端上会显示 “Hello World”。请注意，与内置的 “打印” 功能不同，Rich 会将文字自动换行以适合终端宽度。有几种方法可以为输出添加颜色和样式。可以通过添加 style 关键字参数来为整个输出设置样式。

from rich.console import Console
console = Console()
console.print("Hello", "style= bold red!", style="bold red")

这个范例一次只设置了一行文字的样式。如果想获得更细腻更复杂的样式，Rich 可以渲染一个特殊的标记，其语法类似于 bbcode。

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

2.3、log方法

Console 对象具有一个 log() 方法，该方法具有与 print() 类似的界面，除此之外，还能成列显示当前时间以及被调用的文件和行。默认情况下，Rich 将针对 Python 结构和 repr 字符串进行语法突出显示。如果您记录一个集合（如字典或列表），Rich 会把它漂亮地打印出来，使其贴合可用空间。

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

注意其中的 log_locals 参数会输出一个表格，该表格包含调用 log 方法的局部变量。log 方法既可用于将长时间运行应用程序（例如服务器）的日志记录到终端，也可用于辅助调试。

2.4、表情符号

将名称放在两个冒号之间即可在控制台输出中插入表情符号。

from rich.console import Console
console = Console()
console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")

2.5、表格

Rich 可以使用 Unicode 框字符来呈现多变的 表格。Rich 包含多种边框，样式，单元格对齐等格式设置的选项。

from rich.console import Console
from rich.table import Column, 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(
    "Dev 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)

请注意，控制台标记的呈现方式与 print() 和 log() 相同。实际上，由 Rich 渲染的任何内容都可以添加到标题/行（甚至其他表格）中。Table 类很聪明，可以调整列的大小以适合终端的可用宽度，并能根据需要环绕文本。

2.6、进度条

Rich 可以渲染多个不闪烁的进度条形图，以跟踪长时间运行的任务。基本用法：用 track 函数调用任何程序并迭代结果。

from rich.progress import track
import time
for step in track(range(100)):
    print('i love china!')
    time.sleep(0.02)

2.7、列

Rich 可以将内容通过排列整齐的，具有相等或最佳的宽度的列来呈现。下面是（macOS / Linux）ls命令的一个非常基本的克隆，用于用列来显示目录列表：

import os
import sys

from rich import print
from rich.columns import Columns

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

2.8、markdown

Rich 可以呈现 markdown，并可相当不错的将其格式转移到终端。为了渲染 markdown，请导入 Markdown 类，并使用包含 markdown 代码的字符串来构造它，然后将其打印到控制台。

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

console = Console()
with open("README.en.md", encoding='utf-8') as readme:
    markdown = Markdown(readme.read())
console.print(markdown)

2.9、语法突出显示

Rich 使用pygments库来实现语法高亮显示。用法类似于渲染 markdown。构造一个 Syntax 对象并将其打印到控制台。

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)