一、前言

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

[[281519]]

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

本系列文章默認使用 Python 3 作為解釋器進行講解。若你仍在使用 Python 2，請注意兩者之間語法和庫的使用差異哦~

二、介紹click

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

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

• 任意嵌套命令
• 自動生成幫助
• 支持運行時延遲加載子命令

三、快速開始

3.1 業(yè)務邏輯

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

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

我們以官方示例為例，來介紹 click 的用法和哲學。假設命令行程序的輸入是 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) 

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

3.2 定義參數(shù)

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

• count 對應為命令行選項 --count，類型為數(shù)字，我們希望在不提供參數(shù)時，其默認值是 1
• name 對應為命令行選項 --name，類型為字符串，我們希望在不提供參數(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 比起來，就少了一步綁定過程
2. 使用 click.command 表示 hello 是對命令的處理
3. 使用 click.option 來定義參數(shù)選項

• 對于 --count 來說，使用 default 來指定默認值。而由于默認值是數(shù)字，進而暗示 --count 選項的類型為數(shù)字
• 對于 --name 來說，使用 prompt 來指定未輸入該選項時的提示語
• 使用 help 來指定幫助信息

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

3.3 代碼梳理

使用 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() 

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

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

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

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

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

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 的思路非常簡單，定義處理函數(shù)，通過它的裝飾器來定義參數(shù)。使用裝飾器的絕妙之處就在于把定義和綁定這兩個步驟合為一個步驟，使得整個過程變得如絲般順滑。

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