以下內容主要來自：http://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html

argparse 使用

簡單示例

我們先來看一個簡單示例。主要有三個步驟：

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

示例：

# -*- coding: utf-8 -*-
 
import argparse
 
parser = argparse.ArgumentParser()
parser.add_argument(
 
'integer', type=int, help='display an integer')
args = parser.parse_args()
 
print(args.integer)

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

$ python argparse_usage.py
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: too few arguments
 
$ python argparse_usage.py abcd
usage: argparse_usage.py [
 
-h] integer
argparse_usage.py: error: argument integer: invalid int value: 'abcd'
 
$ python argparse_usage.py -h
usage: argparse_usage.py [-h] integer
 
positional arguments:
  integer     display an integer
 
optional arguments:
  -h, --help  show this help message and exit
 
$ python argparse_usage.py 
 
10
10

定位引數

上面的示例，其實就展示了定位引數的使用，我們再來看一個例子 - 計算一個數的平方：

# -*- coding: utf-8 -*-
 
import argparse
 
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number", type=int)
args = parser.parse_args()
print(rgs.square**2)

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

$ python argparse_usage.py 9
81

可選引數

現在看下可選引數的用法，所謂可選引數，也就是命令列引數是可選的，廢話少說，看下面例子：

# -*- coding: utf-8 -*-
 
import argparse
 
parser = argparse.ArgumentParser()
 
parser.add_argument("--square", help="display a square of a given number", type=int)
parser.add_argument("--cubic", help="display a cubic of a given number", type=int)
 
args = parser.parse_args()
 
if args.square:
    print(args.square**2)
 
if args.cubic:
    print(args.cubic**3)

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

$ python argparse_usage.py --h
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
 
optional arguments:
  -h, --help       show this help message and exit
  --square SQUARE  display a square of a given number
  --cubic CUBIC    display a cubic of a given number
 
$ python argparse_usage.py --square 8
64
 
$ python argparse_usage.py --cubic 8
512
 
$ python argparse_usage.py 8
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
argparse_usage.py: error: unrecognized arguments: 8
 
$ python argparse_usage.py  # 沒有輸出

混合使用

定位引數和選項引數可以混合使用，看下面一個例子，給一個整數序列，輸出它們的和或最大值（預設）：


import argparse
 
parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                   help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                   const=sum, default=max,
                   help='sum the integers (default: find the max)')
 
args = parser.parse_args()
print(args.accumulate(args.integers))

結果：

$ python argparse_usage.py
usage: argparse_usage.py [-h] [--sum] N [N ...]
argparse_usage.py: error: too few arguments
$ python argparse_usage.py 1 2 3 4
4
$ python argparse_usage.py 1 2 3 4 --sum
10

add_argument() 方法

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 - 解析後的引數名稱，預設情況下，對於可選引數選取最長的名稱，中劃線轉換為下劃線.