摘要：是用寫的一個(gè)第三方模塊，用于快速創(chuàng)建命令行?？焖偈褂玫氖褂么笾掠袃蓚€(gè)步驟使用裝飾一個(gè)函數(shù)，使之成為命令行接口使用等裝飾函數(shù)，為其添加命令行選項(xiàng)等。本文標(biāo)題為命令行神器簡(jiǎn)明筆記本文鏈接為參考資料學(xué)習(xí)筆記模塊

Click 是用 Python 寫的一個(gè)第三方模塊，用于快速創(chuàng)建命令行。我們知道，Python 內(nèi)置了一個(gè) Argparse 的標(biāo)準(zhǔn)庫(kù)用于創(chuàng)建命令行，但使用起來(lái)有些繁瑣，Click 相比于 Argparse，就好比 requests 相比于 urllib。

Click 的使用大致有兩個(gè)步驟：

使用 @click.command() 裝飾一個(gè)函數(shù)，使之成為命令行接口；

使用 @click.option() 等裝飾函數(shù)，為其添加命令行選項(xiàng)等。

它的一種典型使用形式如下：

import click

@click.command()
@click.option("--param", default=default_value, help="description")
def func(param):
    pass

下面，讓我們看一下官方文檔的入門例子：

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ù) hello 有兩個(gè)參數(shù)：count 和 name，它們的值從命令行中獲取。

@click.command() 使函數(shù) hello 成為命令行接口；

@click.option 的第一個(gè)參數(shù)指定了命令行選項(xiàng)的名稱，可以看到，count 的默認(rèn)值是 1；

使用 click.echo 進(jìn)行輸出是為了獲得更好的兼容性，因?yàn)?print 在 Python2 和 Python3 的用法有些差別。

看看執(zhí)行情況：

$ python hello.py
Your name: Ethan           # 這里會(huì)顯示 "Your name: "(對(duì)應(yīng)代碼中的 prompt)，接受用戶輸入
Hello Ethan!

$ python hello.py --help   # click 幫我們自動(dòng)生成了 `--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    # 也可以使用 `=`，和上面等價(jià)
Hello Ethan!
Hello Ethan!
Hello Ethan!

$ python hello.py --name=Ethan              # 沒(méi)有指定 count，默認(rèn)值是 1
Hello Ethan!

option 最基本的用法就是通過(guò)指定命令行選項(xiàng)的名稱，從命令行讀取參數(shù)值，再將其傳遞給函數(shù)。在上面的例子，我們看到，除了設(shè)置命令行選項(xiàng)的名稱，我們還會(huì)指定默認(rèn)值，help 說(shuō)明等，option 常用的設(shè)置參數(shù)如下：

default: 設(shè)置命令行參數(shù)的默認(rèn)值

help: 參數(shù)說(shuō)明

type: 參數(shù)類型，可以是 string, int, float 等

prompt: 當(dāng)在命令行中沒(méi)有輸入相應(yīng)的參數(shù)時(shí)，會(huì)根據(jù) prompt 提示用戶輸入

nargs: 指定命令行參數(shù)接收的值的個(gè)數(shù)

下面，我們?cè)倏纯聪嚓P(guān)的例子。

我們可以使用 type 來(lái)指定參數(shù)類型：

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

執(zhí)行情況：

$ python click_type.py --rate 1
rate: 1.0
$ python click_type.py --rate 0.66
rate: 0.66

在某些情況下，一個(gè)參數(shù)的值只能是某些可選的值，如果用戶輸入了其他值，我們應(yīng)該提示用戶輸入正確的值。在這種情況下，我們可以通過(guò) click.Choice() 來(lái)限定：

import click

@click.command()
@click.option("--gender", type=click.Choice(["man", "woman"]))    # 限定值
def choose(gender):
    click.echo("gender: %s" % gender)

if __name__ == "__main__":
    choose()

執(zhí)行情況：

$ 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

有時(shí)，一個(gè)參數(shù)需要接收多個(gè)值。option 支持設(shè)置固定長(zhǎng)度的參數(shù)值，通過(guò) nargs 指定。

看看例子就明白了：

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 指定了兩個(gè)參數(shù)：center 和 radius，其中，center 表示二維平面上一個(gè)圓的圓心坐標(biāo)，接收兩個(gè)值，以元組的形式將值傳遞給函數(shù)，而 radius 表示圓的半徑。

執(zhí)行情況：

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

有時(shí)，在輸入密碼的時(shí)候，我們希望能隱藏顯示。option 提供了兩個(gè)參數(shù)來(lái)設(shè)置密碼的輸入：hide_input 和 confirmation_promt，其中，hide_input 用于隱藏輸入，confirmation_promt 用于重復(fù)輸入。

看看例子：

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

執(zhí)行情況：

$ python click_password.py
Password:                         # 不會(huì)顯示密碼
Repeat for confirmation:          # 重復(fù)一遍
password: 666666

由于上面的寫法有點(diǎn)繁瑣，click 也提供了一種快捷的方式，通過(guò)使用 @click.password_option()，上面的代碼可以簡(jiǎn)寫成：

import click

@click.command()
@click.password_option()
def input_password(password):
    click.echo("password: %s" % password)

if __name__ == "__main__":
    input_password()

有些參數(shù)會(huì)改變命令行程序的執(zhí)行，比如在終端輸入 python 是進(jìn)入 python 控制臺(tái)，而輸入 python --version 是打印 python 版本。Click 提供 eager 標(biāo)識(shí)對(duì)參數(shù)名進(jìn)行標(biāo)識(shí)，如果輸入該參數(shù)，則會(huì)攔截既定的命令行執(zhí)行流程，跳轉(zhuǎn)去執(zhí)行一個(gè)回調(diào)函數(shù)。

讓我們看看例子：

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 表明該命令行選項(xiàng)優(yōu)先級(jí)高于其他選項(xiàng)；

expose_value=False 表示如果沒(méi)有輸入該命令行選項(xiàng)，會(huì)執(zhí)行既定的命令行流程；

callback 指定了輸入該命令行選項(xiàng)時(shí)，要跳轉(zhuǎn)執(zhí)行的函數(shù)；

執(zhí)行情況：

$ python click_eager.py
Hello Ethan!

$ python click_eager.py --version                   # 攔截既定的命令行執(zhí)行流程
Version 1.0

$ python click_eager.py --name Michael
Hello Michael!

$ python click_eager.py --version --name Ethan      # 忽略 name 選項(xiàng)
Version 1.0

我們除了使用 @click.option 來(lái)添加可選參數(shù)，還會(huì)經(jīng)常使用 @click.argument 來(lái)添加固定參數(shù)。它的使用和 option 類似，但支持的功能比 option 少。

下面是一個(gè)簡(jiǎn)單的例子：

import click

@click.command()
@click.argument("coordinates")
def show(coordinates):
    click.echo("coordinates: %s" % coordinates)

if __name__ == "__main__":
    show()

看看執(zhí)行情況：

$ python click_argument.py                     # 錯(cuò)誤，缺少參數(shù) coordinates
Usage: click_argument.py [OPTIONS] COORDINATES

Error: Missing argument "coordinates".

$ python click_argument.py --help              # argument 指定的參數(shù)在 help 中沒(méi)有顯示
Usage: click_argument.py [OPTIONS] COORDINATES

Options:
  --help  Show this message and exit.

$ python click_argument.py --coordinates 10    # 錯(cuò)誤用法，這是 option 參數(shù)的用法
Error: no such option: --coordinates

$ python click_argument.py 10                  # 正確，直接輸入值即可
coordinates: 10

我們?cè)賮?lái)看看多個(gè) argument 的例子：

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

執(zhí)行情況：

$ 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 還有另外一種常見的用法，就是接收不定量的參數(shù)，讓我們看看例子：

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 表明參數(shù) src 接收不定量的參數(shù)值，參數(shù)值會(huì)以 tuple 的形式傳入函數(shù)。如果 nargs 大于等于 1，表示接收 nargs 個(gè)參數(shù)值，上面的例子中，dst 接收一個(gè)參數(shù)值。

讓我們看看執(zhí)行情況：

$ 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 進(jìn)行輸出，如果配合 colorama 這個(gè)模塊，我們可以使用 click.secho 進(jìn)行彩色輸出，在使用之前，使用 pip 安裝 colorama：

$ pip install colorama

看看例子：

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() 裝飾一個(gè)函數(shù)，使其成為命令行接口。

使用 click.option() 添加可選參數(shù)，支持設(shè)置固定長(zhǎng)度的參數(shù)值。

使用 click.argument() 添加固定參數(shù)，支持設(shè)置不定長(zhǎng)度的參數(shù)值。

本文由 funhacks 發(fā)表于個(gè)人博客，采用 Creative Commons BY-NC-ND 4.0（自由轉(zhuǎn)載-保持署名-非商用-禁止演繹）協(xié)議發(fā)布。
非商業(yè)轉(zhuǎn)載請(qǐng)注明作者及出處。商業(yè)轉(zhuǎn)載請(qǐng)聯(lián)系作者本人。
本文標(biāo)題為: 命令行神器 Click 簡(jiǎn)明筆記
本文鏈接為: https://funhacks.net/2016/12/...

Click Documentation (6.0)

Python Click 學(xué)習(xí)筆記

click模塊 - cdwanze