[Python]参数解析argparse简介

通过argparse模块，可方便解析 sys.argv中定义的参数，从而轻松编写用户友好的命令行界面。

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-f', '--file', help='PDF-file to convert')
    parser.add_argument('-p', '--ppt', help='PPT-file convert to')

    args = parser.parse_args()
    pdf = args.file
    if pdf is None:
        parser.print_help()
        exit(1)

    if not os.path.exists(pdf):
        print("File: {} not exists".format(pdf))

参数解析

通过argparse进行参数解析，需要以下几个步骤：

• 导入模块：import argparse
• 获取解析器对象：argparse.ArgumentParser
• 添加参数解析规则：add_argument
• 获取解析结果对象：parse_args
• 从解析结果对象中获取参数值

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('-o', '--out', action='store_true')	// 对应参数有时为True，否则为False
parser.add_argument('--data', required=True, dest='path') // data为必传参数
parser.add_argument('--seed', type=int)

args = parser.parse_args()
print('out:', args.out, type(args.out))
print('path:', args.path, type(args.path))
print('seed:', args.seed, type(args.seed))

bool类型参数，action要设为store_true或store_false：

• python main.py -o args.out为True
• python main.py args.out为False

解析器

通过ArgumentParser()函数的调用可获取了解析器对象ArgumentParser，解析器说明：

名字	默认值	功能
prog	sys.argv[0]	-h时显示的程序名
usage	-	usage字段描述
description	None	description字段描述
formatter_class	None	定制说明文本的显示风格
prefix_class	-	定制前缀字符，例如前缀**“-b"改为“+b”**
add_help	True	是否使能显示参数 -h --help
allow_abbrev	True	是否支持长参数

添加规则

通过解析器的add_argument可方便添加解析规则：

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

关键字	简介
name or flags	参数名或者"-/–"开头的选项，例如foo或者-f, --foo
action	匹配到选项后的行为
nargs	选项跟随的参数个数
const	在某些action和nargs下，使用的固定值
default	默认值，默认为None； nargs为?或者*时，命令行没有对应参数时，使用此默认值； 若default=argparse.SUPPRESS命令行没对应参数时，不会添加对象到解析结果中；
type	参数类型；默认为字符串str
choices	可选的参数值范围
required	是否为必选项
help	参数描述
metavar	使用说明中显示选项对应的值示例
dest	选项最终在解析结果对象中的属性名（必须是合法的变量标识），不设定，则使用选项本身： flags模式时，会去掉前缀-（且优先使用长参数）； 若选项中间有-符号，会替换为_；

name or flags：

• 不以"-/–"开始的为位置参数，必须赋值；其顺序与add添加的顺序相同；
• 以"-/–"开始的为选项参数；
  • -标识短参数；
  • --标识长参数；
  • 可只给出一种，也可两种同时给出；
• 没有dest时，对应解析的属性名为name或去掉前缀的flags

action参数

参数action用于控制命令行选项的行为

值	含义
store	保存参数值（默认）
store_const	与const配合使用；有对应选项时，赋值const值给选项；且此时不能有type参数
store_true	保存值为True；对应选项有时为True，否则为False
store_false	保存值为False；对应选项有时为False，否则为True
append	追加选项值到列表中；允许选项出现多次
append_const	与const配合使用，追加const的值到列表中
count	把选项出现的次数赋值给对应选项
help	效果等效于-h和 --help
version	打印版本

append参数：

parser = argparse.ArgumentParser()
parser.add_argument('-a', '-append', action='append', dest='files')
parser.add_argument('-A', '--add', action='append_const', const='Add-param', dest='dirs')

args = parser.parse_args()

print('files:', args.files)
print('dirs:', args.dirs)

// python .\main.py -a f1 -a f2 -A -A
files: ['f1', 'f2']
dirs: ['Add-param', 'Add-param']

store_const参数：

parser = argparse.ArgumentParser()
parser.add_argument('--seed', const=12, action='store_const')

args = parser.parse_args()

print('seed:', args.seed, type(args.seed))

//  python .\main.py --seed
seed: 12 <class 'int'>

nargs参数

nargs参数是number argumemts的缩写，表示选项有多少个参数

值	含义
N (an integer)	收集N个参数到列表
‘?’	无参数或单个参数
‘*’	大于等于0个参数
‘+’	大于等于1个参数
argparse.REMAINDER	只收集不解析

没有指定时，其取值取决于参数action：

• action = "store"时，默认获取1个参数；
• action = "store_true"/"store_false"时，选项不需要带参数。

choice参数

choices限定了参数值的可选列表，如果命令行提供的参数值不在列表中，则会报错；而且choice中的元素类型，需要与type对应。

parser = argparse.ArgumentParser()
parser.add_argument('--move', choices=['rock', 'paper', 'scissors'])

args = parser.parse_args()

print('move:', args.move)

//  python .\main.py --move rock
move: rock

示例

常用参数选项示例：

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--out', action='store_true')
    parser.add_argument('--revout', action='store_false')
    parser.add_argument('--data', required=True, dest='path')
    parser.add_argument('--seed', const=12, action='store_const')
    parser.add_argument('-v', type=str, help="add verb")

    parser.add_argument('-a', '--append-files', action='append')
    parser.add_argument('-A', '--add', action='append_const', const='Add-param', dest='file_const')

    parser.add_argument('--move', choices=['rock', 'paper', 'scissors'])

    args = parser.parse_args()

    print('append-files:', args.append_files)
    print('file-const:', args.file_const)

    print('move:', args.move)

    print('out:', args.out, type(args.out))
    print('revout:', args.revout)
    print("verb:", args.v, type(args.v))
    print('seed:', args.seed, type(args.seed))
    
// python .\main.py  -v sd --data pdata -a f1 -a f2 -AAA --seed
append-files: ['f1', 'f2']
file-const: ['Add-param', 'Add-param', 'Add-param']
move: None
out: False <class 'bool'>
revout: True
verb: sd <class 'str'>
seed: 12 <class 'int'>