python内置模块之【argparse模块】
- 0、顾名思义:
- 1、使用步骤举例子:
- 2、流程图:
- 3、分析:
- 3-1.对②:
- 1)为啥创建对象?
- 3-2.对③:
- 1)如何分辨添加的参数是位置参数还是选项参数?
- 3-3.对④:
- 1)位置参数与选项参数获取参数值的方式有什么不同吗?
- 2)a.如果定义时既有--weights又有-T即`parser.add_argument('--weights', '-T' ,type=str, default=ROOT / 'yolov5s.pt', help='initial weights path`那命令行是输入`--weight 2`还是`-T 2`呢?生成的Namespace()中的`选项参数名`是两个还是一个呢?如果是一个则用哪一个?b.如果定义时只有--weights和-T中的一个,那么命令行和Namespace()中的`位置/选项参数名`是两个还是一个?如果是一个则用哪一个?。
- 4、补充:
- 4-1.Python的sys模块
- 4-2.argparse.ArgumentParser()方法参数:一般我们只选择用description
- 4-3.add_argument()方法参数:
- 4-4.使用pycharm的一些截图:
0、顾名思义:
argparse:argument(参数) parse(解析) 。即解析参数模块,一句话:
给某个程序设置几个参数,并且可以用命令行的形式把值传给它们。
sys.argv:argv是sys.py里的一个列表,命令行中以空格为分隔的参数会被依次放入该列表且第一个数是当前运行的.py文件路径,这里的句点表示法就是在别的.py文件中访问该列表。
1、使用步骤举例子:
①导入模块:import argparse
②创建一个解析对象:parser = argparse.ArgumentParser()
③向该对象中添加位置/选项参数:parser.add_argument('--weights', type=str, default=ROOT / 'yolov5s.pt', help='initial weights path') parser.add_argument('--cfg', type=str, default='', help='model.yaml path')
④进行解析生成Namespace():opt=parser.parse_args()
⑤访问参数的值:如print(opt.某位置/选项参数名)
2、流程图:
3、分析:
3-1.对②:
1)为啥创建对象?
答:如果不理解为啥创建对象,可以类比打开文本文件的时候都先要创建一个文本对象,然后再对这个对象进行操作。
3-2.对③:
1)如何分辨添加的参数是位置参数还是选项参数?
答:相信大家应该在应用到该模块的时候早已经安装过了python吧,用win+R打开电脑的命令行输入下图两个命令,
像–version和-V,即以–或-开头的参数就是选项参数,没有–或-开头的就是位置参数。我们在③里面添加参数的时候就按照这个原则来。
3-3.对④:
1)位置参数与选项参数获取参数值的方式有什么不同吗?
答:这个就理解为函数里面的位置参数和关键字参数获取参数值。如果是位置参数,则命令行不用输参数名直接把参数值输进去生成参数列表,再把参数列表的值依次赋给位置参数;如果是选项参数,则命令行先输选项参数名再输参数值,解析时会找到参数列表中选项参数名后面的值赋给选项参数。最后生成Namespace(位置/选项参数名=参数值,…,…)的数据类型,我们直接看成字典,然后用句点表示法访问这些参数的值就可以了。
2)a.如果定义时既有–weights又有-T即parser.add_argument('--weights', '-T' ,type=str, default=ROOT / 'yolov5s.pt', help='initial weights path
那命令行是输入--weight 2
还是-T 2
呢?生成的Namespace()中的选项参数名
是两个还是一个呢?如果是一个则用哪一个?b.如果定义时只有–weights和-T中的一个,那么命令行和Namespace()中的位置/选项参数名
是两个还是一个?如果是一个则用哪一个?。
答:这里讲个小故事就理解了。一家有两个人:父亲–weight和12岁的儿子-T,家里的地位最高的当然就是父亲;一天,有人来还这家钱(参数值),但父亲出门了,钱就交给他儿子了[命令行输-T 2
],等他父亲回来儿子又把钱交给他父亲,或者刚好他父亲在家[命令行输--weight 2
],钱就直接交给他父亲了,所以最终钱(参数值)是到他父亲手上[Namespace中只能用–weight],即2)a中输入--weight 2
还是-T 2
都行,Namespace()中的选项参数名
是一个且是父亲–weight。如果有一天父亲和儿子有一人去世了,家里的地位最高的就是在世的那个了,那么钱只能给到在世的那个人手上,不可能给到去世的那个,这就对应2)b的问题,即命令行只能输入在世的那个,且Namespace中也只能用在世的那个。
所以:定义时–和-都有,则命令行两个选一个,Namespace只能用–;定义时–和-只有一个,则命令行和Namespace只能用定义的那个。
4、补充:
4-1.Python的sys模块
sys.argv #命令行参数List,第一个元素是程序本身路径
sys.exit(n) #退出程序,正常退出时exit(0)
sys.version #获取Python解释程序的版本信息
sys.maxint #最大的Int值
sys.path #返回模块的搜索路径,初始化时使用PYTHONPATH环境变量的值
sys.platform #返回操作系统平台名称
sys.stdin #输入相关
sys.stdout #输出相关
sys.stderror #错误相关
4-2.argparse.ArgumentParser()方法参数:一般我们只选择用description
description - 命令行帮助的开始文字,大部分情况下,我们只会用到这个参数
epilog - 命令行帮助的结尾文字
prog - (default: sys.argv[0])程序的名字,一般不需要修改,另外,如果你需要在help中使用到程序的名字,可以使用%(prog)s
prefix_chars - 命令的前缀,默认是-,例如-f/–file。有些程序可能希望支持/f这样的选项,可以使用prefix_chars=”/”
fromfile_prefix_chars - (default: None)如果你希望命令行参数可以从文件中读取,就可能用到。例如,如果fromfile_prefix_chars=’@’,命令行参数中有一个为”@args.txt”,args.txt的内容会作为命令行参数
add_help - 是否增加-h/-help选项 (default: True),一般help信息都是必须的,所以不用设置啦。
parents - 类型是list,如果这个parser的一些选项跟其他某些parser的选项一样,可以用parents来实现继承,例如parents=[parent_parser]
三个允许的值: # class argparse.RawDescriptionHelpFormatter 直接输出description和epilog的原始形式(不进行自动换行和消除空白的操作) # class argparse.RawTextHelpFormatter 直接输出description和epilog以及add_argument中的help字符串的原始形式(不进行自动换行和消除空白的操作) # class argparse.ArgumentDefaultsHelpFormatter 在每个选项的帮助信息后面输出他们对应的缺省值,如果有设置的话。这个最常用吧!
argument_default - (default: None)设置一个全局的选项的缺省值,一般每个选项单独设置,所以这个参数用得少,不细说
usage - (default: generated)如果你需要修改usage的信息(usage: PROG [-h] [–foo [FOO]] bar [bar …]),那么可以修改这个,一般不要修改。
conflict_handler - 不建议使用。这个在极端情况下才会用到,主要是定义两个add_argument中添加的选项的名字发生冲突时怎么处理,默认处理是抛出异常。
4-3.add_argument()方法参数:
name or flags - 指定参数的形式,想写几个写几个,不过我们一般就写两个,一个短参数,一个长参数,看下面的例子”-f”, “–file”
可选的选项,位置不固定,想怎么写就怎么写,默认是可选的 # parser.add_argument(“-f”, “–file”, help=”test test test”)
位置固定的选项,例如”prog i_am_bar”,这样子的话,i_am_bar就是bar选项的值啦,默认是必须有的 # parser.add_argument(“bar”, help=”test test test”)
nargs - 指定这个参数后面的value有多少个,例如,我们希望使用-n 1 2 3 4,来设置n的值为[1, 2, 3, 4] #parser.add_argument(“-n”, “–num”, nargs=”+”, type=int) # 这里nargs=”+”表示,如果你指定了-n选项,那么-n后面至少要跟一个参数,+表示至少一个,?表示一个或0个,0个或多个 。
default - 如果命令行没有出现这个选项,那么使用default指定的默认值 #parser.add_argument(“+g”, “++gold”, help=”test test test”,default=”test_gold”)#需要prefix_chars包含”+” 。
type - 如果希望传进来的参数是指定的类型(例如 float, int or file等可以从字符串转化过来的类型),可以使用 parser.add_argument(“-x”, type=int) 。
choices - 设置参数值的范围,如果choices中的类型不是字符串,记得指定type哦 #parser.add_argument(“-y”, choices=[‘a’, ‘b’, ‘d’])
required - 通常-f这样的选项是可选的,但是如果required=True那么就是必须的了 #parser.add_argument(“-z”, choices=[‘a’, ‘b’, ‘d’], required=True)
metavar - 参数的名字,在显示 帮助信息时才用到. # parser.add_argument(“-o”, metavar=”OOOOOO”)
help - 设置这个选项的帮助信息
dest - 设置这个选项的值就是解析出来后放到哪个属性中 #parser.add_argument(“-q”, dest=”world”)
args = parser.parse_args(args) # 如果你没有args参数,那么就使用sys.argv,也就是命令行参数。有这个参数,就方便我们调试啊 。# args.world就是-q的值啦
注:4中补充的东西建议:需要的时候再仔细斟酌。
4-4.使用pycharm的一些截图:
上图是传入的参数,就是终端上python C:/Users/Administrator/Desktop/demo/main.py
后面输入的内容。运行结果如下:
运行的第一行是不是很像在终端运行程序。
注:这些都是自己个人的理解,如果有错误大家可以指出来。