别插我B嗯啊视频免费,日韩综合nv一区二区在线观看,中文天堂最新版在线网

一、前言

在上一篇文章中，我們介紹了 click中的“參數(shù)”，本文將繼續(xù)深入了解 click，著重講解它的“選項”。



本系列文章默認(rèn)使用 Python 3 作為解釋器進行講解。
若你仍在使用 Python 2，請注意兩者之間語法和庫的使用差異哦~
		
			二、選項
		
通過 click.option可以給命令增加選項，并通過配置函數(shù)的參數(shù)來配置不同功能的選項。
	

	
		2.1 給選項命名
	

click.option中的命令規(guī)則可參考參數(shù)名稱^[2]。它接受的前兩個參數(shù)為長、短選項（順序隨意），其中：
		

		
			
				長選項以 “--” 開頭，比如 “--string-to-echo”
			

			
				短選項以 “-” 開頭，比如 “-s”
			

		

第三個參數(shù)為選項參數(shù)的名稱，如果不指定，將會使用長選項的下劃線形式名稱：
	


@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 基本值選項
		
值選項是非常常用的選項，它接受一個值。如果在命令行中提供了值選項，則需要提供對應(yīng)的值；反之則使用默認(rèn)值。若沒在 click.option中指定默認(rèn)值，則默認(rèn)值為 None，且該選項的類型為 STRING^[3]；反之，則選項類型為默認(rèn)值的類型。
	

比如，提供默認(rèn)值為 1，則選項類型為 INT^[4]：
		


@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 中的關(guān)鍵字沖突，則可以顯式的指定選項名稱。比如將 --from的名稱設(shè)置為 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}')
如果要在幫助中顯式默認(rèn)值，則可指定 click.option的 show_default=True：
	


@click.command() @click.option('--n', default=1, show_default=True) def dots(n): click.echo('.' * n)
在命令行中調(diào)用則有：
		
$ dots --help Usage: dots [OPTIONS]

Options:
  --n INTEGER  [default: 1]
  --help Show this message and exit.
		
			2.3 多值選項
		
有時，我們會希望命令行中一個選項能接收多個值，通過指定 click.option中的 nargs參數(shù)（必須是大于等于 0）。這樣，接收的多值選項就會變成一個元組。
	

比如，在下面的示例中，當(dāng)通過 --pos指定多個值時，pos變量就是一個元組，里面的每個元素是一個 float：
		


@click.command() @click.option('--pos', nargs=2, type=float) def findme(pos): click.echo(pos)
在命令行中調(diào)用則有：
	
$ findme --pos 2.0 3.0
(1.0, 2.0)
有時，通過同一選項指定的多個值得類型可能不同，這個時候可以指定 click.option中的 type=(類型1, 類型2, ...)來實現(xiàn)。而由于元組的長度同時表示了值的數(shù)量，所以就無須指定 nargs參數(shù)。
		


@click.command() @click.option('--item', type=(str, int)) def putitem(item): click.echo('name=%s id=%d' % item)
在命令行中調(diào)用則有：
	
$ putitem --item peter 1338
name=peter id=1338
	
		2.4 多選項
	
不同于多值選項是通過一個選項指定多個值，多選項則是使用多個相同選項分別指定值，通過 click.option中的 multiple=True來實現(xiàn)。
		

當(dāng)我們定義如下多選項：
	


@click.command() @click.option('--message', '-m', multiple=True) def commit(message): click.echo('\n'.join(message))
便可以指定任意數(shù)量個選項來指定值，獲取到的 message是一個元組：
		


$ commit -m foo -m bar --message baz
foo
bar
baz
		
			2.5 計值選項
		
有時我們可能需要獲得選項的數(shù)量，那么可以指定 click.option中的 count=True來實現(xiàn)。
	

最常見的使用場景就是指定多個 --verbose或 -v選項來表示輸出內(nèi)容的詳細(xì)程度。
		


@click.command() @click.option('-v', '--verbose', count=True) def log(verbose): click.echo(f'Verbosity: {verbose}')
在命令行中調(diào)用則有：
	
$ log -vvv
Verbosity: 3
通過上面的例子，verbose就是數(shù)字，表示 -v選項的數(shù)量，由此可以進一步使用該值來控制日志的詳細(xì)程度。
		

		
			2.6 布爾選項
		

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

	
		
			通過 click.option的 is_flag=True參數(shù)來實現(xiàn)：
		

	


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)
在命令行中調(diào)用則有：
		
$ info --shout
LINUX!!!!111
		
			
				通過在 click.option的選項定義中使用 /分隔表示真假兩個選項來實現(xiàn)：
			

		


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)
在命令行中調(diào)用則有：
	
$ 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 中調(diào)用則有：
	
> log /debug
debug=True
	
		2.7 特性切換選項
	
所謂特性切換就是切換同一個操作對象的不同特性，比如指定 --upper就讓輸出大寫，指定 --lower就讓輸出小寫。這么來看，布爾值其實是特性切換的一個特例。
		

要實現(xiàn)特性切換選項，需要讓多個選項都有相同的參數(shù)名稱，并且定義它們的標(biāo)記值 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)())
在命令行中調(diào)用則有：
		
$ info --upper
LINUX
$ info --lower
linux
$ info
LINUX
在上面的示例中，--upper和 --lower都有相同的參數(shù)值 transformation：
	

	
		
			當(dāng)指定 --upper時，transformation就是 --upper選項的標(biāo)記值 upper
		

		
			當(dāng)指定 --lower時，transformation就是 --lower選項的標(biāo)記值 lower
		

	

進而就可以做進一步的業(yè)務(wù)邏輯處理。
		

		
			2.8 選擇項選項
		

選擇項選項和 上篇文章中介紹的 選擇項參數(shù)類似，只不過是限定選項內(nèi)容，依舊是通過 type=click.Choice實現(xiàn)。此外，case_sensitive=False還可以忽略選項內(nèi)容的大小寫。
	


@click.command() @click.option('--hash-type', type=click.Choice(['MD5', 'SHA1'], case_sensitive=False)) def digest(hash_type): click.echo(hash_type)
在命令行中調(diào)用則有：
		
$ 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 提示選項
		
顧名思義，當(dāng)提供了選項卻沒有提供對應(yīng)的值時，會提示用戶輸入值。這種交互式的方式會讓命令行變得更加友好。通過指定 click.option中的 prompt可以實現(xiàn)。
	

	
		
			當(dāng) prompt=True時，提示內(nèi)容為選項的參數(shù)名稱
		

	


@click.command() @click.option('--name', prompt=True) def hello(name): click.echo(f'Hello {name}!')
在命令行調(diào)用則有：
		
$ hello --name=John
Hello John!
$ hello
Name: John
Hello John!
		
			
				當(dāng) prompt='Your name please'時，提示內(nèi)容為指定內(nèi)容
			

		


@click.command() @click.option('--name', prompt='Your name please') def hello(name): click.echo(f'Hello {name}!')
在命令行中調(diào)用則有：
	
$ 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")}')
當(dāng)然，也可以直接使用 click.password_option：
	


@click.command() @click.password_option() def encrypt(password): click.echo(f'Encrypting password to {password.encode("rot13")}')
我們還可以給提示選項設(shè)置默認(rèn)值，通過 default參數(shù)進行設(shè)置，如果被設(shè)置為函數(shù)，則可以實現(xiàn)動態(tài)默認(rèn)值。
		


@click.command() @click.option('--username', prompt=True, default=lambda: os.environ.get('USER', '')) def hello(username): print("Hello,", username)
詳情請閱讀 Dynamic Defaults for Prompts^[5]。
	
	
		2.10 范圍選項
	
如果希望選項的值在某個范圍內(nèi)，就可以使用范圍選項，通過指定 type=click.IntRange來實現(xiàn)。它有兩種模式：
		

		
			
				默認(rèn)模式（非強制模式），如果值不在區(qū)間范圍內(nèi)將會引發(fā)一個錯誤。如 type=click.IntRange(0, 10)表示范圍是 [0, 10]，超過該范圍報錯
			

			
				強制模式，如果值不在區(qū)間范圍內(nèi)，將會強制選取一個區(qū)間臨近值。如 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()
在命令行中調(diào)用則有：
	
$ 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 回調(diào)和優(yōu)先
	
回調(diào)通過 click.option中的 callback可以指定選項的回調(diào)，它會在該選項被解析后調(diào)用?；卣{(diào)函數(shù)的簽名如下：
		


def callback(ctx, param, value): pass 
其中：
	
	
		
			ctx 是命令的上下文 click.Context^[6]
		
		
			param 為選項變量 click.Option^[7]
		
		
			value 為選項的值
		
	
使用回調(diào)函數(shù)可以完成額外的參數(shù)校驗邏輯。比如，通過 --rolls 的選項來指定搖骰子的方式，內(nèi)容為“{N}d{M}”，表示 M 面的骰子搖 N 次，N 和 M 都是數(shù)字。在真正的處理 rolls 前，我們需要通過回調(diào)函數(shù)來校驗它的格式：
		
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)
這樣，當(dāng)我們輸入錯誤格式時，變會校驗不通過：
	
$ 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)
優(yōu)先通過 click.option中的 is_eager可以讓該選項成為優(yōu)先選項，這意味著它會先于所有選項處理。
	

利用回調(diào)和優(yōu)先選項，我們就可以很好地實現(xiàn) --version選項。不論命令行中寫了多少選項和參數(shù)，只要包含了 --version，我們就希望它打印版本就退出，而不執(zhí)行其他選項的邏輯，那么就需要讓它成為優(yōu)先選項，并且在回調(diào)函數(shù)中打印版本。
		

此外，在 click中每個選項都對應(yīng)到命令處理函數(shù)的同名參數(shù)，如果不想把該選項傳遞到處理函數(shù)中，則需要指定 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!')
當(dāng)然 click提供了便捷的 click.version_option來實現(xiàn) --version：
		


@click.command() @click.version_option(version='0.1.0') def hello(): pass 
		
			2.12 Yes 選項
		
基于前面的學(xué)習(xí)，我們可以實現(xiàn) Yes 選項，也就是對于某些操作，不提供 --yes則進行二次確認(rèn)，提供了則直接操作：
	


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!')
當(dāng)然 click提供了便捷的 click.confirmation_option來實現(xiàn) Yes 選項：
		


@click.command() @click.confirmation_option(prompt='Are you sure you want to drop the db?') def dropdb(): click.echo('Dropped all tables!')
在命令行中調(diào)用則有：
	
$ dropdb
Are you sure you want to drop the db? [y/N]: n
Aborted!
$ dropdb --yes
Dropped all tables!
	
		2.11 其他增強功能
	
click支持從環(huán)境中讀取選項的值，這是 argparse所不支持的，可參閱官方文檔的 Values from Environment Variables^[8] 和 Multiple Values from Environment Values^[9]。
		

click支持指定選項前綴，你可以不使用 -作為選項前綴，還可使用 +或 /，當(dāng)然在一般情況下并不建議這么做。詳情參閱官方文檔的 Other Prefix Characters^[10]
	

	
		三、總結(jié)
	

可以看出，click對命令行選項的支持非常豐富和強大，除了支持 argarse所支持的所有選項類型外，還提供了諸如 計值選項、特性切換選項、提示選項等更豐富的選項類型。此外，還提供了從環(huán)境中讀變量等方便易用的增強功能。簡直就是開發(fā)命令行程序的利器。
		

在下篇文章中，我們著重介紹下 click的命令和組，這可是實現(xiàn)它的重要特性（任意嵌套命令）的方式。


                
            欲知詳情，請下載word文檔 下載文檔

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

二、選項

`2.1 給選項命名`

2.2 基本值選項

2.3 多值選項

2.4 多選項

2.5 計值選項

`2.6 布爾選項`

2.7 特性切換選項

`2.8 選擇項選項`

2.9 提示選項

2.10 范圍選項

2.11 回調(diào)和優(yōu)先

2.12 Yes 選項

2.11 其他增強功能

`三、總結(jié)`

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

二、選項

2.1 給選項命名

2.2 基本值選項

2.3 多值選項

2.4 多選項

2.5 計值選項

2.6 布爾選項

2.7 特性切換選項

2.8 選擇項選項

2.9 提示選項

2.10 范圍選項

2.11 回調(diào)和優(yōu)先

2.12 Yes 選項

2.11 其他增強功能

三、總結(jié)

二、選項

`2.1 給選項命名`

`2.6 布爾選項`

`2.8 選擇項選項`

`三、總結(jié)`