上熱搜了！這款工具可以讓代碼終端變「高逼格」

工作中你是否使用終端比基于 GUI 更多？最近一款名為 Rich 的 Python 庫(kù)上了熱搜！截止目前，它已經(jīng)擁有 1.55 萬(wàn)顆星了。

Rich 是一個(gè)非常強(qiáng)大的 Python 庫(kù)，不僅在終端中提供豐富的文本和漂亮的格式，還可以顯示表情符號(hào)、表格、進(jìn)度條、標(biāo)記，甚至可以讓語(yǔ)法突出顯示。下面我就來(lái)詳細(xì)介紹一下這款神器吧！

簡(jiǎn)介及安裝

上圖顯示了庫(kù)可以的主要功能。

該庫(kù)適用于 Linux、OSX 和 Windows，只需要 Python 3.6.1 或更高就能正常工作，同時(shí)安裝庫(kù)非常簡(jiǎn)單。

pip?install?rich

豐富的打印功能

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

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

豐富的 Repl

Rich 可以安裝在 Python REPL 中，以便任何數(shù)據(jù)結(jié)構(gòu)都將打印和突出顯示。

>>>?from?rich?import?pretty
>>>?pretty.install()

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

使用控制臺(tái)

想要對(duì) Rich 終端內(nèi)容進(jìn)行更多控制，我們導(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].")

控制臺(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)試。

回溯

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

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

表格

Rich 可以使用 Unicode 框字符來(lái)呈現(xiàn)多變的表格。Rich 包含多種邊框，樣式，單元格對(duì)齊等格式設(shè)置的選項(xiàng)。下面是一個(gè)簡(jiǎn)單的示例：

from?rich.console?import?Console
from?rich.table?import?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)

如上所述，該表將適合終端窗口的當(dāng)前寬度，以確保表完美顯示。

豐富的進(jìn)度條

Rich 庫(kù)還提供令人驚嘆的進(jìn)度條功能。使用也非常簡(jiǎn)單。

from?rich.progress?import?track
from?time?import?sleep
for?step?in?track(range(100),?description="Writing?Medium?Story..."):
????sleep(0.1)

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

這些列可以配置為顯示你所需的任何詳細(xì)信息。內(nèi)置列包括完成百分比，文件大小，文件速度和剩余時(shí)間。下面是顯示正在進(jìn)行的下載的示例：

Markdown

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

為了渲染 markdown，請(qǐng)導(dǎo)入Markdown 類(lèi)，并使用包含 markdown 代碼的字符串來(lái)構(gòu)造它，然后將其打印到控制臺(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)

該例子的輸出如下圖：

列

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

import?os

from?rich?import?print
from?rich.columns?import?Columns

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

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

長(zhǎng)按掃碼，發(fā)消息?[三件套]