从argparse解包参数

时间:2016-03-06 02:39:29

标签: python argparse

我一直在编写一些命令行python程序并使用argparse来完成它。我一直在构建我的代码如下。

def main(arg1, arg2):
    # magic
    pass

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('arg1')
    parser.add_argument('arg2')

    args = parser.parse_args()

    main(args.arg1, args.arg2)

必须召唤arg1arg2 3次真的非常恼人。我明白必须做两次。

有没有办法将parse_args函数返回的命名空间视为元组?或者更好的是作为可选args的元组和字典并进行解包?

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('arg1')
    parser.add_argument('arg2')
    parser.add_argument('--opt-arg', default='default_value')

    args, kwargs = parser.magic_method_call_that_would_make_my_life_amazing()

    # I get goosebumps just thinking about this
    main(*args, **kwargs)

3 个答案:

答案 0 :(得分:7)

您可以看到类似问题here

修改:正在寻找一种不使用内部方法的方法,我发现this discussion建议使用vars()。这非常有效:

import argparse

def main(arg1, arg2):
    print arg1, arg2

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('arg1')
    parser.add_argument('arg2')

    args = parser.parse_args()
    main(**vars(args))

答案 1 :(得分:7)

https://docs.python.org/3/library/argparse.html#the-namespace-object

  

这个类是故意简单的,只是一个带有可读字符串表示的对象子类。如果您希望使用类似dict的属性视图,则可以使用标准Python惯用语,vars()

>>>
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> args = parser.parse_args(['--foo', 'BAR'])
>>> vars(args)
{'foo': 'BAR'}

请注意,从optparseargparse的一个重大进步或至少更改是位置参数(例如您的)被视为与选项相同。它们都出现在args Namespace对象中。在optparse中,定位只是解析定义选项的剩余部分。通过省略您的参数并使用argparse

,您可以在parse_known_args中获得相同的效果
parser = argparse.ArgumentParser()
args, extras = parser.parse_known_args()

args现在是一个命名空间,extras是一个列表。然后,您可以将您的功能称为:

myfoo(*extras, **vars(args))

例如:

In [994]: import argparse
In [995]: def foo(*args, **kwargs):
   .....:     print(args)
   .....:     print(kwargs)
   .....:     
In [996]: parser=argparse.ArgumentParser()
In [997]: parser.add_argument('-f','--foo')
Out[997]: _StoreAction(option_strings=['-f', '--foo'], dest='foo', nargs=None, const=None, default=None, type=None, choices=None, help=None, metavar=None)
In [998]: args,extras = parser.parse_known_args(['-f','foobar','arg1','arg2'])
In [999]: args
Out[999]: Namespace(foo='foobar')
In [1000]: extras
Out[1000]: ['arg1', 'arg2']
In [1001]: foo(*extras, **vars(args))
('arg1', 'arg2')
{'foo': 'foobar'}

相同的argparse段显示您可以定义自己的Namespace类。定义一个行为类似于字典(用作**args)和命名空间的字符串并不难。所有argparse要求的是它适用于getattrsetattr

In [1002]: getattr(args,'foo')
Out[1002]: 'foobar'
In [1004]: setattr(args,'bar','ugg')
In [1005]: args
Out[1005]: Namespace(bar='ugg', foo='foobar')

另一个标准Python功能让我将vars(args)作为元组传递:

In [1013]: foo(*vars(args).items())
(('foo', 'foobar'), ('bar', 'ugg'))
{}

对于去年1月的类似答案:https://stackoverflow.com/a/34932478/901925

Neatly pass positional arguments as args and optional arguments as kwargs from argpase to a function

在那里,我提出了如何在解析后将“位置”与“选项”分开的想法。

这是一个自定义命名空间类,在其API中包含一种将自身作为字典返回的方法:

In [1014]: class MyNameSpace(argparse.Namespace):
   ......:     def asdict(self):
   ......:         return vars(self)
   ......:     
In [1015]: args = parser.parse_args(['-f','foobar'], namespace=MyNameSpace())
In [1016]: args
Out[1016]: MyNameSpace(foo='foobar')
In [1017]: foo(**args.asdict())
()
{'foo': 'foobar'}

另一个想法 - 使用多个nargs(2,'*','+')中的一个作为位置参数。然后,在将其传递给函数时,只需要输入一个名称。

parser.add_argument('pos',nargs='+')
args = ...
args.pos # a list, possibly empty
foo(*args.pos, **vars(args))

答案 2 :(得分:5)

做什么错误

if __name__ == '__main__':
    # do argparse stuff as above
    main(args)

那就是,你为什么如此忙于提出main()位置论证?

老实说,我通常会在模块的开头解析a)[for small scripts etc.],它为我提供了一个在所有函数范围内的变量或b)[通常]在里面main()如果我使用你的习语:

def parse_arguments():
    parser = argparse.ArgumentParser()
    parser.add_argument('arg1')
    parser.add_argument('arg2')
    args = parser.parse_args()
    return args

def main():
    args = parse_arguments()
    # do stuff with args.arg1 and args.arg2