我正在尝试向我的脚本添加参数依赖项。想法是 - clone 参数将需要非空 - gituser 。
在仔细阅读this example后,我尝试了以下内容
In [93]: class CloneAction(argparse.Action):
...: def __call__(self, parser, namespace, _):
...: if not namespace.git_user and namespace.clone:
...: parser.error('"--clone" requires legal git user')
...:
In [94]: parser = argparse.ArgumentParser()
In [95]: parser.add_argument('-g', '--gituser', dest='git_user', type=str, default='', action=CloneAction)
Out[95]: CloneAction(option_strings=['-g', '--gituser'], dest='git_user', nargs=None, const=None, default='', type=<type 'str'>, choices=None, help=None, metavar=None)
In [96]: parser.add_argument('--clone', action='store_true', default=False)
Out[96]: _StoreTrueAction(option_strings=['--clone'], dest='clone', nargs=0, const=True, default=False, type=None, choices=None, help=None, metavar=None)
唉,它不起作用
In [97]: parser.parse_args(['--clone'])
Out[97]: Namespace(clone=True, git_user='')
我做错了什么?
答案 0 :(得分:4)
在解析之后,这种inter争议依赖更容易实现。
args = parser.parse_args()
if not namespace.git_user and namespace.clone:
parser.error('"--clone" requires legal git user')
此时,git_user
和clone
都已被解析,并且具有最终值。
在实现它时,只有在存在--gituser
参数时才会运行自定义操作。所以我认为当你--gituser
没有--clone
时,它会引发错误。
您可以为--clone
提供类似的自定义操作,但它还必须处理store_true
详细信息。 --clone --gituser value
序列会发生什么? clone
操作将在解析gituser
值之前运行。像这样的测试遇到了一些棘手的争论顺序问题。
其他几个问题:
您的自定义操作不会存储任何值,无论错误是什么。最好自定义store
子类。
自定义操作应引发argparse.ArgumentError
,而不是直接致电parser.error
。
单元测试文件test/test_argparse.py
有一个自定义操作的例子,它有这样的相互测试。但它只是一个玩具,验证允许这样的代码。
==================
理论上,您可以实施--clone
操作来设置required
操作的--gituser
属性。这样,如果未使用--gituser
,则required
的最终parse_args
操作测试将引发错误。但这需要保存对out[95]
中显示的操作的引用(或在parse._actions
列表中查找。可行但很麻烦。
===================
以下是来自test/test_argparse.py
的一对交互式自定义操作类的示例。
class OptionalAction(argparse.Action):
def __call__(self, parser, namespace, value, option_string=None):
try:
# check destination and option string
assert self.dest == 'spam', 'dest: %s' % self.dest
assert option_string == '-s', 'flag: %s' % option_string
# when option is before argument, badger=2, and when
# option is after argument, badger=<whatever was set>
expected_ns = NS(spam=0.25)
if value in [0.125, 0.625]:
expected_ns.badger = 2
elif value in [2.0]:
expected_ns.badger = 84
else:
raise AssertionError('value: %s' % value)
assert expected_ns == namespace, ('expected %s, got %s' %
(expected_ns, namespace))
except AssertionError:
e = sys.exc_info()[1]
raise ArgumentParserError('opt_action failed: %s' % e)
setattr(namespace, 'spam', value)
NS
是argparse.Namespace
的缩写。
class PositionalAction(argparse.Action):
def __call__(self, parser, namespace, value, option_string=None):
try:
assert option_string is None, ('option_string: %s' %
option_string)
# check destination
assert self.dest == 'badger', 'dest: %s' % self.dest
# when argument is before option, spam=0.25, and when
# option is after argument, spam=<whatever was set>
expected_ns = NS(badger=2)
if value in [42, 84]:
expected_ns.spam = 0.25
elif value in [1]:
expected_ns.spam = 0.625
elif value in [2]:
expected_ns.spam = 0.125
else:
raise AssertionError('value: %s' % value)
assert expected_ns == namespace, ('expected %s, got %s' %
(expected_ns, namespace))
except AssertionError:
e = sys.exc_info()[1]
raise ArgumentParserError('arg_action failed: %s' % e)
setattr(namespace, 'badger', value)
它们用于
parser = argparse.ArgumentParser()
parser.add_argument('-s', dest='spam', action=OptionalAction,
type=float, default=0.25)
parser.add_argument('badger', action=PositionalAction,
type=int, nargs='?', default=2)
并且应该合作:
'-s0.125' producing: NS(spam=0.125, badger=2)),
'42', NS(spam=0.25, badger=42)),
'-s 0.625 1', NS(spam=0.625, badger=1)),
'84 -s2', NS(spam=2.0, badger=84)),
这是可以完成的交叉检查的一个例子。但我要重复一遍,通常在解析后最好处理交互,而不是在处理期间。
关于实现问题 - 如果用户没有给你--gituser
,则永远不会调用自定义Action。 Action.__call__
的{{1}}仅在使用该参数时使用。始终使用optional
,但不使用positionals
。