Rich-Python開(kāi)發(fā)者的完美終端工具

來(lái)源 : Python編程時(shí)光整理

使用 Rich API 可以很容易的在終端輸出添加各種顏色和不同風(fēng)格。它可以繪制漂亮的表格，進(jìn)度條，markdown，突出顯示語(yǔ)法的源代碼及回溯等等，優(yōu)秀的功能不勝枚舉。

1.Rich 兼容性

Rich 適用于 Linux，OSX 和 Windows。可與新的 Windows 終端一起使用，Windows 的經(jīng)典終端僅限 8 種顏色。

Rich 還可以與 Jupyter NoteBook 一起使用，而無(wú)需其他配置。

2.Rich 安裝說(shuō)明

請(qǐng)選擇以下任一種方式輸入命令安裝依賴(lài)：

1. Windows 環(huán)境 打開(kāi) Cmd (開(kāi)始-運(yùn)行-CMD)。
2. MacOS 環(huán)境 打開(kāi) Terminal (command+空格輸入Terminal)。
3. 如果你用的是 VSCode編輯器 或 Pycharm，可以直接使用界面下方的Terminal.

pip?install?rich

3.Rich 的 Print 功能

想毫不費(fèi)力地將 Rich 的輸出功能添加到你的Python腳本程序中，你只需導(dǎo)入 rich print 方法，該方法和其他 Python 的自帶功能的參數(shù)類(lèi)似。你可以試試：

from?rich?import?print

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

可以看到，基于 rich 的 print 方法輸出的內(nèi)容都是帶顏色、帶重點(diǎn)的，相比于Python自帶的 print 有明顯的優(yōu)勢(shì)。

4.自定義 Console 控制臺(tái)輸出

想要對(duì) Rich 終端內(nèi)容進(jìn)行更多的自定義設(shè)置，你需要導(dǎo)入并構(gòu)造一個(gè)控制臺(tái)對(duì)象：

from?rich.console?import?Console

console?=?Console()

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

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

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

有幾種方法可以為輸出添加自定義顏色和樣式。你可以通過(guò)添加 style 關(guān)鍵字參數(shù)來(lái)為整個(gè)輸出設(shè)置樣式。例子如下：

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

輸出如下圖：

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

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

5.Console 控制臺(tái)記錄

Console 對(duì)象具有一個(gè) log() 方法，該方法具有與 print() 類(lèi)似的界面，除此之外，還能顯示當(dāng)前時(shí)間以及被調(diào)用的文件和行。

默認(rèn)情況下，Rich 將針對(duì) Python 結(jié)構(gòu)和 repr 字符串進(jìn)行語(yǔ)法突出顯示。如果你記錄一個(gè)集合（如字典或列表），Rich 會(huì)把它漂亮地打印出來(lái)，使其切合可用空間。下面是其中一些功能的示例：

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 參數(shù)會(huì)輸出一個(gè)表格，該表格包含調(diào)用 log 方法的局部變量。

log 方法既可用于將長(zhǎng)時(shí)間運(yùn)行應(yīng)用程序（例如服務(wù)器）的日志記錄到終端，也可用于輔助調(diào)試。

Logging 處理程序

你還可以使用內(nèi)置的處理類(lèi)來(lái)對(duì) Python 日志記錄模塊的輸出進(jìn)行格式化和著色。下面是輸出示例：

6. 表情符號(hào)

將名稱(chēng)放在兩個(gè)冒號(hào)之間即可在控制臺(tái)輸出中插入表情符號(hào)。示例如下：

>>>?console.print(":smiley:?:vampire:?:pile_of_poo:?:thumbs_up:?:raccoon:")
??????????????

請(qǐng)謹(jǐn)慎地使用此功能。

7.表格

Rich 包含多種邊框，樣式，單元格對(duì)齊等格式設(shè)置的選項(xiàng)。下面是一個(gè)簡(jiǎn)單的示例：

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)

該示例的輸出如下：

請(qǐng)注意，控制臺(tái)標(biāo)記的呈現(xiàn)方式與 print() 和 log() 相同。實(shí)際上，由 Rich 渲染的任何內(nèi)容都可以添加到標(biāo)題/行（甚至其他表格）中。

Table 類(lèi)很聰明，可以調(diào)整列的大小以適合終端的可用寬度，并能根據(jù)需要做文本環(huán)繞的處理。下面是相同的示例，輸出與比上表小的終端上：

8.進(jìn)度條

Rich 可以渲染多個(gè)不閃爍的進(jìn)度條形圖，以跟蹤長(zhǎng)時(shí)間運(yùn)行的任務(wù)。

基本用法：用 track 函數(shù)調(diào)用程序并迭代結(jié)果。下面是一個(gè)例子：

from?rich.progress?import?track

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

添加多個(gè)進(jìn)度條并不難。以下是效果示例：

這些列可以配置為顯示你所需的任何詳細(xì)信息。

內(nèi)置列包括完成百分比，文件大小，文件速度和剩余時(shí)間。下面是顯示正在進(jìn)行的下載的示例：

它可以在顯示進(jìn)度的同時(shí)下載多個(gè) URL。要自己嘗試一下，請(qǐng)參閱示例文件中的 examples/downloader.py ，在Python實(shí)用寶典公眾號(hào)后臺(tái)回復(fù) rich示例 下載全部示例。

9.按列輸出數(shù)據(jù)

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

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

10.Markdown

Rich 可以呈現(xiàn)markdown，相當(dāng)不錯(cuò)的將其格式顯示到終端。

為了渲染 markdown，請(qǐng)導(dǎo)入 Markdown 類(lèi)，將其打印到控制臺(tái)。例子如下：

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)

該例子的輸出如下圖：

11.語(yǔ)法突出顯示

Rich 使用 pygments 庫(kù)來(lái)實(shí)現(xiàn)語(yǔ)法高亮顯示。用法類(lèi)似于渲染 markdown。構(gòu)造一個(gè) Syntax 對(duì)象并將其打印到控制臺(tái)。下面是一個(gè)例子：

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)

輸出如下：

12.錯(cuò)誤回溯(traceback)

Rich 可以渲染漂亮的錯(cuò)誤回溯日志，比標(biāo)準(zhǔn)的 Python 回溯更容易閱讀，并能顯示更多代碼。

你可以將 Rich 設(shè)置為默認(rèn)的回溯處理程序，這樣所有異常都將由 Rich 為你呈現(xiàn)。

下面是在 OSX（與 Linux 類(lèi)似）上的外觀(guān)：

加入知識(shí)星球【我們談?wù)摂?shù)據(jù)科學(xué)】

400+小伙伴一起學(xué)習(xí)！

·?推薦閱讀?·

利用Conda嘗鮮Python 3.10

新一代數(shù)據(jù)科學(xué)ide平臺(tái)DataSpell提前發(fā)行版體驗(yàn)

教你使用Python連接Wind金融數(shù)據(jù)接口