Rich 是一個(gè)非常強(qiáng)大的 Python 庫，不僅在終端中提供豐富的文本和漂亮的格式，還可以顯示表情符號、表格、進(jìn)度條、標(biāo)記，甚至語法突出顯示的代碼。

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

使用Rich來美化終端格式

1、兼容性

Rich 適用于 Linux，OSX 和 Windows。真彩色/表情符號可與新的 Windows 終端一起使用，Windows 的經(jīng)典終端僅限 8 種顏色。Rich 還可以與Jupyter Notebook一起使用，而無需其他配置。

使用Rich來美化終端格式 - 功能縱覽

2、安裝說明

使用 pip 或其他 PyPi 軟件包管理器進(jìn)行安裝。

bash 

pip install rich 

3、打印功能

想毫不費(fèi)力地將 Rich 的輸出功能添加到您的應(yīng)用程序中，您只需導(dǎo)入rich 打印方法，該方法和其他 Python 的自帶功能的參數(shù)類似。

python 

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

使用Rich來美化終端格式 - 打印功能

4、使用控制臺

想要對 Rich 終端內(nèi)容進(jìn)行更多控制，請您導(dǎo)入并構(gòu)造一個(gè)控制臺對象。

python 

from rich.console import Console  
console = Console() 

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

python

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

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

有幾種方法可以為輸出添加顏色和樣式。您可以通過添加 style 關(guān)鍵字參數(shù)來為整個(gè)輸出設(shè)置樣式。

python 

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

使用Rich來美化終端格式 - 使用控制臺

這個(gè)范例一次只設(shè)置了一行文字的樣式。如果想獲得更細(xì)膩更復(fù)雜的樣式，Rich 可以渲染一個(gè)特殊的標(biāo)記，其語法類似于 bbcode。

python 

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

使用Rich來美化終端格式 - 使用控制臺

4.1 控制臺記錄

Console 對象具有一個(gè) log() 方法，該方法具有與 print() 類似的界面，除此之外，還能成列顯示當(dāng)前時(shí)間以及被調(diào)用的文件和行。默認(rèn)情況下，Rich 將針對 Python 結(jié)構(gòu)和 repr 字符串進(jìn)行語法突出顯示。如果您記錄一個(gè)集合（如字典或列表），Rich 會把它漂亮地打印出來，使其切合可用空間。

python 

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

使用Rich來美化終端格式 - 日志

注意其中的 log_locals 參數(shù)會輸出一個(gè)表格，該表格包含調(diào)用 log 方法的局部變量。log 方法既可用于將長時(shí)間運(yùn)行應(yīng)用程序（例如服務(wù)器）的日志記錄到終端，也可用于輔助調(diào)試。

4.2 記錄處理程序

您還可以使用內(nèi)置的 處理類 來對 Python 日志記錄模塊的輸出進(jìn)行格式化和著色。

使用Rich來美化終端格式 - 記錄

5、表情符號

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

python 

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

6、表格

Rich 可以使用 Unicode 框字符來呈現(xiàn)多變的 表格。Rich 包含多種邊框，樣式，單元格對齊等格式設(shè)置的選項(xiàng)。

python 

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) 

使用Rich來美化終端格式 - 表格

請注意，控制臺標(biāo)記的呈現(xiàn)方式與 print() 和 log() 相同。實(shí)際上，由 Rich 渲染的任何內(nèi)容都可以添加到標(biāo)題/行（甚至其他表格）中。Table 類很聰明，可以調(diào)整列的大小以適合終端的可用寬度，并能根據(jù)需要環(huán)繞文本。

使用Rich來美化終端格式 - 表格

7、進(jìn)度條

Rich 可以渲染多個(gè)不閃爍的進(jìn)度條形圖，以跟蹤長時(shí)間運(yùn)行的任務(wù)。基本用法：用 track 函數(shù)調(diào)用任何程序并迭代結(jié)果。

python 

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

添加多個(gè)進(jìn)度條并不難。

使用Rich來美化終端格式 - 進(jìn)度

這些列可以配置為顯示您所需的任何詳細(xì)信息。內(nèi)置列包括完成百分比，文件大小，文件速度和剩余時(shí)間。

使用Rich來美化終端格式 - 進(jìn)度

要自己嘗試一下，請參閱examples/downloader.py，它可以在顯示進(jìn)度的同時(shí)下載多個(gè) URL。

8、列

Rich 可以將內(nèi)容通過排列整齊的，具有相等或最佳的寬度的列來呈現(xiàn)。下面是（macOS / Linux）ls命令的一個(gè)非常基本的克隆，用于用列來顯示目錄列表：

python 

import os  
import sys  
from rich import print  
from rich.columns import Columns  
directory = os.listdir(sys.argv[1])  
print(Columns(directory)) 

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

使用Rich來美化終端格式 - 列

9、Markdown

Rich 可以呈現(xiàn) markdown，并可相當(dāng)不錯(cuò)的將其格式轉(zhuǎn)移到終端。為了渲染 markdown，請導(dǎo)入 Markdown 類，并使用包含 markdown 代碼的字符串來構(gòu)造它，然后將其打印到控制臺。

python 

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) 

使用Rich來美化終端格式 - markdown

10、語法突出顯示

Rich 使用pygments庫來實(shí)現(xiàn)語法高亮顯示。用法類似于渲染 markdown。構(gòu)造一個(gè) Syntax 對象并將其打印到控制臺。

python 

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

使用Rich來美化終端格式 - 語法

11、回溯

Rich 可以渲染漂亮的回溯，比標(biāo)準(zhǔn) Python 回溯更容易閱讀，并能顯示更多代碼。您可以將 Rich 設(shè)置為默認(rèn)的回溯處理程序，這樣所有難以捕獲的異常都將由 Rich 為您呈現(xiàn)。

使用Rich來美化終端格式 - 回溯

12、使用的項(xiàng)目

這里是一些使用 Rich 的項(xiàng)目:

•  BrancoLab/BrainRender
  
  •   一個(gè)用于三維神經(jīng)解剖數(shù)據(jù)可視化的 python 包
•  Ciphey/Ciphey
  
  •   自動解密工具
•  emeryberger/scalene
  
  •   一個(gè)高性能、高精度的 Python CPU 和內(nèi)存剖析器
•  hedythedev/StarCli
  
  •   通過命令行瀏覽 GitHub 熱門項(xiàng)目
•  intel/cve-bin-tool
  
  •   這個(gè)工具可以掃描一些常見的、有漏洞的組件（openssl、libpng、libxml2、expat 和其他一些組件），讓你知道你的系統(tǒng)是否包含有已知漏洞的常用庫。
•  nf-core/tools
  
  •   包含 nf-core 社區(qū)幫助工具的 Python 包
•  cansarigol/pdbr
  
  •   pdb + rich 的庫，增強(qiáng)調(diào)試功能
•  plant99/felicette
  
  •   傻瓜式衛(wèi)星圖像
•  seleniumbase/SeleniumBase
  
  •   使用 Selenium 和 pytest 使自動化和測試速度提高 10 倍，包括電池
•  smacke/ffsubsync
  
  •   自動將字幕與視頻同步
•  tryolabs/norfair
  
  •   輕量級 Python 庫，用于向任何檢測器添加實(shí)時(shí) 2D 對象跟蹤