Python中命令行参数argparse模块的使用

时间:2023-02-03 陌北v1 人气:0

argparse 模块是Python内置的用于命令项选项与参数解析的模块，可以轻松编写友好的命令行接口，能够帮助程序员为模型定义参数。

传入一个参数

add_argument()中的type参数表示传入参数的数据类型

import argparse
#定义命令行解析器对象
parser = argparse.ArgumentParser(description='参数说明')
#添加命令行参数
parser.add_argument('name',type=str,help='用户名')
#从命令行中结构化解析参数
args = parser.parse_args()
print(args.url)

python test.py 张三
结果：
张三

位置参数

按先后顺序传入参数

import argparse
parser = argparse.ArgumentParser(description='参数说明')
parser.add_argument('param1', type=str, help='参数1')
parser.add_argument('param2', type=str, help='参数2')
args = parser.parse_args()
print(args.param1,args.param2)

python test.py a1 a2
结果：
a1 a2

可选参数

可选参数类似于关键词传参，但需要在关键词前加–

import argparse
parser = argparse.ArgumentParser(description='参数说明')
parser.add_argument('--param1', type=str, help='参数1')
parser.add_argument('--param2', type=str, help='参数2')
args = parser.parse_args()
print(args.param1,args.param2)

python test.py --param1=a1
结果：
a1 None

名字可以写很多个，一般写两个，一个短参数，一个长参数

import argparse
parser = argparse.ArgumentParser(description='参数说明')
parser.add_argument('-f','--file', type=str, help='参数1')
args = parser.parse_args()
print(args.file)

python test.py -f=log.txt
结果：
log.txt

默认参数

add_argument()中的default参数可以为对某个参数设置默认值，当命令行没有传入该参数的值的时候，参数会设为默认值

import argparse
parser = argparse.ArgumentParser(description='参数说明')
parser.add_argument('--param1', type=str, default='hello', help='参数1')
parser.add_argument('--param2', type=str, default='hello1', help='参数2')
args = parser.parse_args()
print(args.param1,args.param2)

python test.py --param1=a1
结果：
a1 hello1

必需参数

add_argument中的required参数可以设置某个参数是否为必需

import argparse
parser = argparse.ArgumentParser(description='参数说明')
parser.add_argument('--param1', type=str, required=True, default='', help='参数1')
parser.add_argument('--param2', type=str, default='hello1', help='参数2')
args = parser.parse_args()
print(args.param1,args.param2)

常用参数解释：

default: 代表如果该参数不输入，则会默认使用该值。
type: 表示传入参数的数据类型，例如：str,int。
required: 如果required=True则为必须项。
help: 参数的帮助信息。

加载全部内容