so cool!專屬Python開發者的完美終端工具

Rich 是一個 Python 庫,可以為你在終端中提供富文字和漂亮、精美的格式。

使用 Rich API 可以很容易的在終端輸出新增各種顏色和不同風格。它可以繪製漂亮的表格,進度條,markdown,突出顯示語法的原始碼及回溯等等,優秀的功能不勝列舉。

so cool!專屬Python開發者的完美終端工具

#1。Rich 相容性

Rich 適用於 Linux,OSX 和 Windows。可與新的 Windows 終端一起使用,Windows 的經典終端僅限 8 種顏色。

Rich 還可以與一起使用,而無需其他配置。

#2。Rich 安裝說明

請選擇以下任一種方式輸入命令安裝依賴

Windows 環境 開啟 Cmd (開始-執行-CMD)。

MacOS 環境 開啟 Terminal (command+空格輸入Terminal)。

如果你用的是 VSCode編輯器 或 Pycharm,可以直接使用介面下方的Terminal。

#3。Rich 的 Print 功能

想毫不費力地將 Rich 的輸出功能新增到你的Python指令碼程式中,你只需匯入 rich print 方法,該方法和其他 Python 的自帶功能的引數類似。你可以試試:

so cool!專屬Python開發者的完美終端工具

可以看到,基於 rich 的 print 方法輸出的內容都是帶顏色、帶重點的,相比於Python自帶的 print 有明顯的優勢。

#4。自定義 Console 控制檯輸出

想要對 Rich 終端內容進行更多的自定義設定,你需要匯入並構造一個控制檯物件:

Console 物件含有一個 print 方法,它的介面與 python 內建的 print 功能相似。你可以試試:

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

有幾種方法可以為輸出新增自定義顏色和樣式。你可以透過新增 style 關鍵字引數來為整個輸出設定樣式。例子如下:

輸出如下圖:

so cool!專屬Python開發者的完美終端工具

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

so cool!專屬Python開發者的完美終端工具

#5。Console 控制檯記錄

Console 物件具有一個 log() 方法,該方法具有與 print() 類似的介面,除此之外,還能顯示當前時間以及被呼叫的檔案和行。

預設情況下,Rich 將針對 Python 結構和 repr 字串進行語法突出顯示。如果你記錄一個集合(如字典或列表),Rich 會把它漂亮地打印出來,使其切合可用空間。下面是其中一些功能的示例:

以上範例的輸出如下:

so cool!專屬Python開發者的完美終端工具

注意其中的 log_locals 引數會輸出一個表格,該表格包含呼叫 log 方法的區域性變數。

log 方法既可用於將長時間執行應用程式(例如伺服器)的日誌記錄到終端,也可用於輔助除錯。

Logging 處理程式

你還可以使用內建的處理類來對 Python 日誌記錄模組的輸出進行格式化和著色。下面是輸出示例:

so cool!專屬Python開發者的完美終端工具

#6。 表情符號

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

請謹慎地使用此功能。

#7。表格

Rich 包含多種邊框,樣式,單元格對齊等格式設定的選項。下面是一個簡單的示例:

該示例的輸出如下:

so cool!專屬Python開發者的完美終端工具

請注意,控制檯標記的呈現方式與 print() 和 log() 相同。實際上,由 Rich 渲染的任何內容都可以新增到標題/行(甚至其他表格)中。

Table 類很聰明,可以調整列的大小以適合終端的可用寬度,並能根據需要做文字環繞的處理。下面是相同的示例,輸出與比上表小的終端上:

so cool!專屬Python開發者的完美終端工具

#8。進度條

Rich 可以渲染多個不閃爍的進度條形圖,以跟蹤長時間執行的任務。

基本用法:用 track 函式呼叫程式並迭代結果。下面是一個例子:

新增多個進度條並不難。以下是效果示例:

這些列可以配置為顯示你所需的任何詳細資訊。

內建列包括完成百分比,檔案大小,檔案速度和剩餘時間。下面是顯示正在進行的下載的示例:

#9。按列輸出資料

Rich 可以將內容透過排列整齊的,具有相等或最佳的寬度的列來呈現。下面是(macOS / Linux) ls 命令的一個非常基本的克隆,用列來顯示目錄列表:

以下螢幕截圖是列示例的輸出,該列顯示了從 API 提取的資料:

so cool!專屬Python開發者的完美終端工具

#10。Markdown

Rich 可以呈現markdown,相當不錯的將其格式顯示到終端。

為了渲染 markdown,請匯入 Markdown 類,將其列印到控制檯。例子如下:

該例子的輸出如下圖:

so cool!專屬Python開發者的完美終端工具

#11。語法突出顯示

Rich 使用 pygments 庫來實現語法高亮顯示。用法類似於渲染 markdown。構造一個 Syntax 物件並將其列印到控制檯。下面是一個例子:

輸出如下:

so cool!專屬Python開發者的完美終端工具

#12。錯誤回溯(traceback)

Rich 可以渲染漂亮的錯誤回溯日誌,比標準的 Python 回溯更容易閱讀,並能顯示更多程式碼。

你可以將 Rich 設定為預設的回溯處理程式,這樣所有異常都將由 Rich 為你呈現。

下面是在 OSX(與 Linux 類似)上的外觀:

so cool!專屬Python開發者的完美終端工具

我們的文章到此就結束啦,如果你喜歡今天的Python 實戰教程,請持續關注我們。歡迎在留言區吱一聲,記得給個三連哦。

TAG: Rich示例輸出Python終端