Python Rich:美化終端顯示效果

来源:https://www.cnblogs.com/wang_yb/p/18013971
-Advertisement-
Play Games

Rich庫的功能就像它的名字一樣,使Python編程更加豐富(rich),它幫助開發者在控制台(命令行)輸出中創建豐富、多彩和具有格式化的文本。 本篇總結瞭如何使用Rich庫讓我們的命令行工具更加美觀。 1. 安裝 通過pip安裝: pip install rich 使用下麵的命令驗證是否安裝成功。 ...


Rich庫的功能就像它的名字一樣,使Python編程更加豐富(rich),
它幫助開發者在控制台(命令行)輸出中創建豐富、多彩和具有格式化的文本。

本篇總結瞭如何使用Rich庫讓我們的命令行工具更加美觀。

1. 安裝

通過pip安裝:

pip install rich

使用下麵的命令驗證是否安裝成功。

python -m rich

2. 應用示例

Rich的功能很多,下麵通過代碼示例來演示其中主要的功能。

2.1. 美化 REPL 輸出

安裝python之後,在命令行輸入python,就可以進入python的互動式命令行環境(REPL)。
因為python是解釋性語言,所以可以在REPL環境中互動式的運行代碼:
image.png
註:REPL全稱: Read-Eval-Print-Loop (互動式解釋器)

預設的REPL是沒有顏色的,使用Rich可以美化REPL的顯示,獲得更好的交互效果。
只需要導入Rich庫的pretty即可。

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

再次運行上面的代碼:
image.png
不同的數據類型會用不同的顏色來表示。

2.2. 查看對象信息

Rich庫中還提供了一個還有用的功能,用來查看python中各個變數或對象的詳細信息。
使用前導入 inspect 函數。

>>> from rich import inspect

對於變數,查看其概括信息的方式如下:

>>> inspect(lst_var)

image.png

查看其包含的方法:

>>> inspect(lst_var, methods=True)

image.png

對於對象,也是一樣:

# -*- coding: utf-8 -*-
from rich import inspect

class Sample:
    def __init__(self, name, age):
        self._name = name
        self._age = age

    def info(self):
        print("姓名: {}, 年齡: {}".format(self.name, self.age))

    def set(self, name, age):
        self.name = name
        self.age = age

    def get(self):
        return {"name": self.name, "age": self.age}

    # 私有函數
    def _private(self):
        print("這是私有函數")

if __name__ == "__main__":
    sa = Sample("harry", 33)

    # 顯示對象概要信息
    inspect(sa)

    # 顯示對象方法信息
    inspect(sa, methods=True)

    # 顯示對象方法和私有變數,私有函數
    inspect(sa, methods=True, private=True)

image.png
Rich庫的inspect函數讓我們在命令行中也可以獲得非常好的閱讀體驗。

2.3. 動態顯示內容

動態顯示在命令行中一直是個難點,而Rich庫能幫助我們很容易的實現狀態和進度的動態顯示。

比如,如果有多個任務在執行,可以用Rich來動態顯示執行的情況。

# -*- coding: utf-8 -*-

from time import sleep
from rich.console import Console

console = Console()
count = 5
tasks = [f"task {n}" for n in range(1, count + 1)]


with console.status("") as status:
    num = 1
    while tasks:
        status.update("[{}/{}] 已經完成".format(num, count))
        task = tasks.pop(0)
        sleep(1)
        num += 1

print("所有任務 全部完成!")

rich-status.gif
這樣就不用列印出很多行的日誌信息,而是動態的顯示task完成的情況。

還有一個動態的應用是進度條,進度條雖然不能提高程式的性能,
但是它讓我們瞭解到程式大概運行到哪了,能夠減少等待的焦慮。

比如,傳輸大量文件或者下載大文件的過程中,沒有進度條的話,常常會擔心程式是不是卡住了。
下麵是一個模擬文件傳輸中使用進度條的示例:

# -*- coding: utf-8 -*-

import time

from rich.progress import Progress

# 模擬2個文件,一個是文件名,一個是文件大小
files = [("windows.iso", 24000), ("debian.iso", 17000)]

with Progress() as progress:
    tasks = []
    for f in files:
        task_id = progress.add_task("copy {}".format(f[0]), filename=f[0], start=False)
        progress.update(task_id, total=f[1])

        progress.start_task(task_id)
        # 模擬讀取文件,每次讀取1024位元組
        total = f[1]
        buffer = 1024
        while total > 0:
            read_bytes = 0
            if total > buffer:
                read_bytes = buffer
                total -= buffer
            else:
                read_bytes = total
                total = 0

            progress.update(task_id, advance=read_bytes)
            time.sleep(0.2)

        progress.console.log("{} 傳輸完成!".format(f[0]))
        progress.stop_task(task_id)

rich-progress.gif

2.4. 複雜結構顯示

Rich庫還可以幫助我們在控制台顯示一些結構化的內容。

2.4.1. 表格

表格是最常用的一種表現形式,也是最常用的一種展示數據的方式。

# -*- coding: utf-8 -*-

from rich.console import Console
from rich.table import Table

table = Table(title="國內生產總值指數")

table.add_column("年份", justify="left", style="cyan", no_wrap=True)
table.add_column("指標", style="magenta")
table.add_column("數值", justify="right", style="green")

table.add_row("2022年", "國民總收入指數", "4432.1")
table.add_row("2021年", "國民總收入指數", "4319.7")
table.add_row("2020年", "國民總收入指數", "3979.1")
table.add_row("2019年", "國民總收入指數", "3912.1")

console = Console()
console.print(table)

image.png

2.4.2. 樹形

樹形結構也是常用的結構,比如展示文件夾結構:

# -*- coding: utf-8 -*-

from rich.tree import Tree
from rich import print

# 根節點
tree = Tree("/")

# usr 分支
usr = tree.add("usr")
fonts = usr.add("fonts")
bin = usr.add("bin")
lib = usr.add("lib")

# home 分支
home = tree.add("home")
git = home.add("git")
python = home.add("python")
golang = home.add("golang")

# projects 分支
projects = home.add("projects")
samples = projects.add("samples")
work = projects.add("work")

print(tree)

image.png

2.5. 文檔和代碼顯示

IT行業內,markdown文檔代碼幾乎是繞不開的2個東西。

然而,直接在命令行中原樣顯示的markdown代碼的話,是很難閱讀的。
利用Rich庫,可以幫助我們解析markdown的標記,高亮不同編程語言的代碼,從而在命令行中獲得良好的閱讀體驗。

# -*- coding: utf-8 -*-

from rich.console import Console
from rich.markdown import Markdown


md_sample = """這是一份[Markdown][1]的語法介紹。

# 段落

一個段落是由一個或多個連續的行構成,段落間靠一個或以上視覺上的空行劃分。

    這是一個段落。它有兩個句子。

    這是另一個段落。它也有
    兩個句子。


## 代碼

`print("hello")`

### 列表

* 無序(沒有編號的)列表中的一項
    * 一個子項,要以一個製表符或者4個空格縮進
* 無序列表中的另一個項
1. 有序(排好序,有編號的)列表中的一項
1. 有序列表中的另一個項


[1]: http://daringfireball.net/projects/markdown/
"""

console = Console()
markdown = Markdown(md_sample)
console.print(markdown)

image.png
可以看出,不同的markdown標記會解析成不同的顯示效果。

同樣,對於不同的代碼,也可以高亮顯示:

# -*- coding: utf-8 -*-

from rich.console import Console
from rich.syntax import Syntax

py_code = """
def hello(name):
    print("hello ", name)

hello("world")
"""

java_code = """
public class HelloWorld
{
    public static void main(String[] args)
    {
        System.out.println("Hello,World!");
    }
}
"""

c_code = """
#include <stdio.h>
int main()
{
    printf("Hello,World!");
    return 1;
}
"""

console = Console()

console.print("========================")
console.print("[green]python 代碼")
console.print("========================")
syntax = Syntax(py_code, "python", theme="monokai", line_numbers=True)
console.print(syntax)

console.print("========================")
console.print("[blue]java 代碼")
console.print("========================")
syntax = Syntax(java_code, "java", theme="monokai", line_numbers=True)
console.print(syntax)

console.print("========================")
console.print("[red]c 代碼")
console.print("========================")
syntax = Syntax(c_code, "c", theme="monokai", line_numbers=True)
console.print(syntax)

image.png
這裡只演示了3種代碼,但是Rich可以支持幾乎所有主流的代碼。

3. 總結

總的來說,Python Rich庫是一個強大的工具,可以讓Python開發者在命令行環境中擁有更加豐富和強大的輸出能力,使得數據呈現更加直觀,增強了代碼的可讀性和調試效率。

本篇演示了一些常用的功能,關於Rich庫的其他功能和每個功能的細節可以參考其官方文檔:
https://rich.readthedocs.io/en/latest/


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 註意本文是SQL執行順序,不是MySQL Server內部執行流程。 MySQL並非像PostgreSQL(被認為是最接近 SQL 標準的資料庫之一)一樣嚴格按照SQL標準,MySQL執行引擎會根據查詢的具體情況和優化策略來決定具體的執行順序,所以SQL執行順序是理論順序。 書寫順序 select. ...
  • 開心一刻 今天我突然頓悟了,然後跟我媽聊天 我:媽,我發現一個餓不死的辦法 媽:什麼辦法 我:我先養個狗,再養個雞 媽:然後了 我:我拉的狗吃,狗拉的雞吃,雞下的蛋我吃,如此反覆,我們三都餓不死 媽:你整那麼多中間商幹啥,你就自己拉的自己吃得了,還省事 我又頓悟了,回到:也是啊 說句很重要的心裡話: ...
  • 寫在前面 和大家不太一樣,我覺得今年的自己更加relax,沒有親戚要走,沒有朋友相聚,也沒有很好的哥們要去敘舊,更沒有無知的相親,甚至可以這麼說沒有那些閑得慌的鄰居。 也可以說是從今天開始,算是可以進入自己的小世界,做自己想做的事,看看書,學習一下。 生活的精髓在於善待自己,用心感受每一刻的歡愉與寧 ...
  • 前言 上回說到,利用vite載入不同mode下的配置文件,可以實現不同運行環境下的參數配置。在前端應用中經常使用到Websocket,其地址同樣可以在.env中間中配置。 代碼 vite.config.ts代碼的執行是在createApp之前,不可以在vite.config.ts中使用例如pinia ...
  • 步驟 根目錄新建.env.development和.env.production文件 package.json配置啟動參數 vite命令啟動項目時,指定mode參數,載入vite.config.ts文件。 "dev": "vite --host 0.0.0.0 --port 8093 --mode ...
  • 找半天沒找到相關的內容,自己搗鼓出來的,記錄一下。(比較可惜的是只能獲取靜態圖片,動態壁紙就不知道了咋弄了) uniapp的話還可以參考一下如何用NJS獲取手機桌面壁紙? - DCloud問答下麵DCloud_heavensoft 大佬的一個回答 : “Native.js很多類型沒有。用uts可以  ...
  • 前言 以前使用的都是預設的博客園主題,最近剛好有空,著手定製以下自己的博客園主題。最終效果參考當前的博客,如果看不到則需要在博客園首頁頭像處懸停關閉簡潔模式 思路是儘量保持原有結構,不進行破壞性改動,以 css 樣式為主 本主題是輕量化的,只是在原有基礎上微調樣式。如有需要更豐富功能的可以自己搜索博 ...
  • 迴首 在 零基礎入門Vue之夢開始的地方——插值語法 我記錄了v-bind、v-on、v-model的學習 在 零基礎入門Vue之To be or not to be——條件渲染 我記錄了v-if、v-else-if、v-else、v-show的學習 在 零基礎入門Vue之影分身之術——列表渲染&渲 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...