Python的click命令行庫(kù)怎么使用

這篇文章主要講解了“Python的click命令行庫(kù)怎么使用”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“Python的click命令行庫(kù)怎么使用”吧！

click

是一個(gè)以盡可能少的代碼、以組合的方式創(chuàng)建優(yōu)美的命令行程序的 Python 包。它有很高的可配置性，同時(shí)也能開箱即用。

它旨在讓編寫命令行工具的過(guò)程既快速又有趣，還能防止由于無(wú)法實(shí)現(xiàn)預(yù)期的 CLI API 所產(chǎn)生挫敗感。它有如下三個(gè)特點(diǎn)：

• 任意嵌套命令

• 自動(dòng)生成幫助

• 支持運(yùn)行時(shí)延遲加載子命令

快速開始

業(yè)務(wù)邏輯

首先定義業(yè)務(wù)邏輯，是不是感覺到有些難以置信呢?

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

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

那么在 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)

這段代碼的邏輯很簡(jiǎn)單，就是循環(huán) count 次，使用 click.echo 打印 name。其中，click.echo 和 print  的作用相似，但功能更加強(qiáng)大，能處理好 Unicode 和 二進(jìn)制數(shù)據(jù)的情況。

3.2 定義參數(shù)

很顯然，我們需要針對(duì) count 和 name 來(lái)定義它們所對(duì)應(yīng)的參數(shù)信息。

• count 對(duì)應(yīng)為命令行選項(xiàng) --count，類型為數(shù)字，我們希望在不提供參數(shù)時(shí)，其默認(rèn)值是 1

• name 對(duì)應(yīng)為命令行選項(xiàng) --name，類型為字符串，我們希望在不提供參數(shù)時(shí)，能給人提示

使用 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. 使用裝飾器的方式，即定義了參數(shù)，又將之與處理邏輯綁定，這真是優(yōu)雅。和 argparse、docopt 比起來(lái)，就少了一步綁定過(guò)程

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

3. 使用 click.option 來(lái)定義參數(shù)選項(xiàng)

• 對(duì)于 --count 來(lái)說(shuō)，使用 default 來(lái)指定默認(rèn)值。而由于默認(rèn)值是數(shù)字，進(jìn)而暗示 --count 選項(xiàng)的類型為數(shù)字

• 對(duì)于 --name 來(lái)說(shuō)，使用 prompt 來(lái)指定未輸入該選項(xiàng)時(shí)的提示語(yǔ)

• 使用 help 來(lái)指定幫助信息

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

代碼梳理

使用 click 的方式非常簡(jiǎn)單，我們將上文的代碼匯總下，以有一個(gè)更清晰的認(rèn)識(shí)：

# 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()

若我們指定次數(shù)和名字：

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

若我們什么都不指定，則會(huì)提示輸入名字，并默認(rèn)輸出一次：

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

我們還可以通過(guò) --help 參數(shù)查看自動(dòng)生成的幫助信息：

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命令行庫(kù)怎么使用”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì)Python的click命令行庫(kù)怎么使用這一問題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！