Python argparse的简单demo测试与使用说明
- 1. Python argparse是啥?
- 2. demo说明
- 2.1 程序主体结构
- 2.2 demo说明
1. Python argparse是啥?
- argparse是python用于解析命令行参数的标准模块。
- 我们很多时候,需要用到解析命令行参数的程序,例如在终端窗口输入(深度学习)训练的参数和选项。
2. demo说明
2.1 程序主体结构
argparse的使用一般可分为以下四个小步骤:
- import argparse ;首先导入该模块
- parser = argparse.ArgumentParser();创建一个解析对象
- parser.add_argument();然后向该对象中添加要关注的命令行参数和选项,每一个add_argument方法对应一个要关注的参数或选项;
- parser.parse_args();调用parse_args()方法进行解析,解析成功之后即可使用。
2.2 demo说明
在这个demo测试中,定义了两个参数-save_data和-data_dir两个参数,在命令行,可以基于调用指令,实现对应的函数参数输入。
import argparse
'''
关于argparse使用的一个简单demo说明
'''
def parse_args():
# argparse 解析命令行参数 description: 就类似于一个title(标题、主题)
parser = argparse.ArgumentParser(description='Train')
'''data prepare'''
# 通过 parser.add_argument 设置了一些可以个性化确定的参数,比如是否保存数据"--save_data",
parser.add_argument('--save_data', type=bool, default=False, help='whether saving as mat')
parser.add_argument('--data_dir', type=str, default="./data", help='the directory of the data folder')
# 这儿就是表示需要输入一个参数,才能完成 上面 -save_data和-data_dir的操作(此处,没有,则表示不需要输入参数)
args = parser.parse_args()
return args
if __name__ == '__main__':
args = parse_args()
# 这儿是基于终端交互过程中是否定义了相关参数,进行下一步操作
'''
比如:定义了--save_data, 那么args.save_data就会变为True,下面的判断语句就会通过,并显示“数据已保存!”
'''
if args.save_data:
print("数据已保存!")
if args.data_dir:
print(f"数据将保存在:{args.data_dir}")
- 测试1-1:比如,在命令行输入:
python arg_parse_test.py --save_data csv
测试1-1返回结果如下:
数据已保存!
- 测试1-2:比如,在命令行输入:
python arg_parse_test.py --save_data
测试1-2返回结果如下:
arg_parse_test.py: error: argument --save_data: expected one argument
原因可以参考you.com的说明,有啥编程错误,参考这个快速而准确!
- 测试2:比如,在命令行输入:
python arg_parse_test.py --data_dir "abc"
测试2返回结果如下:
数据将保存在:abc