你能列出函数接收的关键字参数吗？

Question

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

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

这工作正常，但是如果 d_args 字典中存在

example

函数不接受的值，它显然会死掉..比如说，如果示例函数定义为

def example(kw2):

这是一个问题，因为我无法控制

d_args

或

example

函数的生成。它们都来自外部模块，并且

example

只接受字典中的一些关键字参数..

理想情况下我会这样做

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

我可能只会从有效关键字参数列表中过滤字典，但我想知道：有没有一种方法可以以编程方式列出特定函数所采用的关键字参数？

Answer 1

使用检查模块比直接检查代码对象并计算变量更好一点。

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

如果您想知道它是否可以使用一组特定的参数进行调用，则需要未指定默认值的参数。这些可以通过以下方式获得：

def get_required_args(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 missing_args(func, argdict):
    return set(get_required_args(func)).difference(argdict)

同样，要检查无效参数，请使用：

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

因此，如果它是可调用的，完整的测试是：

def is_callable_with_args(func, argdict):
    return not missing_args(func, argdict) and not invalid_args(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]

这是因为第一个

co_varnames

始终是参数（接下来是局部变量，如上例中的

y

）。

现在你可以拥有一个函数了：

def get_valid_args(func, args_dict):
    '''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 args_dict.iteritems() 
                if key in validArgs)

然后你可以像这样使用：

>>> func(**get_valid_args(func, args))

---

如果您确实只需要函数的关键字参数，则可以使用

func_defaults

属性来提取它们：

def get_valid_kwargs(func, args_dict):
    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 args_dict.iteritems() 
                if key in validKwargs)

您现在可以使用已知的参数调用函数，但提取了 kwargs，例如：

func(param1, param2, **get_valid_kwargs(func, kwargs_dict))

这假设

func

在其签名中不使用

*args

或

**kwargs

魔法。

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']

，类似地，对于使用

p.VAR_POSITIONAL

的 var 位置和使用

VAR_KEYWORD

的 var 关键字。

此外，您可以在 if 中添加一个子句，通过检查

p.default

是否等于

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={})

Answer 5

只需将其用作函数名称“myfun”：

myfun.__code__.co_varnames

Answer 6

扩展DzinX的答案：

argnames = example.func_code.co_varnames[:func.func_code.co_argcount]
args = dict((key, val) for key,val in d_args.iteritems() if key in argnames)
example(**args)

Answer 7

没有经过太多测试，但这适用于我的情况：

import inspect


def example(arg_1: int, arg_2: list, arg_optional="Hello", *, kwarg, kwarg_optional="Hi"):
    pass


spec = inspect.getfullargspec(example)

args_required = spec.args
args_optional = args_required[-len(spec.defaults or []):]
args_required = args_required[:-len(args_optional)]

kwargs_required, kwargs_optional = spec.kwonlyargs, (spec.kwonlydefaults or {})
kwargs_required = [key for key in kwargs_required if key not in kwargs_optional]

unlimited_args, unlimited_kwargs = bool(spec.varargs), bool(spec.varkw)
annotations = spec.annotations

print(args_required, args_optional, kwargs_required, kwargs_optional, unlimited_args, unlimited_kwargs, annotations)