Python 命令行之旅：深刻 click 之選項篇

做者：HelloGitHub-Prodesire

HelloGitHub 的《講解開源項目》系列，項目地址：https://github.com/HelloGitHub-Team/Article

1、前言

在上一篇文章中，咱們介紹了 click 中的「參數」，本文將繼續深刻了解 click，着重講解它的「選項」。

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

2、選項

經過 click.option 能夠給命令增長選項，並經過配置函數的參數來配置不一樣功能的選項。

2.1 給選項命名

click.option 中的命令規則可參考參數名稱。它接受的前兩個參數爲長、短選項（順序隨意），其中：

• 長選項以 「--」 開頭，好比 「--string-to-echo」
• 短選項以 「-」 開頭，好比 「-s」

第三個參數爲選項參數的名稱，若是不指定，將會使用長選項的下劃線形式名稱：

@click.command()
@click.option('-s', '--string-to-echo')
def echo(string_to_echo):
    click.echo(string_to_echo)

顯示指定爲 string

@click.command()
@click.option('-s', '--string-to-echo', 'string')
def echo(string):
    click.echo(string)

2.2 基本值選項

值選項是很是經常使用的選項，它接受一個值。若是在命令行中提供了值選項，則須要提供對應的值；反之則使用默認值。若沒在 click.option 中指定默認值，則默認值爲 None，且該選項的類型爲 STRING；反之，則選項類型爲默認值的類型。

好比，提供默認值爲 1，則選項類型爲 INT：

@click.command()
@click.option('--n', default=1)
def dots(n):
    click.echo('.' * n)

若是要求選項爲必填，則可指定 click.option 的 required=True：

@click.command()
@click.option('--n', required=True, type=int)
def dots(n):
    click.echo('.' * n)

若是選項名稱和 Python 中的關鍵字衝突，則能夠顯式的指定選項名稱。好比將 --from 的名稱設置爲 from_：

@click.command()
@click.option('--from', '-f', 'from_')
@click.option('--to', '-t')
def reserved_param_name(from_, to):
    click.echo(f'from {from_} to {to}')

若是要在幫助中顯式默認值，則可指定 click.option 的 show_default=True：

@click.command()
@click.option('--n', default=1, show_default=True)
def dots(n):
    click.echo('.' * n)

在命令行中調用則有：

$ dots --help
Usage: dots [OPTIONS]

Options:
  --n INTEGER  [default: 1]
  --help       Show this message and exit.

2.3 多值選項

有時，咱們會但願命令行中一個選項能接收多個值，經過指定 click.option 中的 nargs 參數（必須是大於等於 0）。這樣，接收的多值選項就會變成一個元組。

好比，在下面的示例中，當經過 --pos 指定多個值時，pos 變量就是一個元組，裏面的每一個元素是一個 float：

@click.command()
@click.option('--pos', nargs=2, type=float)
def findme(pos):
    click.echo(pos)

在命令行中調用則有：

$ findme --pos 2.0 3.0
(1.0, 2.0)

有時，經過同一選項指定的多個值得類型可能不一樣，這個時候能夠指定 click.option 中的 type=(類型1, 類型2, ...) 來實現。而因爲元組的長度同時表示了值的數量，因此就無須指定 nargs 參數。

@click.command()
@click.option('--item', type=(str, int))
def putitem(item):
    click.echo('name=%s id=%d' % item)

在命令行中調用則有：

$ putitem --item peter 1338
name=peter id=1338

2.4 多選項

不一樣於多值選項是經過一個選項指定多個值，多選項則是使用多個相同選項分別指定值，經過 click.option 中的 multiple=True 來實現。

當咱們定義以下多選項：

@click.command()
@click.option('--message', '-m', multiple=True)
def commit(message):
    click.echo('\n'.join(message))

即可以指定任意數量個選項來指定值，獲取到的 message 是一個元組：

$ commit -m foo -m bar --message baz
foo
bar
baz

2.5 計值選項

有時咱們可能須要得到選項的數量，那麼能夠指定 click.option 中的 count=True 來實現。

最多見的使用場景就是指定多個 --verbose 或 -v 選項來表示輸出內容的詳細程度。

@click.command()
@click.option('-v', '--verbose', count=True)
def log(verbose):
    click.echo(f'Verbosity: {verbose}')

在命令行中調用則有：

$ log -vvv
Verbosity: 3

經過上面的例子，verbose 就是數字，表示 -v 選項的數量，由此能夠進一步使用該值來控制日誌的詳細程度。

2.6 布爾選項

布爾選項用來表示真或假，它有多種實現方式：

• 經過 click.option 的 is_flag=True 參數來實現：

import sys

@click.command()
@click.option('--shout', is_flag=True)
def info(shout):
    rv = sys.platform
    if shout:
        rv = rv.upper() + '!!!!111'
    click.echo(rv)

在命令行中調用則有：

$ info --shout
LINUX!!!!111

• 經過在 click.option 的選項定義中使用 / 分隔表示真假兩個選項來實現：

import sys

@click.command()
@click.option('--shout/--no-shout', default=False)
def info(shout):
    rv = sys.platform
    if shout:
        rv = rv.upper() + '!!!!111'
    click.echo(rv)

在命令行中調用則有：

$ info --shout
LINUX!!!!111
$ info --no-shout
linux

在 Windows 中，一個選項能夠以 / 開頭，這樣就會真假選項的分隔符衝突了，這個時候可使用 ; 進行分隔：

@click.command()
@click.option('/debug;/no-debug')
def log(debug):
    click.echo(f'debug={debug}')

if __name__ == '__main__':
    log()

在 cmd 中調用則有：

> log /debug
debug=True

2.7 特性切換選項

所謂特性切換就是切換同一個操做對象的不一樣特性，好比指定 --upper 就讓輸出大寫，指定 --lower 就讓輸出小寫。這麼來看，布爾值實際上是特性切換的一個特例。

要實現特性切換選項，須要讓多個選項都有相同的參數名稱，而且定義它們的標記值 flag_value：

import sys

@click.command()
@click.option('--upper', 'transformation', flag_value='upper',
              default=True)
@click.option('--lower', 'transformation', flag_value='lower')
def info(transformation):
    click.echo(getattr(sys.platform, transformation)())

在命令行中調用則有：

$ info --upper
LINUX
$ info --lower
linux
$ info
LINUX

在上面的示例中，--upper 和 --lower 都有相同的參數值 transformation：

• 當指定 --upper 時，transformation 就是 --upper 選項的標記值 upper
• 當指定 --lower 時，transformation 就是 --lower 選項的標記值 lower

進而就能夠作進一步的業務邏輯處理。

2.8 選擇項選項

選擇項選項 和 上篇文章中介紹的 選擇項參數 相似，只不過是限定選項內容，依舊是經過 type=click.Choice 實現。此外，case_sensitive=False 還能夠忽略選項內容的大小寫。

@click.command()
@click.option('--hash-type',
              type=click.Choice(['MD5', 'SHA1'], case_sensitive=False))
def digest(hash_type):
    click.echo(hash_type)

在命令行中調用則有：

$ digest --hash-type=MD5
MD5

$ digest --hash-type=md5
MD5

$ digest --hash-type=foo
Usage: digest [OPTIONS]
Try "digest --help" for help.

Error: Invalid value for "--hash-type": invalid choice: foo. (choose from MD5, SHA1)

$ digest --help
Usage: digest [OPTIONS]

Options:
  --hash-type [MD5|SHA1]
  --help                  Show this message and exit.

2.9 提示選項

顧名思義，當提供了選項卻沒有提供對應的值時，會提示用戶輸入值。這種交互式的方式會讓命令行變得更加友好。經過指定 click.option 中的 prompt 能夠實現。

• 當 prompt=True 時，提示內容爲選項的參數名稱

@click.command()
@click.option('--name', prompt=True)
def hello(name):
    click.echo(f'Hello {name}!')

在命令行調用則有：

$ hello --name=John
Hello John!
$ hello
Name: John
Hello John!

• 當 prompt='Your name please' 時，提示內容爲指定內容

@click.command()
@click.option('--name', prompt='Your name please')
def hello(name):
    click.echo(f'Hello {name}!')

在命令行中調用則有：

$ hello
Your name please: John
Hello John!

基於提示選項，咱們還能夠指定 hide_input=True 來隱藏輸入，confirmation_prompt=True 來讓用戶進行二次輸入，這很是適合輸入密碼的場景。

@click.command()
@click.option('--password', prompt=True, hide_input=True,
              confirmation_prompt=True)
def encrypt(password):
    click.echo(f'Encrypting password to {password.encode("rot13")}')

固然，也能夠直接使用 click.password_option：

@click.command()
@click.password_option()
def encrypt(password):
    click.echo(f'Encrypting password to {password.encode("rot13")}')

咱們還能夠給提示選項設置默認值，經過 default 參數進行設置，若是被設置爲函數，則能夠實現動態默認值。

@click.command()
@click.option('--username', prompt=True,
              default=lambda: os.environ.get('USER', ''))
def hello(username):
    print("Hello,", username)

詳情請閱讀 Dynamic Defaults for Prompts。

2.10 範圍選項

若是但願選項的值在某個範圍內，就可使用範圍選項，經過指定 type=click.IntRange 來實現。它有兩種模式：

• 默認模式（非強制模式），若是值不在區間範圍內將會引起一個錯誤。如 type=click.IntRange(0, 10) 表示範圍是 [0, 10]，超過該範圍報錯
• 強制模式，若是值不在區間範圍內，將會強制選取一個區間臨近值。如 click.IntRange(0, None, clamp=True) 表示範圍是 [0, +∞)，小於 0 則取 0，大於 20 則取 20。其中 None 表示沒有限制

@click.command()
@click.option('--count', type=click.IntRange(0, None, 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.

2.11 回調和優先

回調
經過 click.option 中的 callback 能夠指定選項的回調，它會在該選項被解析後調用。回調函數的簽名以下：

def callback(ctx, param, value):
    pass

其中：

• ctx 是命令的上下文 click.Context
• param 爲選項變量 click.Option
• value 爲選項的值

使用回調函數能夠完成額外的參數校驗邏輯。好比，經過 --rolls 的選項來指定搖骰子的方式，內容爲「{N}d{M}」，表示 M 面的骰子搖 N 次，N 和 M 都是數字。在真正的處理 rolls 前，咱們須要經過回調函數來校驗它的格式：

def validate_rolls(ctx, param, value):
    try:
        rolls, dice = map(int, value.split('d', 2))
        return (dice, rolls)
    except ValueError:
        raise click.BadParameter('rolls need to be in format NdM')

@click.command()
@click.option('--rolls', callback=validate_rolls, default='1d6')
def roll(rolls):
    click.echo('Rolling a %d-sided dice %d time(s)' % rolls)

這樣，當咱們輸入錯誤格式時，變會校驗不經過：

$ roll --rolls=42
Usage: roll [OPTIONS]

Error: Invalid value for "--rolls": rolls need to be in format NdM

輸入正確格式時，則正常輸出信息：

$ roll --rolls=2d12
Rolling a 12-sided dice 2 time(s)

優先
經過 click.option 中的 is_eager 可讓該選項成爲優先選項，這意味着它會先於全部選項處理。

利用回調和優先選項，咱們就能夠很好地實現 --version 選項。不論命令行中寫了多少選項和參數，只要包含了 --version，咱們就但願它打印版本就退出，而不執行其餘選項的邏輯，那麼就須要讓它成爲優先選項，而且在回調函數中打印版本。

此外，在 click 中每一個選項都對應到命令處理函數的同名參數，若是不想把該選項傳遞處處理函數中，則須要指定 expose_value=True，因而有：

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)
def hello():
    click.echo('Hello World!')

固然 click 提供了便捷的 click.version_option 來實現 --version：

@click.command()
@click.version_option(version='0.1.0')
def hello():
    pass

2.12 Yes 選項

基於前面的學習，咱們能夠實現 Yes 選項，也就是對於某些操做，不提供 --yes 則進行二次確認，提供了則直接操做：

def abort_if_false(ctx, param, value):
    if not value:
        ctx.abort()

@click.command()
@click.option('--yes', is_flag=True, callback=abort_if_false,
              expose_value=False,
              prompt='Are you sure you want to drop the db?')
def dropdb():
    click.echo('Dropped all tables!')

固然 click 提供了便捷的 click.confirmation_option 來實現 Yes 選項：

@click.command()
@click.confirmation_option(prompt='Are you sure you want to drop the db?')
def dropdb():
    click.echo('Dropped all tables!')

在命令行中調用則有：

$ dropdb
Are you sure you want to drop the db? [y/N]: n
Aborted!
$ dropdb --yes
Dropped all tables!

2.11 其餘加強功能

click 支持從環境中讀取選項的值，這是 argparse 所不支持的，可參閱官方文檔的 Values from Environment Variables 和 Multiple Values from Environment Values。

click 支持指定選項前綴，你能夠不使用 - 做爲選項前綴，還可以使用 + 或 /，固然在通常狀況下並不建議這麼作。詳情參閱官方文檔的 Other Prefix Characters

3、總結

能夠看出，click 對命令行選項的支持很是豐富和強大，除了支持 argarse 所支持的全部選項類型外，還提供了諸如 計值選項、特性切換選項、提示選項 等更豐富的選項類型。此外，還提供了從環境中讀變量等方便易用的加強功能。簡直就是開發命令行程序的利器。

在下篇文章中，咱們着重介紹下 click 的命令和組，這但是實現它的重要特性（任意嵌套命令）的方式。

---

『講解開源項目系列』——讓對開源項目感興趣的人再也不畏懼、讓開源項目的發起者再也不孤單。跟着咱們的文章，你會發現編程的樂趣、使用和發現參與開源項目如此簡單。歡迎留言聯繫咱們、加入咱們，讓更多人愛上開源、貢獻開源～