rich click

點選即可豐富呈現的命令列介面。

---

文件·原始碼·變更日誌

---

rich-click是一個圍繞 Click 的墊片，它可以使用 Rich 很好地呈現幫助輸出。

• Click 是一個「用來建立漂亮的命令列介面的 Python 套件」 。
• Rich 是一個「在終端機中實作富文本和漂亮格式的 Python 函式庫」 。

rich-click的目的是透過 Click 提供有吸引力的幫助輸出，並使用 Rich 進行格式化，並且需要最少的自訂。

特徵

• ？點擊幫助和錯誤訊息的豐富命令列格式
• ？與 Click 相同的 API：用法只需import rich_click as click
• ？預設樣式不錯
• 在其他人的工具上運行的 CLI 工具（在命令前面加上rich-click ）
• ？將幫助文字匯出為 HTML 或 SVG
• ？將命令和選項分組到命名面板中
• 格式正確的錯誤訊息
• ？輕鬆為選項和命令提供自訂排序順序
• ？可以對樣式和行為進行廣泛的定制

安裝

pip install rich-click

閱讀文件以了解所有支援的安裝方法。

範例

簡單的例子

若要在程式碼中使用 rich-click，請將現有 click CLI 中的import click替換為import rich_click as click ：

 import rich_click as click

@ click . command ()
@ click . option ( "--count" , default = 1 , help = "Number of greetings." )
@ click . option ( "--name" , prompt = "Your name" , help = "The person to greet." )
def hello ( count , name ):
    """Simple program that greets NAME for a total of COUNT times."""
    for _ in range ( count ):
        click . echo ( f"Hello, { name } !" )

if __name__ == '__main__' :
    hello ()

截圖來自examples/11_hello.py

更複雜的例子

截圖來自examples/03_groups_sorting.py

用法

這是如何使用rich-click的快速概述。閱讀文件以獲取更多資訊。

有幾種方法可以開始使用rich-click ：

將rich_click匯入為click

使用相同的命名空間，使用rich_click切換正常的click導入：

 import rich_click as click

就是這樣！然後繼續像平常一樣使用 Click。

有關範例，請參閱examples/01_simple.py 。

聲明式

如果您願意，可以在點擊用法中使用帶有cls參數的RichGroup或RichCommand 。這意味著您可以繼續並行使用未修改的click包。

 import click
from rich_click import RichCommand

@ click . command ( cls = RichCommand )
def main ():
    """My amazing tool does all the things."""

有關範例，請參閱examples/02_declarative.py 。

rich-click CLI 工具

rich-click附帶一個 CLI 工具，可讓您格式化任何使用 Click 的套件中的 Click 幫助輸出。

要使用，請在普通命令前面加上rich-click前綴。例如，要從名為awesometool的套件中獲取豐富的 Click 幫助文本，您可以運行：

$ rich-click awesometool --help

Usage: awesometool [OPTIONS]
..more richified output below.. 

執照

該專案已獲得 MIT 許可。