Click 是用 Python 寫的一個第三方模組，用於快速建立命令列。我們知道，Python 內建了一個 Argparse 的標準庫用於建立命令列，但使用起來有些繁瑣，Click 相比於 Argparse，就好比 requests 相比於 urllib。
快速使用
Click 的使用大致有兩個步驟：
- 使用
@click.command()裝飾一個函式，使之成為命令列介面； - 使用
@click.option()等裝飾函式，為其新增命令列選項等。
它的一種典型使用形式如下：
|
1 2 3 4 5 6 |
import click @click.command() @click.option('--param', default=default_value, help='description') def func(param): pass |
下面，讓我們看一下官方文件的入門例子：
|
1 2 3 4 5 6 7 8 9 10 11 12 |
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() |
在上面的例子中，函式 hello 有兩個引數：count 和 name，它們的值從命令列中獲取。
@click.command()使函式hello成為命令列介面；@click.option的第一個引數指定了命令列選項的名稱，可以看到，count 的預設值是 1；- 使用
click.echo進行輸出是為了獲得更好的相容性，因為print在 Python2 和 Python3 的用法有些差別。
看看執行情況：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
$ python hello.py Your name: Ethan # 這裡會顯示 'Your name: '(對應程式碼中的 prompt)，接受使用者輸入 Hello Ethan! $ python hello.py --help # click 幫我們自動生成了 `--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 hello.py --count 3 --name Ethan # 指定 count 和 name 的值 Hello Ethan! Hello Ethan! Hello Ethan! $ python hello.py --count=3 --name=Ethan # 也可以使用 `=`，和上面等價 Hello Ethan! Hello Ethan! Hello Ethan! $ python hello.py --name=Ethan # 沒有指定 count，預設值是 1 Hello Ethan! |
click.option
option 最基本的用法就是通過指定命令列選項的名稱，從命令列讀取引數值，再將其傳遞給函式。在上面的例子，我們看到，除了設定命令列選項的名稱，我們還會指定預設值，help 說明等，option 常用的設定引數如下：
- default: 設定命令列引數的預設值
- help: 引數說明
- type: 引數型別，可以是 string, int, float 等
- prompt: 當在命令列中沒有輸入相應的引數時，會根據 prompt 提示使用者輸入
- nargs: 指定命令列引數接收的值的個數
下面，我們再看看相關的例子。
指定 type
我們可以使用 type 來指定引數型別：
|
1 2 3 4 5 6 7 8 9 |
import click @click.command() @click.option('--rate', type=float, help='rate') # 指定 rate 是 float 型別 def show(rate): click.echo('rate: %s' % rate) if __name__ == '__main__': show() |
執行情況：
|
1 2 3 4 |
$ python click_type.py --rate 1 rate: 1.0 $ python click_type.py --rate 0.66 rate: 0.66 |
可選值
在某些情況下，一個引數的值只能是某些可選的值，如果使用者輸入了其他值，我們應該提示使用者輸入正確的值。在這種情況下，我們可以通過 click.Choice() 來限定：
|
1 2 3 4 5 6 7 8 9 |
import click @click.command() @click.option('--gender', type=click.Choice(['man', 'woman'])) # 限定值 def choose(gender): click.echo('gender: %s' % gender) if __name__ == '__main__': choose() |
執行情況：
|
1 2 3 4 5 6 7 |
$ python click_choice.py --gender boy Usage: click_choice.py [OPTIONS] Error: Invalid value for "--gender": invalid choice: boy. (choose from man, woman) $ python click_choice.py --gender man gender: man |
多值引數
有時，一個引數需要接收多個值。option 支援設定固定長度的引數值，通過 nargs 指定。
看看例子就明白了：
|
1 2 3 4 5 6 7 8 9 10 |
import click @click.command() @click.option('--center', nargs=2, type=float, help='center of the circle') @click.option('--radius', type=float, help='radius of the circle') def circle(center, radius): click.echo('center: %s, radius: %s' % (center, radius)) if __name__ == '__main__': circle() |
在上面的例子中，option 指定了兩個引數：center 和 radius，其中，center 表示二維平面上一個圓的圓心座標，接收兩個值，以元組的形式將值傳遞給函式，而 radius 表示圓的半徑。
執行情況：
|
1 2 3 4 5 6 7 |
$ python click_multi_values.py --center 3 4 --radius 10 center: (3.0, 4.0), radius: 10.0 $ python click_multi_values.py --center 3 4 5 --radius 10 Usage: click_multi_values.py [OPTIONS] Error: Got unexpected extra argument (5) |
輸入密碼
有時，在輸入密碼的時候，我們希望能隱藏顯示。option 提供了兩個引數來設定密碼的輸入：hide_input 和 confirmation_promt，其中，hide_input 用於隱藏輸入，confirmation_promt 用於重複輸入。
看看例子：
|
1 2 3 4 5 6 7 8 9 10 |
import click @click.command() @click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True) def input_password(password): click.echo('password: %s' % password) if __name__ == '__main__': input_password() |
執行情況：
|
1 2 3 4 |
$ python click_password.py Password: # 不會顯示密碼 Repeat for confirmation: # 重複一遍 password: 666666 |
由於上面的寫法有點繁瑣，click 也提供了一種快捷的方式，通過使用 @click.password_option()，上面的程式碼可以簡寫成：
|
1 2 3 4 5 6 7 8 9 |
import click @click.command() @click.password_option() def input_password(password): click.echo('password: %s' % password) if __name__ == '__main__': input_password() |
改變命令列程式的執行
有些引數會改變命令列程式的執行，比如在終端輸入 python 是進入 python 控制檯，而輸入 python --version 是列印 python 版本。Click 提供 eager 標識對引數名進行標識，如果輸入該引數，則會攔截既定的命令列執行流程，跳轉去執行一個回撥函式。
讓我們看看例子：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
import click def print_version(ctx, param, value): if not value or ctx.resilient_parsing: return click.echo('Version 1.0') ctx.exit() @click.command() @click.option('--version', is_flag=True, callback=print_version, expose_value=False, is_eager=True) @click.option('--name', default='Ethan', help='name') def hello(name): click.echo('Hello %s!' % name) if __name__ == '__main__': hello() |
其中：
is_eager=True表明該命令列選項優先順序高於其他選項；expose_value=False表示如果沒有輸入該命令列選項，會執行既定的命令列流程；callback指定了輸入該命令列選項時，要跳轉執行的函式；
執行情況：
|
1 2 3 4 5 6 7 8 9 10 11 |
$ python click_eager.py Hello Ethan! $ python click_eager.py --version # 攔截既定的命令列執行流程 Version 1.0 $ python click_eager.py --name Michael Hello Michael! $ python click_eager.py --version --name Ethan # 忽略 name 選項 Version 1.0 |
click.argument
我們除了使用 @click.option 來新增可選引數，還會經常使用 @click.argument 來新增固定引數。它的使用和 option 類似，但支援的功能比 option 少。
入門使用
下面是一個簡單的例子：
|
1 2 3 4 5 6 7 8 9 |
import click @click.command() @click.argument('coordinates') def show(coordinates): click.echo('coordinates: %s' % coordinates) if __name__ == '__main__': show() |
看看執行情況：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
$ python click_argument.py # 錯誤，缺少引數 coordinates Usage: click_argument.py [OPTIONS] COORDINATES Error: Missing argument "coordinates". $ python click_argument.py --help # argument 指定的引數在 help 中沒有顯示 Usage: click_argument.py [OPTIONS] COORDINATES Options: --help Show this message and exit. $ python click_argument.py --coordinates 10 # 錯誤用法，這是 option 引數的用法 Error: no such option: --coordinates $ python click_argument.py 10 # 正確，直接輸入值即可 coordinates: 10 |
多個 argument
我們再來看看多個 argument 的例子：
|
1 2 3 4 5 6 7 8 9 10 11 |
import click @click.command() @click.argument('x') @click.argument('y') @click.argument('z') def show(x, y, z): click.echo('x: %s, y: %s, z:%s' % (x, y, z)) if __name__ == '__main__': show() |
執行情況：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
$ python click_argument.py 10 20 30 x: 10, y: 20, z:30 $ python click_argument.py 10 Usage: click_argument.py [OPTIONS] X Y Z Error: Missing argument "y". $ python click_argument.py 10 20 Usage: click_argument.py [OPTIONS] X Y Z Error: Missing argument "z". $ python click_argument.py 10 20 30 40 Usage: click_argument.py [OPTIONS] X Y Z Error: Got unexpected extra argument (40) |
不定引數
argument 還有另外一種常見的用法，就是接收不定量的引數，讓我們看看例子：
|
1 2 3 4 5 6 7 8 9 10 |
import click @click.command() @click.argument('src', nargs=-1) @click.argument('dst', nargs=1) def move(src, dst): click.echo('move %s to %s' % (src, dst)) if __name__ == '__main__': move() |
其中，nargs=-1 表明引數 src 接收不定量的引數值，引數值會以 tuple 的形式傳入函式。如果 nargs 大於等於 1，表示接收 nargs 個引數值，上面的例子中，dst 接收一個引數值。
讓我們看看執行情況：
|
1 2 3 4 5 |
$ python click_argument.py file1 trash # src=('file1',) dst='trash' move (u'file1',) to trash $ python click_argument.py file1 file2 file3 trash # src=('file1', 'file2', 'file3') dst='trash' move (u'file1', u'file2', u'file3') to trash |
彩色輸出
在前面的例子中，我們使用 click.echo 進行輸出，如果配合 colorama 這個模組，我們可以使用 click.secho 進行彩色輸出，在使用之前，使用 pip 安裝 colorama：
|
1 |
$ pip install colorama |
看看例子：
|
1 2 3 4 5 6 7 8 9 10 |
import click @click.command() @click.option('--name', help='The person to greet.') def hello(name): click.secho('Hello %s!' % name, fg='red', underline=True) click.secho('Hello %s!' % name, fg='yellow', bg='black') if __name__ == '__main__': hello() |
其中:
fg表示前景顏色（即字型顏色），可選值有：BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等；bg表示背景顏色，可選值有：BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等；underline表示下劃線，可選的樣式還有：dim=True，bold=True等；
小結
- 使用
click.command()裝飾一個函式，使其成為命令列介面。 - 使用
click.option()新增可選引數，支援設定固定長度的引數值。 - 使用
click.argument()新增固定引數，支援設定不定長度的引數值。