這篇文章將教你如何編寫(xiě)完美的 Python 命令行程序，提高團(tuán)隊(duì)的生產(chǎn)力，讓大家的工作更舒適。

　　作為 Python 開(kāi)發(fā)者，我們經(jīng)常要編寫(xiě)命令行程序。比如在我的數(shù)據(jù)科學(xué)項(xiàng)目中，我要從命令行運(yùn)行腳本來(lái)訓(xùn)練模型，以及計(jì)算算法的準(zhǔn)確率等。

　　因此，更方便更易用的腳本能夠很好地提高生產(chǎn)力，特別是在有多個(gè)開(kāi)發(fā)者從事同一個(gè)項(xiàng)目的場(chǎng)合下。

　　因此，我建議你遵循以下四條規(guī)則：

　　盡可能提供默認(rèn)參數(shù)值

　　所有錯(cuò)誤情況必須處理(例如，參數(shù)缺失，類型錯(cuò)誤，找不到文件)

　　所有參數(shù)和選項(xiàng)必須有文檔

　　不是立即完成的任務(wù)應(yīng)當(dāng)顯示進(jìn)度條

　　舉個(gè)簡(jiǎn)單的例子

　　我們把這些規(guī)則應(yīng)用到一個(gè)具體的例子上。這個(gè)腳本可以使用凱撒加密法加密和解密消息。

　　假設(shè)已經(jīng)有個(gè)寫(xiě)好的 encrypt 函數(shù)(實(shí)現(xiàn)如下)，我們需要?jiǎng)?chuàng)建一個(gè)簡(jiǎn)單的腳本，用來(lái)加密和解密消息。我們希望讓用戶通過(guò)命令行參數(shù)選擇加密模式(默認(rèn))和解密模式，并選擇一個(gè)秘鑰(默認(rèn)為 1)。

　　def encrypt(plaintext, key):

　　cyphertext = ''

　　for character in plaintext:

　　if character.isalpha():

　　number = ord(character)

　　number += key

　　if character.isupper():

　　if number > ord('Z'):

　　number -= 26

　　elif number < ord('A'):

　　number += 26

　　elif character.islower():

　　if number > ord('z'):

　　number -= 26

　　elif number < ord('a'):

　　number += 26

　　character = chr(number)

　　cyphertext += character

　　return cyphertext

　　我們的腳本需要做的第一件事就是獲取命令行參數(shù)的值。當(dāng)我搜索“python command line arguments”時(shí)，出現(xiàn)的第一個(gè)結(jié)果是關(guān)于sys.argv的，所以我們來(lái)試試這個(gè)方法……

　　“初學(xué)者”的方法

　　sys.argv 是個(gè)列表，包含用戶在運(yùn)行腳本時(shí)輸入的所有參數(shù)(包括腳本名自身)。

　　例如，如果我輸入：

　　> python caesar_script.py --key 23 --decrypt my secret message

　　pb vhfuhw phvvdjh

　　該列表將包含：

　　['caesar_script.py', '--key', '23', '--decrypt', 'my', 'secret', 'message']

　　因此只需遍歷該參數(shù)列表，找到'--key'(或'-k')以得到秘鑰值，找到'--decrypt'以設(shè)置解密模式(實(shí)際上只需要使用秘鑰的反轉(zhuǎn)作為秘鑰即可)。

　　最后我們的腳本大致如下：

　　import sys

　　from caesar_encryption import encrypt

　　def caesar():

　　key = 1

　　is_error = False

　　for index, arg in enumerate(sys.argv):

　　if arg in ['--key', '-k'] and len(sys.argv) > index + 1:

　　key = int(sys.argv[index + 1])

　　del sys.argv[index]

　　del sys.argv[index]

　　break

　　for index, arg in enumerate(sys.argv):

　　if arg in ['--encrypt', '-e']:

　　del sys.argv[index]

　　break

　　if arg in ['--decrypt', '-d']:

　　key = -key

　　del sys.argv[index]

　　break

　　if len(sys.argv) == 1:

　　is_error = True

　　else:

　　for arg in sys.argv:

　　if arg.startswith('-'):

　　is_error = True

　　if is_error:

　　print(f'Usage: python {sys.argv[0]} [ --key] [ --encrypt|decrypt ]')

　　else:

　　print(encrypt(' '.join(sys.argv[1:]), key))

　　if __name__ == '__main__':

　　caesar()

　　這個(gè)腳本遵循了一些我們前面推薦的規(guī)則：

　　支持默認(rèn)秘鑰和默認(rèn)模式

　　基本的錯(cuò)誤處理(沒(méi)有提供輸入文本的情況，以及提供了無(wú)法識(shí)別的參數(shù)的情況)

　　出錯(cuò)時(shí)或者不帶任何參數(shù)調(diào)用腳本時(shí)會(huì)顯示文檔：

　　> python caesar_script_using_sys_argv.py

　　Usage: python caesar.py [ --key] [ --encrypt|decrypt ]

　　但是，這個(gè)凱撒加密法腳本太長(zhǎng)了(39 行，其中甚至還沒(méi)包括加密代碼本身)，而且很難讀懂。

　　解析命令行參數(shù)應(yīng)該還有更好的辦法……

　　試試 argparse?

　　argparse 是 Python 用來(lái)解析命令行參數(shù)的標(biāo)準(zhǔn)庫(kù)。

　　我們來(lái)看看用 argparse 怎樣編寫(xiě)凱撒加密的腳本：

　　import argparse

　　from caesar_encryption import encrypt

　　def caesar():

　　parser = argparse.ArgumentParser()

　　group = parser.add_mutually_exclusive_group()

　　group.add_argument('-e', '--encrypt', action='store_true')

　　group.add_argument('-d', '--decrypt', action='store_true')

　　parser.add_argument('text', nargs='*')

　　parser.add_argument('-k', '--key', type=int, default=1)

　　args = parser.parse_args()

　　text_string = ' '.join(args.text)

　　key = args.key

　　if args.decrypt:

　　key = -key

　　cyphertext = encrypt(text_string, key)

　　print(cyphertext)

　　if __name__ == '__main__':

　　caesar()

　　這段代碼也遵循了上述規(guī)則，而且與前面的手工編寫(xiě)的腳本相比，可以提供更準(zhǔn)確的文檔，以及更具有交互性的錯(cuò)誤處理：

　　> python caesar_script_using_argparse.py --encode My message

　　usage: caesar_script_using_argparse.py [-h] [-e | -d] [-k KEY] [text [text ...]]

　　caesar_script_using_argparse.py: error: unrecognized arguments: --encode

　　> python caesar_script_using_argparse.py --help

　　usage: caesar_script_using_argparse.py [-h] [-e | -d] [-k KEY] [text [text ...]]

　　positional arguments:

　　text

　　optional arguments:

　　-h, --help show this help message and exit

　　-e, --encrypt

　　-d, --decrypt

　　-k KEY, --key KEY

　　但是，仔細(xì)看了這段代碼后，我發(fā)現(xiàn)(雖然有點(diǎn)主觀)函數(shù)開(kāi)頭的幾行(從7行到13行)定義了參數(shù)，但定義方式并不太優(yōu)雅：它太臃腫了，而且完全是程式化的。應(yīng)該有更描述性、更簡(jiǎn)潔的方法。

　　click 能做得更好!

　　幸運(yùn)的是，有個(gè) Python 庫(kù)能提供與 argparse 同樣的功能(甚至還能提供更多)，它的代碼風(fēng)格更優(yōu)雅。這個(gè)庫(kù)的名字叫 click。

　　這里是凱撒加密腳本的第三版，使用了 click：

　　import click

　　from caesar_encryption import encrypt

　　@click.command()

　　@click.argument('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ù)和選項(xiàng)都在修飾器里定義，定義好的參數(shù)直接作為函數(shù)參數(shù)提供。

　　我來(lái)解釋一下上面代碼中的一些地方：

　　●腳本參數(shù)定義中的nargs參數(shù)指定了該參數(shù)期待的單詞的數(shù)目(一個(gè)用引號(hào)括起來(lái)的字符串算一個(gè)單詞)。默認(rèn)值是1。這里nargs=-1允許接收任意數(shù)目的單詞。

　　●--encrypt/--decrypt這種寫(xiě)法可以定義完全互斥的選項(xiàng)(類似于argparse中的add_mutually_exclusive_group函數(shù))，它將產(chǎn)生一個(gè)布爾型參數(shù)。

　　●click.echo是該庫(kù)提供的一個(gè)工具函數(shù)，它的功能與print相同，但兼容Python 2和Python 3，還有一些其他功能(如處理顏色等)。

　　添加一些隱秘性

　　這個(gè)腳本的參數(shù)(被加密的消息)應(yīng)當(dāng)是最高機(jī)密。而我們卻要求用戶直接在終端里輸入文本，使得這些文本被記錄在命令歷史中，這不是很諷刺嗎?

　　解決方法之一就是使用隱藏的提示?；蛘呖梢詮妮斎胛募凶x取文本，對(duì)于較長(zhǎng)的文本來(lái)說(shuō)更實(shí)際一些。或者可以干脆讓用戶選擇。

　　輸出也一樣：用戶可以保存到文件中，也可以輸出到終端。這樣就得到了凱撒腳本的最后一個(gè)版本：

　　import click

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

　　這個(gè)版本有什么新東西嗎?

　　首先，注意到我給每個(gè)參數(shù)選項(xiàng)都加了個(gè)help參數(shù)。由于腳本變得復(fù)雜了，help參數(shù)可以給腳本的行為添加一些文檔。運(yùn)行結(jié)果如下：

　　> python caesar_script_v2.py --help

　　Usage: caesar_script_v2.py [OPTIONS]

　　Options:

　　--input_file FILENAME 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.

　　--output_file FILENAME File in which the encrypted/decrypted text will be written. If not provided, the output text will just be printed.

　　-d, --decrypt / -e, --encrypt Whether you want to encrypt the input text or decrypt it.

　　-k, --key INTEGER The numeric key to use for the caesar encryption / decryption.

　　--help Show this message and exit.

　　兩個(gè)新的參數(shù)：input_file 和 output_file，類型均為 click.File。該庫(kù)能夠用正確的模式打開(kāi)文件，處理可能的錯(cuò)誤，再執(zhí)行函數(shù)。例如：

　　> python caesar_script_v2.py --decrypt --input_file wrong_file.txt

　　Usage: caesar_script_v2.py [OPTIONS]

　　Error: Invalid value for "--input_file": Could not open file: wrong_file.txt: No such file or directory

　　正像help文本中解釋的那樣，如果沒(méi)有提供input_file，就使用click.promp讓用戶直接在提示符下輸入文本，在加密模式下這些文本是隱藏的。如下所示：

　　> python caesar_script_v2.py --encrypt --key 2

　　Enter a text: **************

　　yyy.ukectc.eqo