python中parse.add_argument()简单用法

argparse 模块是 Python 内置的一个用于命令项选项与参数解析的模块。
下面以例子来简单记下模块使用流程。

1.导入模块

import argparse

2.创建解析器

该解析器将命令行解析成python数据类型所需要的全部信息。

parser = argparse.ArgumentParser(description='test') #description是对程序功能的描述

3.添加参数

为程序设置参数信息，指定解析器如何获取命令行字符串并将其转换为对象。

parser.add_argument('--x', type=int, default=10, help='Random seed.') #x为参数,type为参数类型
parser.add_argument('--y', type=int, default=20, help='Random seed.') #default为默认值,help为该参数的描述信息(在代码中无实际用处)

4.解析参数

args = parser.parse_args()

5使用参数

#事先定义了一个对x,y求和的函数
print(sum(args.x,args.y)) #结果为30,需要用args.来使用参数

完整代码

import argparse 

#定义一个求和函数
def sum(x,y):
    return x+y

#创建解析器
parser = argparse.ArgumentParser(description='test')
#添加参数
parser.add_argument('--x', type=int, default=10, help='Random seed.')
parser.add_argument('--y', type=int, default=20, help='Random seed.')
#解析参数
args = parser.parse_args()
#使用参数
print(sum(args.x,args.y)) #结果：30

与命令行的交互

可以通过命令行修改参数的默认值。
用上面的求和函数举例，例如在命令行输入：

python sum.py --x 30 --y 40

将x,y的参数值分别修改为30,40，并且运行程序，输出：

70

另外可以通过python sum.py -h查看帮助文档。

参考博客python之parser.add_argument()用法——命令行选项、参数和子命令解析器，更多详细参数可以看这个博客。