Python--Click

Click

Click 是 Flask 的開發團隊 Pallets 的另外一款開源項目，它是用於快速建立命令行的第三方模塊。

咱們知道，Python 內置了一個 Argparse 的標準庫用於建立命令行，但使用起來有些繁瑣，Click 相比於 Argparse，就比如 requests 相比於 urllib。

Click 是一個第三方庫，所以，在使用以前須要先安裝：

pip install click

參考文檔http://click.pocoo.org/6/options/

Click 對argparse 的主要改進在易用性，使用Click 分爲兩個步驟：

1. 使用 @click.command() 裝飾一個函數，使之成爲命令行接口；
2. 使用 @click.option() 等裝飾函數，爲其添加命令行選項等。

看一下官方文檔的入門例子：

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 的用法有些差異。

 

執行狀況

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

 

Group使用

Click 經過 group 來建立一個命令行組，也就是說它能夠有各類參數來解決相同類別的不一樣問題

import click

@click.group()
def cli():
    pass

@click.command()
def initdb():
    click.echo('Initialized the database')
····
@click.command()
def dropdb():
    click.echo('Droped the database')

cli.add_command(initdb)
cli.add_command(dropdb)

if __name__ == "__main__":
    cli()

執行狀況

$ python hello.py
Usage: hello.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  dropdb
  initdb
$ python hello.py initdb
Initialized the database
$ python hello.py dropdb
Droped the database

 

 click.option使用

option 最基本的用法就是經過指定命令行選項的名稱，從命令行讀取參數值，再將其傳遞給函數。

在上面的例子，咱們看到，除了設置命令行選項的名稱，咱們還會指定默認值，help 說明等，option 經常使用的設置參數以下：

 

• default: 設置命令行參數的默認值

• help: 參數說明

• type: 參數類型，能夠是 string, int, float 等

• prompt: 當在命令行中沒有輸入相應的參數時，會根據 prompt 提示用戶輸入

• nargs: 指定命令行參數接收的值的個數

• metavar：如何在幫助頁面表示值

 

下面，咱們再看看相關的例子。

指定 type

咱們可使用 type 來指定參數類型：

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

 執行狀況：

$ python click_type.py --help
Usage: click_type.py [OPTIONS]

Options:
  --rate FLOAT  rate
  --help        Show this message and exit.

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

 

可選值

在某些狀況下，一個參數的值只能是某些可選的值，若是用戶輸入了其餘值，咱們應該提示用戶輸入正確的值。

在這種狀況下，咱們能夠經過 click.Choice() 來限定

執行狀況：

$ python click_choice.py  --help
Usage: click_choice.py [OPTIONS]

Options:
  --gender [man|woman]
  --help                Show this message and exit.

$ 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 指定。

$ python click_multi_values.py --help
Usage: click_multi_values.py [OPTIONS]

Options:
  --center FLOAT...  center of the circle
  --radius FLOAT     radius of the circle


$ 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 用於重複輸入。

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

 

執行狀況：

$ python click_password.py Password: # 不會顯示密碼
Repeat for confirmation:          # 重複一遍
password: 123

click 也提供了一種快捷的方式，經過使用 @click.password_option()，上面的代碼能夠簡寫成：

import click
  
@click.command()
@click.password_option()
def input_password(password):
    click.echo('password: %s' % password)
  
if __name__ == '__main__':
    input_password()

 click.IntRange()

@click.command()
@click.option('--count', type=click.IntRange(0, 20, clamp=True))
@click.option('--digit', type=click.IntRange(0, 10))
def repeat(count, digit):
    click.echo(str(digit) * count)

if __name__ == '__main__':
    repeat()

=========================================
$ repeat --count=1000 --digit=5
55555555555555555555
$ repeat --count=1000 --digit=12
Usage: repeat [OPTIONS]

Error: Invalid value for "--digit": 12 is not in the valid range of 0 to 10.

 

 

改變命令行程序的執行

 有些參數會改變命令行程序的執行，好比在終端輸入 python 是進入 python 控制檯，

而輸入 python --version 是打印 python 版本。Click 提供 eager 標識對參數名進行標識，

若是輸入該參數，則會攔截既定的命令行執行流程，跳轉去執行一個回調函數。

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 指定了輸入該命令行選項時，要跳轉執行的函數
• is_flag=True 代表參數值能夠省略

執行狀況：

$ 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

使用argument

咱們除了使用 @click.option 來添加可選參數，還會常用 @click.argument 來添加固定參數。

它的使用和 option 相似，但支持的功能比 option 少。

入門使用

下面是一個簡單的例子：

import click
@click.command()
@click.argument('coordinates')
def show(coordinates):
    click.echo('coordinates: %s' % coordinates)
if __name__ == '__main__':
    show()

看看執行狀況：

$ 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

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

執行狀況

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

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 接收一個參數值。

執行狀況：

$ python click_argument.py file1 trash    # src=('file1',)  dst='trash'
move ('file1',) to trash
$ python click_argument.py file1 file2 file3 trash   # src=('file1', 'file2', 'file3')  dst='trash'
move ('file1', 'file2', 'file3') to trash

 

Click 支持經過文件名參數對文件進行操做，click.File() 裝飾器就是處理這種操做的，尤爲是在類 Unix 系統下，它支持以 - 符號做爲標準輸入/輸出 

# File
@click.command()
@click.argument('input', type=click.File('rb'))
@click.argument('output', type=click.File('wb'))
def inout(input, output):
　　while True:
　　　　chunk = input.read(1024)
　　　　if not chunk:
　　　　　　break
　　　　output.write(chunk)

 

彩色輸出

在前面的例子中，咱們使用 click.echo 進行輸出，若是配合 colorama 這個模塊，

咱們可使用 click.secho 進行彩色輸出，在使用以前，使用 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 經過 click.option() 添加可選參數，經過 click.argument() 來添加有可能可選的參數

如下幾點是兩個的區別：

• 須要提示補全輸入的時候使用 option()
• 標誌位(flag or acts) 使用 option()
• option的值能夠從環境變量獲取，而argument不行
• option的值會在幫助裏面列出，而argument不能

安裝打包

Click 支持使用 setuptools 來更好的實現命令行程序打包，把源碼文件打包成系統中的可執行程序，

而且不限平臺。通常咱們會在源碼根目錄下建立 setup.py 腳本，先看一段簡單的打包代碼

from setuptools import setup

setup(
    name='hello',
    version='0.1',
    py_modules=['hello'],
    install_requires=[
        'Click',
    ],
    entry_points={'console_scripts': [
        'digest=hello:digest',
        'goodbye=hello:goodbye'
    ]},
)

 

hello.py

默認狀況下click不提供-h。須要使用context_settings參數來重寫默認help_option_names。

import click

CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])


def greeter(**kwargs):
    output = '{0}, {1}!'.format(kwargs['greeting'],
                                kwargs['name'])
    if kwargs['caps']:
        output = output.upper()
    print(output)


@click.group(context_settings=CONTEXT_SETTINGS)
@click.version_option(version='1.0.0')
def greet():
    pass


@greet.command()
@click.argument('name')
@click.option('--greeting', default='Hello', help='word to use for the greeting')
@click.option('--caps', is_flag=True, help='uppercase the output')
def hello(**kwargs):
    greeter(**kwargs)


@greet.command()
@click.argument('name')
@click.option('--greeting', default='Goodbye', help='word to use for the greeting')
@click.option('--caps', is_flag=True, help='uppercase the output')
def goodbye(**kwargs):
    greeter(**kwargs)

@greet.command()
@click.option('--hash-type', type=click.Choice(['md5', 'sha1']))
def digest(hash_type):
    click.echo(hash_type)

if __name__ == '__main__':
    greet()

 

 執行狀況

#python hello.py install # digest --hash-type md5
md5 # goodbye --help
Usage: goodbye [OPTIONS] NAME Options: --greeting TEXT  word to use for the greeting --caps uppercase the output --help           Show this message and exit. # goodbye --caps hh
GOODBYE, HH!

 

舉例說明

import click

CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])


@click.group(context_settings=CONTEXT_SETTINGS)
@click.version_option(version='1.0.0')
def cli():
    """Repo is a command line tool that showcases how to build complex
        command line interfaces with Click.
        This tool is supposed to look like a distributed version control
        system to show how something like this can be structured.
    )"""
    pass


@cli.command()
@click.argument('name', default='all', required=True)
# @click.option('--greeting', default='Hello', help='word to use for the greeting')
# @click.option('--caps', is_flag=True, help='uppercase the output')
def hellocmd(name):
    click.echo(
        click.style(
            'I am colored %s and bold' %
            name,
            fg='green',
            bold=True))


@cli.command()
@click.option('-t', default='a', required=True,
              type=click.Choice(['a', 'h']), prompt=True, help='檢查磁盤空間,a表示全部空間，h表示空間大於50%')
def dfcmd(t):
    """
    檢查磁盤空間 dfcmd
    :param t:
    :return:
    """
    click.echo(click.style('檢查磁盤空間', fg='green', bold=True))


@cli.command(context_settings=CONTEXT_SETTINGS)
@click.argument('x', type=int, required=True)
def square(x):
    """
    獲得x平方 square x
    """
    click.echo(click.style('x= %s' % x, fg='green', bold=True))
    print(x * x)


if __name__ == '__main__':
    cli()

　　

輸出結果

XXXPycharmProjects\LuffyFTP\utils>python arg_example.py
Usage: arg_example.py [OPTIONS] COMMAND [ARGS]...

  Repo is a command line tool that showcases how to build complex
  command line interfaces with Click.     This tool is supposed to look like
  a distributed version control     system to show how something like this
  can be structured. )

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  dfcmd     檢查磁盤空間 dfcmd :param t: :return:
  hellocmd
  square    獲得x平方 square x

XXXPycharmProjects\LuffyFTP\utils>python arg_example.py -h
Usage: arg_example.py [OPTIONS] COMMAND [ARGS]...

  Repo is a command line tool that showcases how to build complex
  command line interfaces with Click.     This tool is supposed to look like
  a distributed version control     system to show how something like this
  can be structured. )

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  dfcmd     檢查磁盤空間 dfcmd :param t: :return:
  hellocmd
  square    獲得x平方 square x

XXXPycharmProjects\LuffyFTP\utils>python arg_example.py dfcmd -h
Usage: arg_example.py dfcmd [OPTIONS]

  檢查磁盤空間 dfcmd :param t: :return:

Options:
  -t [a|h]    檢查磁盤空間,a表示全部空間，h表示空間大於50%  [required]
  -h, --help  Show this message and exit.

XXXPycharmProjects\LuffyFTP\utils>python arg_example.py square -h

Usage: arg_example.py square [OPTIONS] X

  獲得x平方 square x

Options:
  -h, --help  Show this message and exit.

XXXPycharmProjects\LuffyFTP\utils>python arg_example.py square 5
x5
25

XXXPycharmProjects\LuffyFTP\utils>python arg_example.py square 5
x= 5
25