Python装饰器处理装饰函数

时间:2016-05-30 04:26:01

标签: python decorator python-decorators

我想为类方法创建一个'缓存'装饰器,它在内部类属性中注册方法的结果,以避免多次计算它(我不想使用一个简单的属性,在__init__,因为我不确定是否一直计算它。

第一个想法是创建一个类似于此的装饰器“缓存”:

def cache(func):
    name = "_{:s}".format(func.__name__)
    def wrapped(obj):
        if not hasattr(obj, name) or getattr(obj, name) is None:
            print "Computing..."
            setattr(obj, name, func(obj))
        else:
            print "Already computed!"
        return getattr(obj, name)
    return wrapped

class Test:
    @cache
    def hello(self):
        return 1000 ** 5

一切正常:

In [121]: t = Test()

In [122]: hasattr(t, '_hello')
Out[122]: False

In [123]: t.hello()
Computing...
Out[123]: 1000000000000000

In [124]: t.hello()
Already computed!
Out[124]: 1000000000000000

In [125]: hasattr(t, '_hello')
Out[125]: True

现在让我们说我想做同样的事情,但是当用参数调用方法时(keyworded和/或没有)。 当然,现在我们将结果存储在不同的属性中(名称是什么?...),但是在字典中,其键由* args和** kwargs组成。让我们用元组来做:

def cache(func):
    name = "_{:s}".format(func.__name__)
    def wrapped(obj, *args, **kwargs):
        if not hasattr(obj, name) or getattr(obj, name) is None:
            setattr(obj, name, {})
        o = getattr(obj, name)
        a = args + tuple(kwargs.items())
        if not a in o:
            print "Computing..."
            o[a] = func(obj, *args, **kwargs)
        else:
            print "Already computed!"
        return o[a]
    return wrapped

class Test:
    @cache
    def hello(self, *args, **kwargs):
        return 1000 * sum(args) * sum(kwargs.values())

In [137]: t = Test()

In [138]: hasattr(t, '_hello')
Out[138]: False

In [139]: t.hello()
Computing...
Out[139]: 0

In [140]: hasattr(t, '_hello')
Out[140]: True

In [141]: t.hello(3)
Computing...
Out[141]: 0

In [142]: t.hello(p=3)
Computing...
Out[142]: 0

In [143]: t.hello(4, y=23)
Computing...
Out[143]: 92000

In [144]: t._hello
Out[144]: {(): 0, (3,): 0, (4, ('y', 23)): 92000, (('p', 3),): 0}

由于方法items在不考虑字典中的顺序的情况下转换元组中的字典这一事实,如果不按相同的顺序调用keyworded参数,它将完美地运行:

In [146]: t.hello(2, a=23,b=34)
Computing...
Out[146]: 114000

In [147]: t.hello(2, b=34, a=23)
Already computed!
Out[147]: 114000

这是我的问题:如果方法有默认参数,那么它就不再起作用了:

class Test:
    @cache
    def hello(self, a=5):
        return 1000 * a

现在它不再起作用了:

In [155]: t = Test()

In [156]: t.hello()
Computing...
Out[156]: 5000

In [157]: t.hello(a=5)
Computing...
Out[157]: 5000

In [158]: t.hello(5)
Computing...
Out[158]: 5000

In [159]: t._hello
Out[159]: {(): 5000, (5,): 5000, (('a', 5),): 5000}

结果计算3次,因为参数的赋值方式不同(即使它们是“相同的”参数!)。

有人知道如何在装饰器内捕获赋予函数的“默认”值吗?

谢谢

2 个答案:

答案 0 :(得分:1)

根据参数的复杂程度,可以有各种解决方案。功能结构。我更喜欢的解决方案是将内部函数添加到hello中。如果您不想更改缓存的名称,请为其指定外部函数的名称:

class Test:
    def hello(self, a=5):
        @cache
        def hello(self, a):
            return 1000 * a
        return hello(self, a)

t = Test()
t.hello()
t.hello(a=5)
t.hello(5)
t._hello

Out[111]: Computing...
Already computed!
Already computed!
{(5,): 5000}

另一种方法是在decorator中添加对默认变量的检查,例如:

def cache(func):
    name = "_{:s}".format(func.__name__)
    def wrapped(obj, *args, **kwargs):
        if not hasattr(obj, name) or getattr(obj, name) is None:
            setattr(obj, name, {})
        o = getattr(obj, name)
        a = args + tuple(kwargs.items())
        if func.func_defaults: # checking if func have default variable
            for k in kwargs.keys():
                if k in func.func_code.co_varnames and kwargs[k] == func.func_defaults[0]:
                    a = ()
            if args:
                if args[0] == func.func_defaults[0]:
                    a = ()
        if not a in o:
            print "Computing..."
            o[a] = func(obj, *args, **kwargs)
        else:
            print "Already computed!"
        return o[a]
    return wrapped

class Test:
    @cache
    def hello(self, a=5):
        return 1000 * a

t = Test()
t.hello()
t.hello(a=5)
t.hello(5)
t._hello

Out[112]: Computing...
Already computed!
Already computed!
{(): 5000}

如果你有,例如2个默认变量,第一个代码(带内部函数)仍然可以工作,而第二个代码需要更改"默认变量检查规则"。

答案 1 :(得分:1)

如果您使用的是最新版本的Python,则可以使用inspect.signature来获取完全封装函数参数信息的Signature对象。然后,您可以使用您的包装器传递的参数调用其bind方法,以获取BoundArguments对象。调用apply_defaults上的BoundArguments方法填写缺省值的任何缺失参数,并检查arguments有序字典,以查看函数参数的明确列表及其值这个电话:

import inspect

def cache(func):
    name = "_{:s}".format(func.__name__)
    sig = inspect.signature(func)
    def wrapped(obj, *args, **kwargs):
        cache_dict = getattr(obj, name, None)
        if cache_dict is None:
            cache_dict = {}
            setattr(obj, name, cache_dict)    
        bound_args = sig.bind(obj, *args, **kwargs)
        bound_args.apply_defaults()
        cache_key = tuple(bound_args.arguments.values())
        if not cache_key in cache_dict:
            print("Computing...")
            cache_dict[cache_key] = func(obj, *args, **kwargs)
        else:
            print("Already computed!")
        return cache_dict[cache_key]
    return wrapped

请注意,我重命名了您的ao变量以获得更有意义的名称。我也改变了在对象上设置缓存字典的方式。更少getattrsetattr这样称呼!

在Python 3.3中添加了inspect.signature函数和相关类型,但apply_defaults对象上的BoundArguments方法是Python 3.5中的新方法。对于较旧的Python版本on PyPi,有一个基本功能的后退端口,但它似乎还不包括apply_defaults。我将在backport的github tracker上报告这个问题。