python argparse_Python 指令行之旅：初探 click

本文首發于 HelloGitHub 公衆号，并發表于 Prodesire 部落格。

一、前言

在本系列前面幾篇文章中，我們分别介紹了

argparse

和

docopt

的主要功能和用法。它們各具特色，都能出色地完成指令行任務。

argparse

是面向過程的，需要先設定解析器，再定義參數，再解析指令行，最後實作業務邏輯。而

docopt

先用聲明式的文法定義出參數，再過程式地解析指令行和實作業務邏輯。在一些人看來，這些方式都不夠優雅。

而今天要介紹的 click 則是用一種你很熟知的方式來玩轉指令行。指令行程式本質上是定義參數和處理參數，而處理參數的邏輯一定是與所定義的參數有關聯的。那可不可以用函數和裝飾器來實作處理參數邏輯與定義參數的關聯呢？而

click

正好就是以這種方式來使用的。

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

二、介紹

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

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

• 任意嵌套指令
• 自動生成幫助
• 支援運作時延遲加載子指令

三、快速開始

3.1 業務邏輯

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

不論是

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):
    ...
           

在上面的示例中：

• 使用裝飾器的方式，即定義了參數，又将之與處理邏輯綁定，這真是優雅。和

  argparse

  、

  docopt

  比起來，就少了一步綁定過程
• 使用

  click.command

  表示

  hello

  是對指令的處理
• 使用

  click.option

  來定義參數選項
• 對于

  --count

  來說，使用

  default

  來指定預設值。而由于預設值是數字，進而暗示

  --count

  選項的類型為數字
• 對于

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

若我們指定次數和名字：

$ 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.
           

四、小結

click

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

click

除了以

Pythonic

的方式讓指令行程式的實作變得更加優雅和好用外，還提供了比

argparse

和

docopt

都要強大的功能。在接下來幾節中，我們将會逐漸揭開它的面紗。

相關文章

• Python 指令行之旅：初探 argparse
• Python 指令行之旅：深入 argparse （一）
• Python 指令行之旅：深入 argparse（二）
• Python 指令行之旅：使用 argparse 實作 git 指令
• Python 指令行之旅：初探 docopt
• Python 指令行之旅：深入 docopt
• Python 指令行之旅：使用 docopt 實作 git 指令
• Python 指令行之旅：初探 click
• Python 指令行之旅：深入 click 之參數篇
• Python 指令行之旅：深入 click 之選項篇
• Python 指令行之旅：深入 click 之指令篇
• Python 指令行之旅：深入 click 之增強功能
• Python 指令行之旅：使用 click 實作 git 指令
• Python 指令行之旅：初探 fire
• Python 指令行之旅：深入 fire（一）
• Python 指令行之旅：深入 fire（二）
• Python 指令行之旅：fire 實作 git 指令
• Python 指令行之旅：argparse、docopt、click 和 fire 總結篇