argparse 使用
簡單示例
我們先來看一個簡單示例。主要有三個步驟：
- 創建 ArgumentParser() 對象
- 調用 add_argument() 方法添加參數
- 使用 parse_args() 解析添加的參數
示例：
|
1
2
3
4
5
6
7
8
9
|
# -*- 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，在終端運行，結果如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
$ 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
|
定位參數
上面的示例，其實就展示了定位參數的使用，我們再來看一個例子 - 計算一個數的平方：
|
1
2
3
4
5
6
7
8
|
# -*- 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，在終端運行，結果如下：
|
1
2
|
$ python argparse_usage.py 9
81
|
可選參數
現在看下可選參數的用法，所謂可選參數，也就是命令行參數是可選的，廢話少說，看下面例子：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
# -*- 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，在終端運行，結果如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
$ 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 # 沒有輸出
|
混合使用
定位參數和選項參數可以混合使用，看下面一個例子，給一個整數序列，輸出它們的和或最大值（默認）：
|
1
2
3
4
5
6
7
8
9
10
11
|
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))
|
結果：
|
1
2
3
4
5
6
7
|
$ 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() 方法定義如何解析命令行參數：
|
1
|
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 - 解析後的參數名稱，默認情況下，對於可選參數選取最長的名稱，中劃線轉換爲下劃線.
