默认参数装饰器python

Question

Python 3.6

我正在尝试创建一个装饰器,它自动将参数的字符串指定为默认值.

如:

def example(one='one', two='two', three='three'):
    pass

相当于:

@DefaultArguments
def example(one, two, three):
    pass

这是我的尝试(不起作用..但..)DefaultArguments:

from inspect import Parameter, Signature, signature


class DefaultArguments(object):

    @staticmethod
    def default_signature(signature):
        def default(param):
            if param.kind in (Parameter.POSITIONAL_OR_KEYWORD, Parameter.POSITIONAL_ONLY):
                return param.replace(default=param.name)
            else:
                return param
        return Signature([default(param) for param in signature.parameters.values()])

    def __init__(self, func):
        self.func = func
        self.sig = self.default_signature(signature(func))

    def __call__(self, *args, **kwargs):
        arguments = self.sig.bind(*args, **kwargs)
        return self.func(arguments)

static方法default_signature为函数创建了所需的签名,但是我很难将新签名分配给函数.我正在尝试使用Signature.bind我已经阅读了文档,但我错过了一些东西.

编辑

结合Ashwini Chaudhary的回答:

from inspect import Parameter, Signature, signature

class DefaultArguments(object):

    @staticmethod
    def default_signature(signature):
        def default(param):
            if param.kind in (Parameter.POSITIONAL_OR_KEYWORD, Parameter.POSITIONAL_ONLY):
                return param.replace(default=param.name)
            else:
                return param
        return Signature([default(param) for param in signature.parameters.values()])

    def __init__(self, func):
        self.func = func
        self.sig = self.default_signature(signature(func))
        print(self.sig)

    def __call__(self, *args, **kwargs):
        ba = self.sig.bind(*args, **kwargs)
        ba.apply_defaults()
        return self.func(*ba.args, **ba.kwargs)

Answer 1

这似乎有效:

import inspect

def default_args(func):
    argspec = inspect.getfullargspec(func)

    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        unpassed_positional_args = argspec.args[len(args):]
        kwargs.update((a, a) for a in unpassed_positional_args if a not in kwargs)
        return func(*args, **kwargs)

    return wrapper

它依赖于你可以在python中通过关键字传递位置参数这一事实.例如,如果你有一个功能:

def foo(a, b):
    ...

您完全有权将其称为:

foo(b=1, a=2)

我的解决方案计算出你传递了多少位置参数并使用它来确定哪些位置参数未被传递.然后我将这些位置参数名称添加到kwargsdict中.

这里的很酷的事情是,如果有人需要这样的python2.x,他们只需要改变getfullargspec到getargspec它应该工作正常.

关于速度的说明:

将我的解决方案与Ashwini的优秀解释进行比较表明,简单的装饰器比使用Signature对象快了大约10倍:

@default_args
def foo(a, b, c):
    pass

@DefaultArguments
def bar(a, b, c):
    pass

@default_arguments
def qux(a, b, c):
    pass

import timeit
print(timeit.timeit('foo()', 'from __main__ import foo'))  # 1.72s
print(timeit.timeit('bar()', 'from __main__ import bar'))  # 17.4s
print(timeit.timeit('qux()', 'from __main__ import qux'))  # 17.6

他的解决方案实际上更新了__signature__函数(非常好).原则上,您可以采用Signature创建逻辑并将其添加到我的解决方案中以更新__signature__但保留argspec实际计算的样式逻辑...

Answer 2

将参数和关键字与签名绑定后，您需要apply_defaults在BoundArguments实例上调用以设置缺失参数的默认值。

此外，将使用BoundArguments'sargs和kwargs属性调用函数调用。

def __call__(self, *args, **kwargs):
    ba = self.sig.bind(*args, **kwargs)
    ba.apply_defaults()
    return self.func(*ba.args, **ba.kwargs)

演示：

>>> @DefaultArguments
... def example(one, two, three):
...         print(one, two, three)
...

>>> example()
one two three
>>> example('spam')
spam two three
>>> example(one='spam', three='eggs')
spam two eggs

您的代码的功能版本也更新了装饰函数的签名：

from functools import wraps
from inspect import Parameter, Signature, signature


def default_arguments(func):

    def default(param):
        if param.kind in (Parameter.POSITIONAL_OR_KEYWORD, Parameter.POSITIONAL_ONLY):
            param = param.replace(default=param.name)
        return param

    sig = Signature([default(param) for param in signature(func).parameters.values()])

    @wraps(func)
    def wrapper(*args, **kwargs):
        ba = sig.bind(*args, **kwargs)
        ba.apply_defaults()
        return func(*ba.args, **ba.kwargs)

    wrapper.__signature__ = sig
    return wrapper

演示：

>>> from inspect import getfullargspec    
>>> @default_arguments
... def example(one, two, three):
...         print(one, two, three)
...

>>> getfullargspec(example)
FullArgSpec(
    args=['one', 'two', 'three'],
    varargs=None,
    varkw=None,
    defaults=('one', 'two', 'three'),
    kwonlyargs=[], kwonlydefaults=None, annotations={}
)