python argparse store --foo = bar as args.key ='foo',args.value ='bar'

时间:2016-05-04 05:08:34

标签: python argparse

我想解析一个具有互斥组选项的命令行。通常情况下,我只使用会在命名空间中生成的--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')

解析--foo=bar时。当然,遗憾的是,如果从未传入--foo或--nar,则namespace.thing_key未定义,因此我必须使用getattr()

动作覆盖虽然功能正常,但似乎并不合适。

我怀疑argparse背后的聪明才智已经以某种方式得到了这个权利,我只是在文档和我的文档中错过了它 阅读argparse.py。

最好的,正确的,pythonic的方法是什么? 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)

2 个答案:

答案 0 :(得分:2)

据我了解,您希望能够指定复合操作,以便您既保存一个名称空间槽中使用的选项名称,又可以执行其他一些操作的更新。例如,你希望能够写出如下内容:

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=参数,以便它可以构造子操作。此外,还有一些摆弄关键字参数,以便为子操作正确设置它们。

同样,这已经经历了非常有限的测试,因此它可能不适用于所有子操作,但它应该指向正确的方向。

答案 1 :(得分:1)

子类化Action正是开发人员期望您做的。即使是默认的,最常见的操作,'store'也是一个子类argparse._StoreActionargparse._StoreTrueActionargparse._StoreConstAction的子类,仅在defaultconst默认值不同。

要处理缺少的属性案例,您可以通过以下几种方式初始化它们:

set_defaults允许您定义任何默认值,无论是否有任何参数使用它们。在使用subparsers时用于向命名空间添加函数对象的文档中。

parser.set_defaults(thing_key=None, thing=None)

您还可以使用默认值创建命名空间,并将其作为传递 parse_args的论点。

myNamespace = argparse.Namespace(thing_key=None, thing=None)
parser.parse_args(names=myNamespace)

如果您不想在命名空间中使用foo=None默认值,请将其默认值定义为argparse.SUPPRESS