argsparse是python的命令行解析的标准模块,内置于python(2.7之后),不需要安装。这个库可以让我们直接在命令行中就可以向程序中传入参数并让程序运行。
其核心是通过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 - 当参数在命令行中出现时使用的动作基本类型。
nargs - 命令行参数值的数量,*
代表零个或多个,+
代表一个或多个,?
表示零个ho。
const - 被一些 action 和 nargs 选择所需求的常数。
default - 当参数未在命令行中出现并且也不存在于命名空间对象时所产生的值。
type - 命令行参数应当被转换成的类型。
choices - 可用的参数的容器。
required - 此命令行选项是否可省略 (仅选项可用)。
help - 一个此选项作用的简单描述。
metavar - 在使用方法消息中使用的参数值示例。
dest - 被添加到 parse_args() 所返回对象上的属性名。
参数解析器,类原型
class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)
prog - The name of the program (default: os.path.basename(sys.argv[0]))
usage - 描述程序用途的字符串(默认值:从添加到解析器的参数生成)
description - 在参数帮助文档之前显示的文本(默认值:无)
epilog - 在参数帮助文档之后显示的文本(默认值:无)
parents - 一个 ArgumentParser 对象的列表,它们的参数也应包含在内
formatter_class - 用于自定义帮助文档输出格式的类
prefix_chars - 可选参数的前缀字符集合(默认值: '-')
fromfile_prefix_chars - 当需要从文件中读取其他参数时,用于标识文件名的前缀字符集合(默认值: None)
argument_default - 参数的全局默认值(默认值: None)
conflict_handler - 解决冲突选项的策略(通常是不必要的)
add_help - 为解析器添加一个 -h/--help 选项(默认值: True)
allow_abbrev - 如果缩写是无歧义的,则允许缩写长选项 (默认值:True)
exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: True)
import argparse
#创建解析器
parser = argparse.ArgumentParser(description='学生信息记录')
#添加参数
#指定位置参数,是必填的
parser.add_argument('id')
#指定-n/--name参数,是必填的
parser.add_argument('-n','--name',help='姓名',required=True)
#指定-a/--age参数,可选值为10-18
parser.add_argument('-a','--age',type=int,choices=range(10,19),help='年龄')
#指定-s/-sex参数,可选值:男、女
parser.add_argument('-s','--sex',choices={'男','女'},help='性别')
#解析参数,返回一个类似字典的对象
args = parser.parse_args()
print(args)
print('学号:%s,姓名:%s,年龄:%s,性别:%s' % (args.id,args.name,args.age,args.sex))
查看帮助信息
python .\test.py -h
-------->>
usage: test.py [-h] -n NAME [-a {10,11,12,13,14,15,16,17,18}] [-s {男,女}] id
学生信息记录
positional arguments:
id
optional arguments:
-h, --help show this help message and exit
-n NAME, --name NAME 姓名
-a {10,11,12,13,14,15,16,17,18}, --age {10,11,12,13,14,15,16,17,18} 年龄
-s {男,女}, --sex {男,女} 性别
传参测试
python .\test.py 199766 -n lucy -a 18 -s 女
-------->>
Namespace(age=18, id='199766', name='lucy', sex='女')
学号:199766,姓名:lucy,年龄:18,性别:女