argparse 是 Python 內(nèi)置的一個(gè)用于命令項(xiàng)選項(xiàng)與參數(shù)解析的模塊,通過在程序中定義好我們需要的參數(shù),argparse 將會(huì)從 sys.argv 中解析出這些參數(shù),并自動(dòng)生成幫助和使用信息。當(dāng)然,Python 也有第三方的庫可用于命令行解析,而且功能也更加強(qiáng)大,比如 docopt,Click。
我們先來看一個(gè)簡單示例。主要有三個(gè)步驟:
# -*- 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
,在終端運(yùn)行,結(jié)果如下:
$ 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
上面的示例,其實(shí)就展示了定位參數(shù)的使用,我們再來看一個(gè)例子 - 計(jì)算一個(gè)數(shù)的平方:
# -*- 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 args.square**2
將上面的代碼保存為文件 argparse_usage.py
,在終端運(yùn)行,結(jié)果如下:
$ python argparse_usage.py 9
81
現(xiàn)在看下可選參數(shù)的用法,所謂可選參數(shù),也就是命令行參數(shù)是可選的,廢話少說,看下面例子:
# -*- 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
,在終端運(yùn)行,結(jié)果如下:
$ 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 # 沒有輸出
定位參數(shù)和選項(xiàng)參數(shù)可以混合使用,看下面一個(gè)例子,給一個(gè)整數(shù)序列,輸出它們的和或最大值(默認(rèn)):
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)
結(jié)果:
$ 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() 方法定義如何解析命令行參數(shù):
ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
每個(gè)參數(shù)解釋如下:
argparse.SUPPRESS
時(shí)表示不顯示該參數(shù)的幫助信息.