整齐地将位置参数作为 args 和可选参数作为 kwargs 从 argparse 传递给函数

Question

我想编写一个 Python 脚本，通过 argparse 获取一些必要的位置参数和一些可选的命令行参数：

• 让我们调用位置参数a,b,c，以及可选参数x,y,z。
• 在我的 Python 脚本中，我想将这些参数传递给一个函数；具体来说，我希望a,b,c 以*args 的形式传递，x,y,z 以**kwargs 的形式传递，后者保留其名称。
• 我想多次使用不同的函数和不同数量的位置参数和可选参数来执行此操作。是否有一种简洁、灵活和/或 Python 式的方式来执行此操作？

下面是一些示例代码：

import argparse

def parse():
    parser = argparse.ArgumentParser()
    parser.add_argument('a', help='1st arg')
    parser.add_argument('b', help='2nd arg')
    parser.add_argument('c', help='3rd arg')
    parser.add_argument('-x', '--x', help='1st kwarg')
    parser.add_argument('-y', '--y', help='2nd kwarg')
    parser.add_argument('-z', '--z', help='3rd kwarg')
    return parser.parse_args()

def func(*args, **kwargs):
    a, b, c = args
    print 'a=', a
    print 'b=', b
    print 'c=', c
    for k, v in kwargs.iteritems():
        print '%s=' % k, v

if __name__ == '__main__':

    all_args = parse()
    ### need to split all_args into args and kwargs here ###
    func(*args, **kwargs)

Answer 1

您从parse_args 返回的Namespace 将具有与您的每个参数相对应的属性。位置参数和可选参数之间没有区别，例如：

args
Namespace(a='1',b='one',x='foo', y=...)

正如有据可查的那样，可以通过以下方式访问：

args.a
args.x
etc.

Namespace也可以变成字典：

vars(args)
{'a'='1', 'b'='one', etc.}

您可以将字典作为**kwargs 传递给函数。这是标准的 Python 参数实践。

如果您想以*args 的形式传递一些参数，您必须自己将它们从Namespace 或字典中分离出来。 argparse 中的任何内容都不会为您做到这一点。

你可以写一个类似（未测试）的函数：

def split_args(args):
   vargs = vars(args)
   alist = ['a','b','c']
   args1 = []
   for a in alist:
        v = vargs.pop(a)
        args1.append(v)
   return args1, vars

或者更简洁，将pop 放入列表推导式中：

In [702]: vargs = dict(a=1,b=3,c=4,x=5,y=3,z=3)
In [703]: [vargs.pop(a) for a in ['a','b','c']]
Out[703]: [1, 3, 4]
In [704]: vargs
Out[704]: {'y': 3, 'x': 5, 'z': 3}

In [705]: def foo(*args,**kwargs):
   .....:     print(args)
   .....:     print(kwargs)
   .....:     
In [706]: vargs = dict(a=1,b=3,c=4,x=5,y=3,z=3)
In [707]: foo(*[vargs.pop(a) for a in ['a','b','c']],**vargs)
(1, 3, 4)
{'x': 5, 'z': 3, 'y': 3}

使用自定义 Action 类的进一步想法

parser 通过其option_strings 属性确定参数是optional 还是positional。 add_argument 返回一个 Action 子类，其属性如下：

MyAction(option_strings=[], dest='baz', nargs=None, const=None, default=None, type=None, choices=None, help=None, metavar=None)

这是一个positional，因为option_strings 是一个空列表。

MyAction(option_strings=['-m', '--mew'], dest='mew', nargs=None,...)

是optional，因为该列表不为空。

解析器将输入字符串与option_strings 和nargs 匹配，然后将值传递给匹配Action 的__call__ 方法。该方法的定义如下：

def __call__(self, parser, namespace, values, option_string=None):
    setattr(namespace, self.dest, values)

这是默认的store 操作。这些值作为dest 属性放在Namespace 中。

option_string 参数是触发此调用的字符串，类似于“-m”或“--mew”，或者None 代表positional。定义的动作类型不使用这个，但用户定义的动作类可以做一些事情。

class MyAction(argparse._StoreAction):
   def __call__(self, parser, namespace, values, option_string=None):
       # store option_string along with values in the Namespace
       setattr(namespace, self.dest, [values,option_string])

或者你可以用positionals做一些特别的事情，例如

       if option_string is None:
           # append values to a `star_args` attribute
           # rather than self.dest

像positionals 这样的操作可以在解析为：

args.star_args

解析器确实维护了这样的列表属性。 parse_known_args 返回的extras 临时存储在“_UNRECOGNIZED_ARGS_ATTR”属性的Namespace 中。