Python的click命令行庫怎么使用

這篇文章主要講解了“Python的click命令行庫怎么使用”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“Python的click命令行庫怎么使用”吧！

click

是一個以盡可能少的代碼、以組合的方式創建優美的命令行程序的 Python 包。它有很高的可配置性，同時也能開箱即用。

它旨在讓編寫命令行工具的過程既快速又有趣，還能防止由于無法實現預期的 CLI API 所產生挫敗感。它有如下三個特點：

• 任意嵌套命令

• 自動生成幫助

• 支持運行時延遲加載子命令

快速開始

業務邏輯

首先定義業務邏輯，是不是感覺到有些難以置信呢?

不論是 argparse 還是 docopt，業務邏輯都是被放在最后一步，但 click 卻是放在第一步。細想想 click  的這種方式才更符合人的思維吧?不論用什么命令行框架，我們最終關心的就是實現業務邏輯，其它的能省則省。

我們以官方示例為例，來介紹 click 的用法和哲學。假設命令行程序的輸入是 name 和 count，功能是打印指定次數的名字。

那么在 hello.py 中，很容易寫出如下代碼：

def hello(count, name):     """Simple program that greets NAME for a total of COUNT times."""     for x in range(count):         click.echo('Hello %s!' % name)

這段代碼的邏輯很簡單，就是循環 count 次，使用 click.echo 打印 name。其中，click.echo 和 print  的作用相似，但功能更加強大，能處理好 Unicode 和 二進制數據的情況。

3.2 定義參數

很顯然，我們需要針對 count 和 name 來定義它們所對應的參數信息。

• count 對應為命令行選項 --count，類型為數字，我們希望在不提供參數時，其默認值是 1

• name 對應為命令行選項 --name，類型為字符串，我們希望在不提供參數時，能給人提示

使用 click，就可以寫成下面這樣：

from click import 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):     ...

在上面的示例中：

1. 使用裝飾器的方式，即定義了參數，又將之與處理邏輯綁定，這真是優雅。和 argparse、docopt 比起來，就少了一步綁定過程

2. 使用 click.command 表示 hello 是對命令的處理

3. 使用 click.option 來定義參數選項

• 對于 --count 來說，使用 default 來指定默認值。而由于默認值是數字，進而暗示 --count 選項的類型為數字

• 對于 --name 來說，使用 prompt 來指定未輸入該選項時的提示語

• 使用 help 來指定幫助信息

不論是裝飾器的方式、還是各種默認行為，click 都是像它的介紹所說的那樣，讓人盡可能少地編寫代碼，讓整個過程變得快速而有趣。

代碼梳理

使用 click 的方式非常簡單，我們將上文的代碼匯總下，以有一個更清晰的認識：

# hello.py import 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 x in range(count):         click.echo('Hello %s!' % name)  if __name__ == '__main__':     hello()

若我們指定次數和名字：

$ python3 hello.py --count 2 --name Eric Hello Eric! Hello Eric!

若我們什么都不指定，則會提示輸入名字，并默認輸出一次：

$ python3 hello.py Your name: Eric Hello Eric!

我們還可以通過 --help 參數查看自動生成的幫助信息：

Usage: hello.py [OPTIONS]    Simple program that greets NAME for a total of COUNT times.  Options:   --count INTEGER  Number of greetings.   --name TEXT      The person to greet.   --help           Show this message and exit.

感謝各位的閱讀，以上就是“Python的click命令行庫怎么使用”的內容了，經過本文的學習后，相信大家對Python的click命令行庫怎么使用這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！