我們在寫python指令碼的時候，有時候需要在執行的時候傳入引數，而不是寫死在程式裡，這個時候就要用到argparse模組。argparse 是 Python 內建的一個用於命令項選項與引數解析的模組，通過在程式中定義好我們需要的引數，argparse 將會從sys.argv 中解析出這些引數，並自動生成幫助和使用資訊。

1 使用步驟

該模組使用主要分三步：

• 建立 ArgumentParser() 物件
• 呼叫 add_argument() 方法新增引數
• 使用 parse_args() 解析新增的引數

2 定位引數

根據以上步驟簡單示例如下

# -*- coding: utf-8 -*-

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('integer', type=int, help='display an integer')
args = parser.parse_args()

print('the parameter is: ',args.integer)
 

將上面的程式碼儲存為檔案 argtest.py，在終端執行，結果如下：

usage: argtest.py [-h] integer
argtest.py: error: too few arguments

原因是沒有給定位引數integer傳遞int型別的值，重新執行 python argtest.py 666，則輸出如下

the parameter is:  666

3 可選引數

剛才介紹的引數是定位引數，是在執行中必須輸入的引數。該模組還有一種叫可選引數，可以設定預設值，使用方法如下

# -*- coding: utf-8 -*-
import argparse
parser = argparse.ArgumentParser()
#parser.add_argument('integer', type=int, help='display an integer')
parser.add_argument('--gpu',help='GPU device id to use [0]',default=0, type=int) 
args = parser.parse_args()
print('the parameter is: ',args)
 

執行不同的指令效果如下

$ python3 argtest.py 
the parameter is:  Namespace(gpu=0)
$ python3 argtest.py -h
usage: argtest.py [-h] [--gpu GPU]

optional arguments:
  -h, --help  show this help message and exit
  --gpu GPU   GPU device id to use [0]
$ python3 argtest.py --gpu 1
the parameter is:  Namespace(gpu=1)

 

4 引數含義

在上邊的方法中，我們呼叫了add_argument函式進行設定，該函式的原型是：

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

每個引數的含義如下

• name or flags - 選項字串的名字或者列表，例如 foo 或者 -f, --foo。
• action - 命令列遇到引數時的動作，預設值是 store。
  • store_const，表示賦值為const；
  • append，將遇到的值儲存成列表，也就是如果引數重複則會儲存多個值;
  • append_const，將引數規範中定義的一個值儲存到一個列表；
  • count，儲存遇到的次數；此外，也可以繼承 argparse.Action 自定義引數解析；
• nargs - 應該讀取的命令列引數個數，可以是具體的數字，或者是?號，當不指定值時對於 Positional argument 使用 default，對於 Optional argument 使用 const；或者是 * 號，表示 0 或多個引數；或者是 + 號表示 1 或多個引數。
• const - action 和 nargs 所需要的常量值。
• default - 不指定引數時的預設值。
• type - 命令列引數應該被轉換成的型別。
• choices - 引數可允許的值的一個容器。
• required - 可選引數是否可以省略 (僅針對可選引數)。
• help - 引數的幫助資訊，當指定為 argparse.SUPPRESS 時表示不顯示該引數的幫助資訊.
• metavar - 在 usage 說明中的引數名稱，對於必選引數預設就是引數名稱，對於可選引數預設是全大寫的引數名稱.
• dest - 解析後的引數名稱，預設情況下，對於可選引數選取最長的名稱，中劃線轉換為下劃線.