python中argparse模块及action='store_true'详解

PoomHey 2023-03-20 我要评论

Python argparse模块详解

argparse 是一个用来解析命令行参数的 Python 库，它是 Python 标准库的一部分。基于 python 2.7 的 stdlib 代码。argparse 模块使编写用户友好的命令行界面变得容易。程序定义了所需的参数，而 argparse 将找出如何从 sys.argv 中解析这些参数。argparse 模块还会自动生成帮助和使用消息，并在用户为程序提供无效参数时发出错误。

1. 问题描述

经常炼丹的朋友对下面这段代码非常熟悉。

parser = argparse.ArgumentParser()
parser.add_argument('-c','--clean',action='store_true')
parser.add_argument('-r','--run',action='store_true')
config = parser.parse_args()

然后问题来了，action他的意义在这里是什么？

我去查了查资料，简单的做个总结

2. add_argument() 方法官方介绍

在这个方法中，

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

其中

action - 当参数在命令行中出现时使用的动作基本类型。

详细来讲，就是

action

ArgumentParser 对象将命令行参数与动作相关联。这些动作可以做与它们相关联的命令行参数的任何事，尽管大多数动作只是简单的向

parse_args() 返回的对象上添加属性。action 命名参数指定了这个命令行参数应当如何处理。供应的动作有：

'store' - 存储参数的值。这是默认的动作。

3. 实例测试与对比

step01

用实例来讲：

def testArgparse():
	parser = argparse.ArgumentParser(description = 'Argparse Demo.')
	parser.add_argument('-n', '--name', default = 'Lee')
	parser.add_argument('-m', '--money', default = '80W')
	args = parser.parse_args()
	print(' This content is ', args)
	name = args.name
	money = args.money
	print(' Shuai ge is {}, ta yi nian {}!'.format(name, money))
if __name__ == '__main__':
	testArgparse()

输出的结果为：

step 02

接下来我们引入 store。

def testArgparse():
	parser = argparse.ArgumentParser(description = 'Argparse Demo.')
	parser.add_argument('-n', '--name', default = 'Lee')
	parser.add_argument('-m', '--money', action='store_const', const = '80W')
	args = parser.parse_args()
	print(' This content is ', args)
	name = args.name
	money = args.money
	print(' Shuai ge is {}, ta yi nian {}!'.format(name, money))
if __name__ == '__main__':
	testArgparse()

注意，我在这里增加了

action='store_const', const = '80W'

替换了原来的

default = '80w'

程序可以运行，但是我们可以看到，值出现了变化

money这里变成了none。

一步一步来。

step03：store后面是否可以自定义？

代码变红了，我还以为可以。实际上不行。

step04：为什么我的输出值为None？

修改了赋值语句之后，可以取到值。

但是对比可以得到，取值时候需要加入索引。

parser.parse_args(['-m'])

step05 理解store_true,store_false

这个时候我们再回头来看，就很清晰了，就是给参数赋值为true和false。

准确描述为：“当带有store_true时，你传入对应参数，则触发为真，否则为假。”

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('--bar', action='store_false')
>>> parser.add_argument('--baz', action='store_false')
>>> parser.parse_args('--foo --bar'.split())
Namespace(foo=True, bar=False, baz=True)

那在我们具体应用中呢？

看实例

def testArgparse():
	parser = argparse.ArgumentParser(description = 'Argparse Demo.')
	parser.add_argument('-t', '--tag', action='store_true', help='是否能够运行')
	parser.add_argument('-n', '--name', default = 'Lee')
	parser.add_argument('-m', '--money', action='store_const', const = '80W')
	args = parser.parse_args()
	print(' This content is ', args)
	name = args.name
	#money = args.money
	money = parser.parse_args(['-m'])
	tag= args.tag
	print(tag,int(tag))
	print(' Shuai ge is {}, ta yi nian {}!'.format(name, money))
if __name__ == '__main__':
	testArgparse()