typer下載 - typer原始碼下載

typer

Python

0.15.1

下載

Typer，建造出色的 CLI。易於編碼。基於 Python 類型提示。

文件：https://typer.tiangolo.com

原始碼：https://github.com/fastapi/typer

Typer 是一個用於建立 CLI 應用程式的程式庫，使用者會喜歡使用它，開發人員也會喜歡創建它。基於 Python 類型提示。

它也是一個運行腳本的命令列工具，可自動將它們轉換為 CLI 應用程式。

主要特點是：

書寫直觀：強大的編輯器支援。到處都完成。調試時間更少。旨在易於使用和學習。閱讀文檔的時間更少。
易於使用：最終用戶易於使用。所有 shell 的自動幫助和自動完成。
簡而言之：最大限度地減少程式碼重複。每個參數聲明具有多個功能。更少的錯誤。
從簡單開始：最簡單的範例僅向您的應用程式新增 2 行程式碼： 1 行匯入、1 行函數呼叫。
變大：根據需要增加複雜性，使用選項和參數建立任意複雜的命令樹和子命令群組。
運行腳本：Typer 包含一個typer命令/程序，您可以使用它來運行腳本，自動將它們轉換為 CLI，即使它們內部不使用 Typer。

CLI 的 FastAPI

Typer是 FastAPI 的小兄弟，它是 CLI 中的 FastAPI。

安裝

建立並啟動虛擬環境，然後安裝Typer ：

$ pip install typer
---> 100%
Successfully installed typer rich shellingham

例子

絕對最小值

使用以下內容建立檔案main.py ：

 def main ( name : str ):
    print ( f"Hello { name } " )

該腳本內部甚至沒有使用 Typer。但您可以使用typer命令將其作為 CLI 應用程式運行。

運行它

使用typer命令運行您的應用程式：

 // Run your application
$ typer main.py run

// You get a nice error, you are missing NAME
Usage: typer [PATH_OR_MODULE] run [OPTIONS] NAME
Try 'typer [PATH_OR_MODULE] run --help' for help.
╭─ Error ───────────────────────────────────────────╮
│ Missing argument 'NAME'.                          │
╰───────────────────────────────────────────────────╯


// You get a --help for free
$ typer main.py run --help

Usage: typer [PATH_OR_MODULE] run [OPTIONS] NAME

Run the provided Typer app.

╭─ Arguments ───────────────────────────────────────╮
│ *    name      TEXT  [default: None] [required]   |
╰───────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────╮
│ --help          Show this message and exit.       │
╰───────────────────────────────────────────────────╯

// Now pass the NAME argument
$ typer main.py run Camila

Hello Camila

// It works! ?

這是最簡單的用例，甚至沒有在內部使用 Typer，但它對於簡單的腳本已經非常有用。

注意：當您建立 Python 套件並使用--install-completion運行它或使用typer命令時，自動完成功能會起作用。

在程式碼中使用 Typer

現在讓我們開始在您自己的程式碼中使用 Typer，將main.py更新為：

 import typer


def main ( name : str ):
    print ( f"Hello { name } " )


if __name__ == "__main__" :
    typer . run ( main )

現在你可以直接用Python運行它：

 // Run your application
$ python main.py

// You get a nice error, you are missing NAME
Usage: main.py [OPTIONS] NAME
Try 'main.py --help' for help.
╭─ Error ───────────────────────────────────────────╮
│ Missing argument 'NAME'.                          │
╰───────────────────────────────────────────────────╯


// You get a --help for free
$ python main.py --help

Usage: main.py [OPTIONS] NAME

╭─ Arguments ───────────────────────────────────────╮
│ *    name      TEXT  [default: None] [required]   |
╰───────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────╮
│ --help          Show this message and exit.       │
╰───────────────────────────────────────────────────╯

// Now pass the NAME argument
$ python main.py Camila

Hello Camila

// It works! ?

注意：您也可以使用typer指令呼叫相同的腳本，但您不需要這樣做。

升級範例

這是最簡單的例子。

現在讓我們來看看更複雜一點的。

包含兩個子命令的範例

修改文件main.py 。

建立一個typer.Typer()應用程序，並建立兩個子命令及其參數。

 import typer

app = typer . Typer ()


@ app . command ()
def hello ( name : str ):
    print ( f"Hello { name } " )


@ app . command ()
def goodbye ( name : str , formal : bool = False ):
    if formal :
        print ( f"Goodbye Ms. { name } . Have a good day." )
    else :
        print ( f"Bye { name } !" )


if __name__ == "__main__" :
    app ()

這將：

明確建立一個typer.Typer應用程式。
- 前面的typer.run實際上為您隱式創建了一個。
使用@app.command()新增兩個子命令。
執行app()本身，就像它是一個函數一樣（而不是typer.run ）。

運行升級後的範例

檢查新的幫助：

$ python main.py --help

 Usage: main.py [OPTIONS] COMMAND [ARGS]...

╭─ Options ─────────────────────────────────────────╮
│ --install-completion          Install completion  │
│                               for the current     │
│                               shell.              │
│ --show-completion             Show completion for │
│                               the current shell,  │
│                               to copy it or       │
│                               customize the       │
│                               installation.       │
│ --help                        Show this message   │
│                               and exit.           │
╰───────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────╮
│ goodbye                                           │
│ hello                                             │
╰───────────────────────────────────────────────────╯

// When you create a package you get  auto-completion  for free, installed with --install-completion

// You have 2 subcommands (the 2 functions): goodbye and hello

現在檢查hello指令的幫助：

$ python main.py hello --help

 Usage: main.py hello [OPTIONS] NAME

╭─ Arguments ───────────────────────────────────────╮
│ *    name      TEXT  [default: None] [required]   │
╰───────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────╮
│ --help          Show this message and exit.       │
╰───────────────────────────────────────────────────╯

現在檢查goodbye命令的幫助：

$ python main.py goodbye --help

 Usage: main.py goodbye [OPTIONS] NAME

╭─ Arguments ───────────────────────────────────────╮
│ *    name      TEXT  [default: None] [required]   │
╰───────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────╮
│ --formal    --no-formal      [default: no-formal] │
│ --help                       Show this message    │
│                              and exit.            │
╰───────────────────────────────────────────────────╯

// Automatic --formal and --no-formal for the bool option ?

現在您可以嘗試新的命令列應用程式：

 // Use it with the hello command

$ python main.py hello Camila

Hello Camila

// And with the goodbye command

$ python main.py goodbye Camila

Bye Camila!

// And with --formal

$ python main.py goodbye --formal Camila

Goodbye Ms. Camila. Have a good day.

回顧

總之，您將參數類型（ CLI 參數和CLI 選項）宣告為函數參數。

您可以使用標準的現代 Python 類型來做到這一點。

您不必學習新的語法、特定庫的方法或類別等。

只是標準的Python 。

例如，對於int ：

 total : int

或對於bool標誌：

 force : bool

對於檔案、路徑、枚舉（選擇）等也類似。

您將獲得：出色的編輯器支持，包括無處不在的完成和類型檢查。

當您的使用者安裝您的軟體包或使用typer指令時，您的使用者將獲得：自動--help 、在終端機（Bash、Zsh、Fish、PowerShell）中自動完成的功能。

有關包含更多功能的更完整範例，請參閱教學 - 使用者指南。

依賴關係

Typer站在巨人的肩膀上。它唯一需要的內部相依性是 Click。

預設情況下，它還附帶額外的標準依賴項：

rich ：自動顯示格式良好的錯誤。
shellingham ：安裝完成時自動偵測目前shell。
- 使用shellingham你可以只使用--install-completion 。
- 如果沒有shellingham ，您必須傳遞 shell 的名稱來安裝完成，例如--install-completion bash 。