一、前言

在本系列前面幾篇文章中，我們分別介紹了 argparse 和 docopt 的主要功能和用法。它們各具特色，都能出色地完成命令行任務(wù)。argparse 是面向過(guò)程的，需要先設(shè)置解析器，再定義參數(shù)，再解析命令行，最后實(shí)現(xiàn)業(yè)務(wù)邏輯。而 docopt 先用聲明式的語(yǔ)法定義出參數(shù)，再過(guò)程式地解析命令行和實(shí)現(xiàn)業(yè)務(wù)邏輯。在一些人看來(lái)，這些方式都不夠優(yōu)雅。

而今天要介紹的 click[2] 則是用一種你很熟知的方式來(lái)玩轉(zhuǎn)命令行。命令行程序本質(zhì)上是定義參數(shù)和處理參數(shù)，而處理參數(shù)的邏輯一定是與所定義的參數(shù)有關(guān)聯(lián)的。那可不可以用函數(shù)和裝飾器來(lái)實(shí)現(xiàn)處理參數(shù)邏輯與定義參數(shù)的關(guān)聯(lián)呢?而 click 正好就是以這種方式來(lái)使用的。

本系列文章默認(rèn)使用 Python 3 作為解釋器進(jìn)行講解。若你仍在使用 Python 2，請(qǐng)注意兩者之間語(yǔ)法和庫(kù)的使用差異哦~

二、介紹click

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

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

• 任意嵌套命令
• 自動(dòng)生成幫助
• 支持運(yùn)行時(shí)延遲加載子命令

三、快速開(kāi)始

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

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

不論是 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)
   1. 對(duì)于 --count 來(lái)說(shuō)，使用 default 來(lái)指定默認(rèn)值。而由于默認(rèn)值是數(shù)字，進(jìn)而暗示 --count 選項(xiàng)的類型為數(shù)字
   2. 對(duì)于 --name 來(lái)說(shuō)，使用 prompt 來(lái)指定未輸入該選項(xiàng)時(shí)的提示語(yǔ)
   3. 使用 help 來(lái)指定幫助信息

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

3.3 代碼梳理

使用 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. 

四、小結(jié)

click 的思路非常簡(jiǎn)單，定義處理函數(shù)，通過(guò)它的裝飾器來(lái)定義參數(shù)。使用裝飾器的絕妙之處就在于把定義和綁定這兩個(gè)步驟合為一個(gè)步驟，使得整個(gè)過(guò)程變得如絲般順滑。

click 除了以 Pythonic 的方式讓命令行程序的實(shí)現(xiàn)變得更加優(yōu)雅和好用外，還提供了比 argparse 和 docopt 都要強(qiáng)大的功能。在接下來(lái)幾節(jié)中，我們將會(huì)逐步揭開(kāi)它的面紗。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論