如何編寫完美的 Python命令行程序?
作為 Python 開發(fā)者,我們經(jīng)常要編寫命令行程序。比如在我的數(shù)據(jù)科學(xué)項目中,我要從命令行運行腳本來訓(xùn)練模型,以及計算算法的準(zhǔn)確率等。
因此,更方便更易用的腳本能夠很好地提高生產(chǎn)力,特別是在有多個開發(fā)者從事同一個項目的場合下。
因此,我建議你遵循以下四條規(guī)則:
盡可能提供默認(rèn)參數(shù)值所有錯誤情況必須處理(例如,參數(shù)缺失,類型錯誤,找不到文件)所有參數(shù)和選項必須有文檔不是立即完成的任務(wù)應(yīng)當(dāng)顯示進(jìn)度條
舉個簡單的例子
我們把這些規(guī)則應(yīng)用到一個具體的例子上。這個腳本可以使用凱撒加密法加密和解密消息。
假設(shè)已經(jīng)有個寫好的 encrypt 函數(shù)(實現(xiàn)如下),我們需要創(chuàng)建一個簡單的腳本,用來加密和解密消息。我們希望讓用戶通過命令行參數(shù)選擇加密模式(默認(rèn))和解密模式,并選擇一個秘鑰(默認(rèn)為 1)。
defencrypt(plaintext, key): cyphertext = ''for character in plaintext:if character.isalpha(): number = ord(character) number += keyif character.isupper():if number > ord('Z'): number -= 26elif number < ord('A'):number += 26elif character.islower():if number > ord('z'): number -= 26elif number < ord('a'): number += 26 character = chr(number) cyphertext += characterreturn cyphertext
我們的腳本需要做的第一件事就是獲取命令行參數(shù)的值。當(dāng)我搜索“python command line arguments”時,出現(xiàn)的第一個結(jié)果是關(guān)于sys.a(chǎn)rgv的,所以我們來試試這個方法……
“初學(xué)者”的方法
sys.a(chǎn)rgv 是個列表,包含用戶在運行腳本時輸入的所有參數(shù)(包括腳本名自身)。
例如,如果我輸入:
> pythoncaesar_script.py--key 23 --decryptmysecretmessagepbvhfuhwphvvdjh
該列表將包含:
['caesar_script.py', '--key', '23', '--decrypt', 'my', 'secret', 'message']
因此只需遍歷該參數(shù)列表,找到'--key'(或'-k')以得到秘鑰值,找到'--decrypt'以設(shè)置解密模式(實際上只需要使用秘鑰的反轉(zhuǎn)作為秘鑰即可)。
最后我們的腳本大致如下:
import sysfrom caesar_encryption import encryptdefcaesar(): key = 1is_error = Falsefor index, arg in enumerate(sys.a(chǎn)rgv):if arg in ['--key', '-k'] and len(sys.a(chǎn)rgv) > index + 1: key = int(sys.a(chǎn)rgv[index + 1])del sys.a(chǎn)rgv[index]del sys.a(chǎn)rgv[index]breakfor index, arg in enumerate(sys.a(chǎn)rgv):if arg in ['--encrypt', '-e']:del sys.a(chǎn)rgv[index]breakif arg in ['--decrypt', '-d']: key = -keydel sys.a(chǎn)rgv[index]breakif len(sys.a(chǎn)rgv) == 1: is_error = Trueelse:for arg in sys.a(chǎn)rgv:if arg.startswith('-'): is_error = Trueif is_error: print(f'Usage: python {sys.a(chǎn)rgv[0]} [ --key <key> ] [ --encrypt|decrypt ] <text>')else: print(encrypt(' '.join(sys.a(chǎn)rgv[1:]), key))if __name__ == '__main__': caesar()
這個腳本遵循了一些我們前面推薦的規(guī)則:
支持默認(rèn)秘鑰和默認(rèn)模式基本的錯誤處理(沒有提供輸入文本的情況,以及提供了無法識別的參數(shù)的情況)出錯時或者不帶任何參數(shù)調(diào)用腳本時會顯示文檔:> pythoncaesar_script_using_sys_argv.pyUsage: pythoncaesar.py[ --key <key> ][ --encrypt|decrypt ] <text>
但是,這個凱撒加密法腳本太長了(39 行,其中甚至還沒包括加密代碼本身),而且很難讀懂。
解析命令行參數(shù)應(yīng)該還有更好的辦法……
試試 argparse?
argparse 是 Python 用來解析命令行參數(shù)的標(biāo)準(zhǔn)庫。
我們來看看用 argparse 怎樣編寫凱撒加密的腳本:
import argparsefrom caesar_encryption import encryptdef caesar(): parser = argparse.ArgumentParser()group = parser.a(chǎn)dd_mutually_exclusive_group()group.a(chǎn)dd_argument('-e', '--encrypt', action='store_true')group.a(chǎn)dd_argument('-d', '--decrypt', action='store_true')parser.a(chǎn)dd_argument('text', nargs='*') parser.a(chǎn)dd_argument('-k', '--key', type=int, default=1) args = parser.parse_args() text_string = ' '.join(args.text)key = args.keyif args.decrypt: key = -key cyphertext = encrypt(text_string, key) print(cyphertext)if __name__ == '__main__': caesar()
這段代碼也遵循了上述規(guī)則,而且與前面的手工編寫的腳本相比,可以提供更準(zhǔn)確的文檔,以及更具有交互性的錯誤處理:
> pythoncaesar_script_using_argparse.py--encodeMymessageusage: caesar_script_using_argparse.py[-h(huán)][-e | -d][-k KEY][text [text ...]]caesar_script_using_argparse.py: error: unrecognizedarguments: --encode> pythoncaesar_script_using_argparse.py--h(huán)elpusage: caesar_script_using_argparse.py[-h(huán)][-e | -d][-k KEY][text [text ...]]
positional arguments:textoptional arguments: -h(huán), --h(huán)elp show this help message andexit -e, --encrypt -d, --decrypt -k KEY, --keyKEY
但是,仔細(xì)看了這段代碼后,我發(fā)現(xiàn)(雖然有點主觀)函數(shù)開頭的幾行(從7行到13行)定義了參數(shù),但定義方式并不太優(yōu)雅:它太臃腫了,而且完全是程式化的。應(yīng)該有更描述性、更簡潔的方法。
click 能做得更好!
幸運的是,有個 Python 庫能提供與 argparse 同樣的功能(甚至還能提供更多),它的代碼風(fēng)格更優(yōu)雅。這個庫的名字叫 click。
這里是凱撒加密腳本的第三版,使用了 click:
import clickfrom caesar_encryption import encrypt@click.command()@click.a(chǎn)rgument('text', nargs=-1)@click.option('--decrypt/--encrypt', '-d/-e')@click.option('--key', '-k', default=1)def caesar(text, decrypt, key): text_string = ' '.join(text)if decrypt: key = -key cyphertext = encrypt(text_string, key) click.echo(cyphertext)if __name__ == '__main__':caesar()
注意現(xiàn)在參數(shù)和選項都在修飾器里定義,定義好的參數(shù)直接作為函數(shù)參數(shù)提供。
我來解釋一下上面代碼中的一些地方:
腳本參數(shù)定義中的nargs參數(shù)指定了該參數(shù)期待的單詞的數(shù)目(一個用引號括起來的字符串算一個單詞)。默認(rèn)值是1。這里nargs=-1允許接收任意數(shù)目的單詞。--encrypt/--decrypt這種寫法可以定義完全互斥的選項(類似于argparse中的add_mutually_exclusive_group函數(shù)),它將產(chǎn)生一個布爾型參數(shù)。click.echo是該庫提供的一個工具函數(shù),它的功能與print相同,但兼容Python 2和Python 3,還有一些其他功能(如處理顏色等)。
添加一些隱秘性
這個腳本的參數(shù)(被加密的消息)應(yīng)當(dāng)是最高機密。而我們卻要求用戶直接在終端里輸入文本,使得這些文本被記錄在命令歷史中,這不是很諷刺嗎?
解決方法之一就是使用隱藏的提示。或者可以從輸入文件中讀取文本,對于較長的文本來說更實際一些;蛘呖梢愿纱嘧層脩暨x擇。
輸出也一樣:用戶可以保存到文件中,也可以輸出到終端。這樣就得到了凱撒腳本的最后一個版本:
import clickfrom caesar_encryption import encrypt@click.command()@click.option('--input_file', type=click.File('r'),help='File in which there is the text you want to encrypt/decrypt.''If not provided, a prompt will allow you to type the input text.',)@click.option('--output_file', type=click.File('w'), help='File in which the encrypted / decrypted text will be written.''If not provided, the output text will just be printed.',)@click.option('--decrypt/--encrypt','-d/-e', help='Whether you want to encrypt the input text or decrypt it.')@click.option('--key','-k',default=1,help='The numeric key to use for the caesar encryption / decryption.')def caesar(input_file, output_file, decrypt, key):if input_file:text = input_file.read()else:text = click.prompt('Enter a text', hide_input=not decrypt)if decrypt:key = -key cyphertext = encrypt(text, key)if output_file:output_file.write(cyphertext)else: click.echo(cyphertext)if __name__ == '__main__': caesar()
請輸入評論內(nèi)容...
請輸入評論/評論長度6~500個字
最新活動更多
-
即日-11.13立即報名>>> 【在線會議】多物理場仿真助跑新能源汽車
-
11月28日立即報名>>> 2024工程師系列—工業(yè)電子技術(shù)在線會議
-
12月19日立即報名>> 【線下會議】OFweek 2024(第九屆)物聯(lián)網(wǎng)產(chǎn)業(yè)大會
-
即日-12.26火熱報名中>> OFweek2024中國智造CIO在線峰會
-
即日-2025.8.1立即下載>> 《2024智能制造產(chǎn)業(yè)高端化、智能化、綠色化發(fā)展藍(lán)皮書》
-
精彩回顧立即查看>> 【限時免費下載】TE暖通空調(diào)系統(tǒng)高效可靠的組件解決方案
推薦專題
- 高級軟件工程師 廣東省/深圳市
- 自動化高級工程師 廣東省/深圳市
- 光器件研發(fā)工程師 福建省/福州市
- 銷售總監(jiān)(光器件) 北京市/海淀區(qū)
- 激光器高級銷售經(jīng)理 上海市/虹口區(qū)
- 光器件物理工程師 北京市/海淀區(qū)
- 激光研發(fā)工程師 北京市/昌平區(qū)
- 技術(shù)專家 廣東省/江門市
- 封裝工程師 北京市/海淀區(qū)
- 結(jié)構(gòu)工程師 廣東省/深圳市