Python技法：用argparse模塊解析命令行選項

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。

參考

Tags:

VirMach 便宜 VPS

QNews

QNews