1. 用argparse模塊決議命令列選項
我們在上一篇博客《Linux：可執行程式的Shell傳參格式規范》中介紹了Linux系統Shell命令列下可執行程式應該遵守的傳參規范（包括了各種選項及其引數），Python命令列程式做為其中一種，其傳參中也包括了位置引數（positional arguments）和可選引數（optional arguments）：
(注意，可選引數的選項名稱以--或-打頭，位置引數和可選引數的先后順序可以任意排布)
那么在Python程式中我們如何決議在命令列中提供的各種選項呢？（選項保存在sys.argv中）我們可以使用argparse模塊，我們用下面這個search.py程式做例子：
1.1 創建parser物件
首先我們需要創建parser物件：
import argparse
parser = argparse.ArgumentParser(description="search some files")
1.2 添加選項宣告
然后使用parser.add_argument()方法添加想要支持的選項宣告，add_argument()的呼叫引數承擔了不同的功能:
dest指定了用來保存決議結果的屬性名稱，metavar用于顯示幫助資訊，如果不指定則默認為大寫的屬性名，action指定了與引數處理相關的行為（store表示存盤單個值，append表示將多個值存到一個串列中），
我們嘗試依次添加如下選項宣告進行測驗：
決議位置引數
parser.add_argument(dest="filenames", metavar="filename", nargs="*")
該引數為位置引數，不需要像可選引數的選項一樣用-或--打頭，位置引數一般是必須要提供的（雖然這里你不提供也能保存為[]），nargs="*"表示將所有額外命令列引數保存在一個串列中，
決議可選引數
parser.add_argument("-p", "--pat", metavar="pattern", required=True, dest="patterns", action="append", help="text pattern to search for")
-p和--pat兩種選項名稱都可接收（前者是簡寫，后者是全稱），我們在上一篇博客說過，在呼叫Shell命令時規定對于簡寫的選項名用-p ××形式傳參，對于全稱的選項名我們有--pat ××和--pat=××兩種形式，不過Python腳本時你用-p=××也能決議，不過一般不建議這樣搞，action="append"意為允許命令列引數重復多次，將所有引數值保存在串列中，require=True意味著引數必須要提供一次，
parser.add_argument("-v", dest="verbose", action="store_true", help="verbose mode")
store_true意思為設定為一個布爾標記，標記的值取決于引數是否有提供，
parser.add_argument("-o", dest="outfile", action="store", help="output file")
類似上面，這里store意思為接收一個單獨的值并保存為字串
parser.add_argument("--speed", dest="speed", action="store", choices={"slow", "fast"}, default="slow", help="search speed")
同上，該引數也是接受一個值，但只能在特定范圍中{"slow", "fast"}中選擇，且默認"slow""，
1.2 決議選項
然后我們就可以決議選項并使用傳入的引數了：
args = parser.parse_args()
# 注意在使用引數時，是用的引數的dest名字
print(args.filenames)
print(args.patterns)
print(args.verbose)
print(args.outfile)
print(args.speed)
2. 測驗
以上的程式定義了一個命令決議器，我們可以設定-h選項查看其用法：
(base) orion-orion@MacBook-Pro Python-Lang % python search.py -h
usage: search.py [-h] -p pattern [-v] [-o OUTFILE] [--speed {slow,fast}] [filename ...]
search some files
positional arguments:
filename
optional arguments:
-h, --help show this help message and exit
-p pattern, --pat pattern
text pattern to search for
-v verbose mode
-o OUTFILE output file
--speed {slow,fast} search speed
接下來我們展示資料在程式中的顯示方式，比如我們嘗試不傳入必需的-p/--pat選項引數：
(base) orion-orion@MacBook-Pro Python-Lang % python search.py foo.txt bar.txt
usage: search.py [-h] -p pattern [-v] [-o OUTFILE] [--speed {slow,fast}] [filename ...]
search.py: error: the following arguments are required: -p/--pat
如上所示，解釋器會提醒我們引數沒傳入，我們注意到usage中-p pattern并沒有加方括號[]，說明該引數不是可選的，必須要提供，
接下來我們提供完整引數，大家可以仔細觀察print()陳述句的輸出：
(base) orion-orion@MacBook-Pro Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
None
slow
可以看到如上所示，因為提供了引數-v，故args.verbose為True，因為沒提供-o ×××引數，故args.outfile為None，
(base) orion-orion@MacBook-Pro Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt -o results
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
results
slow
可以看到如上所示，設定了提供了-o results，故args.outfile列印結果為results，
(base) orion-orion@MacBook-Pro Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt -o results --speed=fast
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
results
fast
如上所示為提供了可選引數--speed的情況，
3. 討論
一旦選項給出后，我們只需要簡單地執行parser.parse()方法，這么做會處理sys.argv的值，并回傳結果實體，如果我們手動處理sys.argv或者使用getopt模塊（仿照類似的C庫打造），就會重復撰寫許多argparse已經提供的代碼，因此在新專案中應該優先選擇argparse，
參考
- [1] Martelli A, Ravenscroft A, Ascher D. Python cookbook[M]. " O'Reilly Media, Inc.", 2015.
- [2] https://docs.python.org/3/howto/argparse.html#id1
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/479221.html
標籤：Python