解析命令行参数argparse.argumentParser()使用方

一、导入所需模块:

import argparse

 二、创建一个解析对象:

parser = argparse.ArgumentParser(description='Process some intergers.')
通常情况下可以省略description,简写为:
parser = argparse.ArgumentParser()
ArgumentParser对象包含将命令行解析成Python数据类型所需的全部信息;

三、添加运行时所需的参数:

parser.add_argument(*args, **kwargs)
(1)name:字符串类型,表示对应的参数名称,其格式为'--选项参数名称'或'位置参数名称';
a.位置参数(Positional Arguments):这些参数是不带'--'前缀的参数,通常用于需要按特定顺序提供的参数且通常是必需的;
b.选项参数(Optional Arguments):这些参数通常带有'--'前缀;选项参数是可选的,不需要按照特定的顺序提供且可以有默认值;
(2)type:表示输入参数的类型,可选值为int,str,float;
(3)default:表示参数默认的值,取值具体类型和对应参数的实际类型一致
(4)help:str类型,表示帮助信息,当用户使用-h或--help选项时该信息将显示在帮助文档中;
(5)nargs:用于定义一个选项参数应该消耗的命令行参数数量,它可以接受以下不同的取值:
a.字符'+':表示选项参数可以接受一个或多个参数值,多个参数值将被解析为一个列表;
b.字符'*':表示选项参数可以接受零个或多个参数值,多个参数值将被解析为一个列表,零个参数值将被解析为一个空列表[]
c.int类型的值:表示选项参数应该消耗固定数量的参数值;多个参数值将被解析为一个列表;
d.argparse.REMAINDER:表示选项参数应该消耗剩余的命令行参数,将其解析为一个列表;
(6)required:布尔类型,指定该参数是否是必需的,默认为False,即可选参数;
如果将其设置为True则在命令行中必须提供该参数,否则将引发错误;
(7)choices:list类型,指定参数的可选值列表;如果设置了该参数那么命令行中提供的值必须是列表中的一个,否则将引发错误
(8)action:str类型,指定参数的动作:
a.'store':默认动作,将参数值存储为属性;
b.'store_true':将参数解析为True;
c.'store_false':将参数解析为False;
d.'append':将多个参数值存储为列表;

 四、解析参数:

args = parser.parse_args()
返回的args为一个Namespace类型的对象
之后便可以使用'args.参数名称'的方式调用第三步中添加的参数