你能列出一个函数收到的关键字参数吗？

Question

我有一个字典,我需要传递键/值作为关键字参数..例如..

d_args = {'kw1': 'value1', 'kw2': 'value2'}
example(**d_args)

这样可以正常工作,但是如果d_args dict中的值没有被example函数接受,它显然会死掉..比如说,如果示例函数定义为def example(kw2):

这是一个问题,因为我不控制生成d_args或example函数..它们都来自外部模块,example只接受来自dict的一些关键字参数.

理想情况下我会这样做

parsed_kwargs = feedparser.parse(the_url)
valid_kwargs = get_valid_kwargs(parsed_kwargs, valid_for = PyRSS2Gen.RSS2)
PyRSS2Gen.RSS2(**valid_kwargs)

我可能只是从有效的关键字参数列表中过滤掉dict,但我想知道:有没有办法以编程方式列出特定函数所需的关键字参数？

Answer 1

比直接检查代码对象和计算变量要好一点就是使用inspect模块.

>>> import inspect
>>> def func(a,b,c=42, *args, **kwargs): pass
>>> inspect.getargspec(func)
(['a', 'b', 'c'], 'args', 'kwargs', (42,))

如果你想知道它是否可以用一组特定的args调用,你需要没有指定默认值的args.这些可以通过:

def getRequiredArgs(func):
    args, varargs, varkw, defaults = inspect.getargspec(func)
    if defaults:
        args = args[:-len(defaults)]
    return args   # *args and **kwargs are not required, so ignore them.

然后,一个函数告诉你特定字典中缺少的是:

def missingArgs(func, argdict):
    return set(getRequiredArgs(func)).difference(argdict)

同样,要检查无效的args,请使用:

def invalidArgs(func, argdict):
    args, varargs, varkw, defaults = inspect.getargspec(func)
    if varkw: return set()  # All accepted
    return set(argdict) - set(args)

因此,如果它是可调用的完整测试是:

def isCallableWithArgs(func, argdict):
    return not missingArgs(func, argdict) and not invalidArgs(func, argdict)

(只有python的arg解析才有用.显然无法检测到kwargs中无效值的任何运行时检查.)

Answer 2

这将打印所有可通过参数的名称,关键字和非关键字参数:

def func(one, two="value"):
    y = one, two
    return y
print func.func_code.co_varnames[:func.func_code.co_argcount]

这是因为first co_varnames始终是参数(接下来是局部变量,y如上例所示).

所以现在你可以有一个功能:

def getValidArgs(func, argsDict):
    '''Return dictionary without invalid function arguments.'''
    validArgs = func.func_code.co_varnames[:func.func_code.co_argcount]
    return dict((key, value) for key, value in argsDict.iteritems() 
                if key in validArgs)

你可以这样使用:

>>> func(**getValidArgs(func, args))

编辑:一个小小的补充:如果你真的只需要一个函数的关键字参数,你可以使用该func_defaults属性来提取它们:

def getValidKwargs(func, argsDict):
    validArgs = func.func_code.co_varnames[:func.func_code.co_argcount]
    kwargsLen = len(func.func_defaults) # number of keyword arguments
    validKwargs = validArgs[-kwargsLen:] # because kwargs are last
    return dict((key, value) for key, value in argsDict.iteritems() 
                if key in validKwargs)

你现在可以用已知的args调用你的函数,但是提取的kwargs,例如:

func(param1, param2, **getValidKwargs(func, kwargsDict))

这假定在其签名中func使用no *args或**kwargsmagic.

Answer 3

对于 Python 3 解决方案，您可以inspect.signature根据您想了解的参数类型来使用和过滤。

取一个带有位置或关键字、仅关键字、var 位置和 var 关键字参数的示例函数：

def spam(a, b=1, *args, c=2, **kwargs):
    print(a, b, args, c, kwargs)

您可以为它创建一个签名对象：

from inspect import signature
sig =  signature(spam)

然后使用列表理解进行过滤以找出您需要的详细信息：

>>> # positional or keyword
>>> [p.name for p in sig.parameters.values() if p.kind == p.POSITIONAL_OR_KEYWORD]
['a', 'b']
>>> # keyword only
>>> [p.name for p in sig.parameters.values() if p.kind == p.KEYWORD_ONLY]
['c']

并且，类似地，对于 var positionals usingp.VAR_POSITIONAL和 var 关键字 with VAR_KEYWORD。

此外，您可以在 if 中添加一个子句，通过检查 if p.defaultequals来检查默认值是否存在p.empty。

Answer 4

在Python 3.0中:

>>> import inspect
>>> import fileinput
>>> print(inspect.getfullargspec(fileinput.input))
FullArgSpec(args=['files', 'inplace', 'backup', 'bufsize', 'mode', 'openhook'],
varargs=None, varkw=None, defaults=(None, 0, '', 0, 'r', None), kwonlyargs=[], 
kwdefaults=None, annotations={})