我希望能够通过向命令行添加更多-v选项来指定不同的详细级别。例如:
$ myprogram.py
$ myprogram.py -v
$ myprogram.py -vv
$ myprogram.py -v -v -v
将分别导致verbose = 0,verbose = 1,verbose = 2和verbose = 3。如何使用argparse实现这一目标?
可选地,也可以像
那样指定它$ myprogram -v 2
答案 0 :(得分:90)
我有这个愿望,并且几个月前实施了一个自定义动作来实现它,我厌倦了复制到我一直在写的脚本。但我刚刚发现argparse确实支持action='count'
,就像optparse
那样,尽管这似乎在标准库docs online(this bug report中完全没有记录注意到缺席;已发布并审核了补丁,因此可能有一天会出现。
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('-v', '--verbose', action='count', default=0)
for c in ['', '-v', '-v -v', '-vv', '-vv -v', '-v -v --verbose -vvvv']:
print parser.parse_args(c.split())
输出:
Namespace(verbose=0)
Namespace(verbose=1)
Namespace(verbose=2)
Namespace(verbose=2)
Namespace(verbose=3)
Namespace(verbose=7)
如果您不希望default=0
个参数给出详细级别为0而不是-v
,则必须明确设置None
。
答案 1 :(得分:19)
您可以使用nargs='?'
(在-v
标志后接受0或1个参数)和自定义操作(处理0或1参数)来执行此操作:
import sys
import argparse
class VAction(argparse.Action):
def __init__(self, option_strings, dest, nargs=None, const=None,
default=None, type=None, choices=None, required=False,
help=None, metavar=None):
super(VAction, self).__init__(option_strings, dest, nargs, const,
default, type, choices, required,
help, metavar)
self.values = 0
def __call__(self, parser, args, values, option_string=None):
# print('values: {v!r}'.format(v=values))
if values is None:
self.values += 1
else:
try:
self.values = int(values)
except ValueError:
self.values = values.count('v')+1
setattr(args, self.dest, self.values)
# test from the command line
parser = argparse.ArgumentParser()
parser.add_argument('-v', nargs='?', action=VAction, dest='verbose')
args = parser.parse_args()
print('{} --> {}'.format(sys.argv[1:], args))
print('-'*80)
for test in ['-v', '-v -v', '-v -v -v', '-vv', '-vvv', '-v 2']:
parser = argparse.ArgumentParser()
parser.add_argument('-v', nargs='?', action=VAction, dest='verbose')
args=parser.parse_args([test])
print('{:10} --> {}'.format(test, args))
从命令行运行script.py -v -v
会产生
['-v', '-v'] --> Namespace(verbose=2)
--------------------------------------------------------------------------------
-v --> Namespace(verbose=1)
-v -v --> Namespace(verbose=2)
-v -v -v --> Namespace(verbose=3)
-vv --> Namespace(verbose=2)
-vvv --> Namespace(verbose=3)
-v 2 --> Namespace(verbose=2)
取消注释print语句,以更好地了解VAction
正在做什么。
答案 2 :(得分:12)
您可以使用append_const
处理问题的第一部分。否则,您可能无法按照罚款answer by unutbu中的建议编写自定义操作。
import argparse
ap = argparse.ArgumentParser()
ap.add_argument('-v', action = 'append_const', const = 1)
for c in ['', '-v', '-v -v', '-vv', '-vv -v']:
opt = ap.parse_args(c.split())
opt.v = 0 if opt.v is None else sum(opt.v)
print opt
输出:
Namespace(v=0)
Namespace(v=1)
Namespace(v=2)
Namespace(v=2)
Namespace(v=3)
答案 3 :(得分:2)
argparse
支持append
操作,该操作允许您指定多个参数。点击http://docs.python.org/library/argparse.html,搜索“append
”。
答案 4 :(得分:2)
扩展unutbu的答案,这是一个自定义操作,包括处理--quiet / -q组合。这是在Python3中测试的。在Python> = 2.7中使用它应该没什么大不了的。
class ActionVerbose(argparse.Action):
def __call__(self, parser, args, values, option_string=None):
#print(parser, args, values, option_string)
# Obtain previously set value in case this option call is incr/decr only
if args.verbose == None:
base = 0
else:
base = args.verbose
# One incr/decr is determined in name of option in use (--quiet/-q/-v/--verbose)
option_string = option_string.lstrip('-')
if option_string[0] == 'q':
incr = -1
elif option_string[0] == 'v':
incr = 1
else:
raise argparse.ArgumentError(self,
'Option string for verbosity must start with v(erbose) or q(uiet)')
# Determine if option only or values provided
if values==None:
values = base + incr
else:
# Values might be an absolute integer verbosity level or more 'q'/'v' combinations
try:
values = int(values)
except ValueError:
values = values.lower()
if not re.match('^[vq]+$', values):
raise argparse.ArgumentError(self,
"Option string for -v/-q must contain only further 'v'/'q' letters")
values = base + incr + values.count('v') - values.count('q')
setattr(args, self.dest, values)
@classmethod
def add_to_parser(cls,
parser, dest='verbose', default=0,
help_detail='(0:errors, 1:info, 2:debug)'):
parser.add_argument('--verbose', nargs='?', action=ActionVerbose, dest=dest, metavar='level',
default=default,
help='Increase or set level of verbosity {}'.format(help_detail))
parser.add_argument('-v', nargs='?', action=ActionVerbose, dest=dest, metavar='level',
help='Increase or set level of verbosity')
parser.add_argument('--quiet', nargs='?', action=ActionVerbose, dest=dest, metavar='level',
help='Decrease or set level of verbosity')
parser.add_argument('-q', nargs='?', action=ActionVerbose, dest=dest, metavar='level',
help='Decrease or set level of verbosity')
有一个便捷类方法,可用于为--verbose
,-v
,-q
,--quiet
设置所有四个选项处理程序。像这样使用它:
parser = argparse.ArgumentParser()
ActionVerbose.add_to_parser(parser, default=defaults['verbose'])
# add more arguments here with: parser.add_argument(...)
args = parser.parse_args()
使用具有这些参数的脚本时,您可以这样做:
./script -vvvvvv -v 4 -v 0 -v -vvv --verbose --quiet 2 -v qqvvqvv
使用此命令行args.verbose
将为4
。
-v/-q/--verbose/--quiet
都是args.verbose
到该给定数字(=详细程度)的绝对硬集。-v/--verbose
都是该级别的增量。-q/--quiet
都是该级别的减量。-v/-q
可能会立即跟进更多v/q
个字母,结果级别为the old level + sum(count('v')) - sum(count('q'))
如果您想要不同的行为,自定义操作应该相当容易修改。例如,有些人更喜欢任何--quiet
将级别重置为0,甚至重置为-1。为此,请从nargs
和-q
的add_argument中删除--quiet
,并使用硬编码设置value = 0
if option_string[0] == 'q'
。
如果使用错误,可以很好地打印正确的解析器错误:
./script -vvvvvv -v 4 -v 0 -v -vvv --verbose --quiet 2 -v qqvvqvav
usage: script [-h] [--verbose [level]]
[-v [level]] [--quiet [level]] [-q [level]]
script: error: argument -v: Option string for -v/-q must contain only further 'v'/'q' letters
答案 5 :(得分:1)
这是我的观点,它不使用任何新类,在Python 2和3中都可以使用,并且支持使用默认值“ -v” /“-verbose”和“ -q” /“-的相对调整-quiet”,但它不支持使用数字,例如“ -v 2”:
#!/usr/bin/env python
import argparse
import sys
LOG_LEVELS = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
DEFAULT_LOG_LEVEL = "INFO"
def main(argv):
parser = argparse.ArgumentParser()
parser.add_argument(
"--verbose", "-v",
dest="log_level",
action="append_const",
const=1,
)
parser.add_argument(
"--quiet", "-q",
dest="log_level",
action="append_const",
const=-1,
)
args = parser.parse_args(argv[1:])
log_level = LOG_LEVELS.index(DEFAULT_LOG_LEVEL)
# For each "-q" and "-v" flag, adjust the logging verbosity accordingly
# making sure to clamp off the value from 0 to 4, inclusive of both
for adjustment in args.log_level or ():
log_level = min(len(LOG_LEVELS) - 1, max(log_level + adjustment, 0))
log_level_name = LOG_LEVELS[log_level]
print(log_level_name)
if __name__ == "__main__":
main(sys.argv)
示例:
$ python2 verbosity.py -vvv
DEBUG
$ python3 verbosity.py -vvv -q
INFO
$ python2 verbosity.py -qqq -vvv -q
WARNING
$ python2 verbosity.py -qqq
CRITICAL
答案 6 :(得分:0)
您提出的第一种方法更容易混淆。不同级别的详细程度的不同选项名称,或者一个详细标记,可选地后跟冗长级别的数字指示符,不太可能使用户感到困惑,并且可以更灵活地分配详细级别。