使用 Rich 來美化終端格式

Rich 是一個非常強大的 Python 庫，不僅在終端中提供豐富的文本和漂亮的格式，還可以顯示錶情符號、表格、進度條、標記，甚至語法突出顯示的代碼。

Rich 是一個 Python 庫，可以爲您在終端中提供富文本和精美格式。Rich API 可以很容易的在終端輸出添加各種顏色和不同風格。Rich 還可以繪製漂亮的表格，進度條，markdown，突出顯示語法的源代碼及回溯等等，不勝枚舉。

    1. 兼容性

Rich 適用於 Linux，OSX 和 Windows。真彩色 / 表情符號可與新的 Windows 終端一起使用，Windows 的經典終端僅限 8 種顏色。Rich 還可以與 Jupyter 筆記本一起使用，而無需其他配置。

    2. 安裝說明

使用 pip 或其他 PyPi 軟件包管理器進行安裝。

pip install rich

    3. 打印功能

想毫不費力地將 Rich 的輸出功能添加到您的應用程序中，您只需導入 rich 打印方法，該方法和其他 Python 的自帶功能的參數類似。

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

    4. 使用控制檯

想要對 Rich 終端內容進行更多控制，請您導入並構造一個控制檯對象。

from rich.console import Console
console = Console()

Console 對象含有一個 print 方法，它的界面與 python 內置的 print 功能界面相似。

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

您可能已經料到，這時終端上會顯示 “Hello World”。請注意，與內置的 “打印” 功能不同，Rich 會將文字自動換行以適合終端寬度。

有幾種方法可以爲輸出添加顏色和樣式。您可以通過添加 style 關鍵字參數來爲整個輸出設置樣式。

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

這個範例一次只設置了一行文字的樣式。如果想獲得更細膩更復雜的樣式，Rich 可以渲染一個特殊的標記，其語法類似於 bbcode。

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

    4.1 控制檯記錄

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 方法既可用於將長時間運行應用程序（例如服務器）的日誌記錄到終端，也可用於輔助調試。

    4.2 記錄處理程序

您還可以使用內置的 處理類 來對 Python 日誌記錄模塊的輸出進行格式化和着色。

    5. 表情符號

將名稱放在兩個冒號之間即可在控制檯輸出中插入表情符號。

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

    6. 表格

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",, 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 類很聰明，可以調整列的大小以適合終端的可用寬度，並能根據需要環繞文本。

    7. 進度條

Rich 可以渲染多個不閃爍的進度條形圖，以跟蹤長時間運行的任務。基本用法：用 track 函數調用任何程序並迭代結果。

from rich.progress import track
for step in track(range(100)):
    do_step(step)

添加多個進度條並不難。

這些列可以配置爲顯示您所需的任何詳細信息。內置列包括完成百分比，文件大小，文件速度和剩餘時間。

    8. 列

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

以下屏幕截圖是 列示例 的輸出，該列顯示了從 API 提取的數據：

    9. Markdown

Rich 可以呈現 markdown，並可相當不錯的將其格式轉移到終端。爲了渲染 markdown，請導入 Markdown 類，並使用包含 markdown 代碼的字符串來構造它，然後將其打印到控制檯。

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）

    10. 語法突出顯示

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)

    11. 回溯

Rich 可以渲染漂亮的回溯，比標準 Python 回溯更容易閱讀，並能顯示更多代碼。您可以將 Rich 設置爲默認的回溯處理程序，這樣所有難以捕獲的異常都將由 Rich 爲您呈現。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/krs3t85ndsNPTWMhzwFarQ

猜你喜歡