Argparse(Argument Parser)的作用:就是为py文件封装好可以选择的参数,使他们更加灵活,丰富。可以在python的终端中直接运行.py然后提示输入参数等信息。
看一个简单例子,实现输入int型参数返回+1值:
import argparse # 导入命令行解析的库文件
# 创建解析器
parse = argparse.ArgumentParser(prog='文件名use_argparse.py', usage='描述用途,输入一个整数,+1返回',
description="help前信息", epilog='help后信息')
# 添加参数
parse.add_argument('xx',type=int, help='这是关于输入参数xx的帮助信息,xx为整型数据')
# 解析参数
args = parse.parse_args()
print(args.xx + 1)
如何运行,检查程序是否正确,一般需要外部终端命令行来进行,使用方法如下:
- 在命令行中切换到此.py文件所在路径
- 调用此.py文件
IN: python use_argparse.py -h
OUT: usage: 描述用途,输入一个整数,+1返回
help前信息
positional arguments:
xx 这是关于输入参数xx的帮助信息,xx为整型数据
optional arguments:
-h, --help show this help message and exit
help后信息
IN: python use_argparse.py 3
OUT: 4
上面用到的是参数是positional arguments,这个参数必须输入。
可选择的参数:
尽管设置了很多参数可以使用,但可以选择需要的参数optional arguments,添加参数时加上‘-’或‘–’表示可选参数。
import argparse # 导入命令行解析的库文件
# 创建解析器
parse = argparse.ArgumentParser(prog='文件名use_argparse.py', usage='描述用途,输入一个整数xx,+1返回;输入一个整数yy,-1返回,',
description="help前信息", epilog='help后信息')
# 添加参数
parse.add_argument('--xx',type=int, help='这是关于输入参数xx的帮助信息,xx为整型数据')
parse.add_argument('--yy',type=int, help='这是关于输入参数yy的帮助信息,yy为整型数据')
# 解析参数
args = parse.parse_args()
if args.xx:
print(args.xx + 1)
if args.yy:
print(args.yy - 1)
IN: python use_argparse.py -h
OUT: usage: 描述用途,输入一个整数xx,+1返回;输入一个整数yy,-1返回,
help前信息
optional arguments:
-h, --help show this help message and exit
--xx XX 这是关于输入参数xx的帮助信息,xx为整型数据
--yy YY 这是关于输入参数yy的帮助信息,yy为整型数据
help后信息