使用 Python argparse：如何处理命令行参数
一、前言
argparse是python的一个命令行参数解析包，在代码需要频繁修改参数时，方便使用，主要用法就是在命令行输入自己想要修改的参数。
二、关于argparse用法常用框架
import argparse def get_parser(): # argparse.ArgumentParser生成argparse对象 description为描述信息，当在命令行输入需要显示帮助信息时，会显示 parser = argparse.ArgumentParser(description="pytorch unet training") # 路径参数设置 help为参数的帮助信息 parser.add_argument("--data_path", default="./", help="DRIVE root") # 预测类别数量 type如果不指定需要输入的是str类型 parser.add_argument("--num_classes", default=1, type=int) # 指定设备使用 parser.add_argument("--device", default="cuda", help="training device") # 指定batch size大小 "-b", "--batch_size"表示两个都可以在命令行使用 parser.add_argument("-b", "--batch_size", default=4, type=int) return parser if __name__ =='__main__': parser = get_parser() args = parser.parse_args() print(args)
如上get_parser()为本文会介绍的一些使用方法，这个python文件名为python_argparse_test1.py，其中
parser = argparse.ArgumentParser(description="pytorch unet training")用来创建parser对象
add_argument()用来增加参数
args = parser.parse_args()中parse_args()获取解析的参数
1.获取参数列表
当命令行输入python python_argparse_test1.py时，打印args获取到的参数得到：
Namespace(batch_size=4, data_path='./', device='cuda', num_classes=1)
表示这个参数解析器解析到的参数列表
2.获取帮助信息
输入python python_argparse_test1.py -h或者python python_argparse_test1.py --help显示信息，其中usage显示了它的用法，pytorch unet training为创建对象时的description,再下面是各个参数信息与用法
3.命令行修改参数
import argparse def get_parser(): # argparse.ArgumentParser生成argparse对象 description为描述信息，当在命令行输入需要显示帮助信息时，会显示 parser = argparse.ArgumentParser(description="pytorch unet training") # 路径参数设置 help为参数的帮助信息 default为默认参数 parser.add_argument("--data_path", default="./", help="DRIVE root") # 预测类别数量 type如果不指定需要输入的是str类型 parser.add_argument("--num_classes", default=1, type=int) # 指定设备使用 parser.add_argument("--device", default="cuda", help="training device") # 指定batch size大小 "-b", "--batch_size"表示两个都可以在命令行使用 parser.add_argument("-b", "--batch_size", default=4, type=int) return parser if __name__ =='__main__': parser = get_parser() args = parser.parse_args() print("data_path: ",args.data_path) print("num_classes: ", args.num_classes)
命令行输入：python python_argparse_test1.py --data_path Desktop --num_classer 4，得到结果如下：
data_path: Desktop
num_classes: 4
可以看到通过命令行确实修改了参数
4.'_'与"__"的使用
if __name__ =='__main__':
parser = get_parser()
args = parser.parse_args()
print("-b: ",args.b)
print("--batch_size: ", args.batch_size)命令行输入python python_argparse_test1.py -b 10 --batch_size 20，这时会报错：
这是因为当'_'和'__'同时存在时，系统默认后者为参数名
把上述代码改为：
if __name__ =='__main__':
parser = get_parser()
args = parser.parse_args()
print("--batch_size: ",args.batch_size)但命令行不受影响，继续执行命令 python python_argparse_test1.py -b 10得到：
--batch_size: 10
5.type的使用
type会把输入的命令行字符强制转化为type的类型
if __name__ =='__main__':
parser = get_parser()
args = parser.parse_args()
print("--batch_size type: ",type(args.batch_size))命令行输入：python python_argparse_test1.py --batch_size '10'得到：
--batch_size type:
6.required:用来表示这个参数是否需要提供
parser.add_argument("--num_classes", default=1, type=int, required=True)如果输入命令python python_argparse_test1.py
这将会报错提示确实需要的参数
python_argparse_test1.py: error: the following arguments are required: --num_classes
7.choices选择参数
parser.add_argument('-arch', required=True, choices=['alexnet', 'vgg'])
如果运行命令：python python_argparse_test1.py -arch cnn
这将会报错
python_argparse_test1.py: error: argument -arch: invalid choice: 'cnn' (choose from 'alexnet', 'vgg')