我想解析一个具有互斥选项组的命令行。通常,我只会使用--foo bar
,它会在名称空间中生成args.foo = 'bar'
然而,由于所有这些选项都是互斥的,并且我对传递给选项的选项名称和参数都感兴趣,而且我有几个选项需要向下游提供,所以我真正希望的是在我的命名空间中返回args.option_name = 'foo', args.option_value = 'bar'
,而不是args.foo='bar'
。
我所做的是:
class KeyAction(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
setattr(namespace, self.dest, values)
setattr(namespace, self.dest+'_key', option_string)
frob = parser.add_mutually_exclusive_group()
frob.add_argument('--foo', dest='thing', nargs='?', action=KeyAction)
frob.add_argument('--nar', dest='thing', nargs='?', action=KeyAction)
运行时,我的命名空间将看起来像:
Namespace(thing_key='--foo', thing='bar')
当CCD_ 5被解析时。当然,遗憾的是,如果从未传入--foo或--nar,则不会定义namespace.thing_key
,所以我必须使用getattr()
。
操作覆盖虽然起作用,但似乎并不完全正确。
我怀疑argparse背后的聪明人已经以某种方式做到了这一点,我只是在文档中和我的读取argparse.py.
什么是最好的,对吧,蟒蛇,做这件事的方式?Subparsers?我使用的是python 3.5。
因此,我最终使用了您两个答案中的数据来构建它,它处理选项,它的参数,并在初始化时理智地设置一切。
非常感谢您的提示、线索和验证。我感到惊讶的是,这在argparse中以前从未出现过,并成为标准化的东西。它是一个角落的情况,但当使用互斥选项时,就不是角落的情况了。
class ValueAction(argparse.Action):
"""Override to store both the format type as well as the argument"""
# pylint: disable=too-few-public-methods
def __init__(self, option_strings, dest, **kwargs):
self._dest = dest
dest = dest + '_arguments'
container = kwargs.pop('container')
kwargs['action'] = kwargs.pop('subaction')
action_class = container._pop_action_class(kwargs)
if not callable(action_class):
raise ValueError('unknown action "%s"' % (action_class,))
self._action = action_class(option_strings, dest, **kwargs)
super().__init__(option_strings, dest, **kwargs)
def __call__(self, parser, namespace, values, option_string=None):
self._action(parser, namespace, values, option_string)
if isinstance(option_string, str):
while option_string[0] in parser.prefix_chars:
option_string = option_string[1:]
setattr(namespace, self._dest, option_string)
据我所知,您希望能够指定一个复合操作,以便既保存一个Namespace插槽中使用的选项名称,又可以执行其他操作的更新。例如,你想写一些类似的东西:
group = argparse.mutually_exclusive_group()
group.add_argument('--foo', action=StoreOption, subaction='store_true')
group.add_argument('--bar', nargs='?', action=StoreOption, subaction='store')
操作类是StoreOption
,但它将调用subaction
指定的操作来对Namespace对象执行其他更新。
我使用的代码(测试非常有限)如下所示:
import argparse
class StoreOption(argparse.Action):
def __init__(self, **kwargs):
kwargs['action'] = kwargs.pop('subaction')
container = kwargs.pop('container')
action_class = container._pop_action_class(kwargs)
if not callable(action_class):
raise ValueError('unknown action "%s"' % (action_class,))
kwargs['dest'] = 'thing'
self._action = action_class(**kwargs)
print "_action:", self._action
super(StoreOption, self).__init__(
option_strings= self._action.option_strings,
dest= self._action.dest,
nargs= self._action.nargs,
const= self._action.const,
default= self._action.default,
type= self._action.type,
choices= self._action.choices,
required= self._action.required,
help= self._action.help,
metavar= self._action.metavar)
def __call__(self, parser, namespace, values, option_string=None):
print "got here:", option_string, namespace
setattr(namespace, 'key', option_string)
self._action(parser, namespace, values, option_string)
测试:
parser = argparse.ArgumentParser(prog='PROG')
group = parser.add_mutually_exclusive_group()
group.add_argument('--foo', container=group, action=StoreOption, subaction='store_true')
group.add_argument('--bar', container=group, nargs=2, action=StoreOption, subaction='store')
print parser.parse_args(['--bar', 'asd', 'qwe'])
-- prints: Namespace(key='--bar', thing=['asd', 'qwe'])
基本上,StoreOption
是包装另一个Action(由subaction
指定的那个Action)的Action。添加参数时,需要传递container=
参数,以便它可以构造子操作。此外,还有一些对关键字参数的篡改,以便为子操作正确设置它们。
同样,这已经经历了非常有限的测试,因此它可能不适用于所有子操作,但它应该为您指明正确的方向。
子类Action
正是开发人员希望您做的。即使是默认的、最常见的操作"store"也是一个子类argparse._StoreAction
。argparse._StoreTrueAction
是argparse._StoreConstAction
的一个子类,不同之处仅在于default
和const
的默认值。
要处理丢失属性的情况,您可以通过以下几种方式初始化它们:
set_defaults
允许您定义任何默认值,无论任何参数是否使用它们。在使用子分析器时用于将函数对象添加到命名空间的文档中。
parser.set_defaults(thing_key=None, thing=None)
您还可以创建一个具有默认值的名称空间,并将其作为CCD_ 20的参数。
myNamespace = argparse.Namespace(thing_key=None, thing=None)
parser.parse_args(names=myNamespace)
如果不希望名称空间中有foo=None
默认值,请将其默认值定义为argparse.SUPPRESS
。