Question

考虑这个小例子：

import datetime as dt

class Timed(object):
    def __init__(self, f):
        self.func = f

    def __call__(self, *args, **kwargs):
        start = dt.datetime.now()
        ret = self.func(*args, **kwargs)
        time = dt.datetime.now() - start
        ret["time"] = time
        return ret

class Test(object):
    def __init__(self):
        super(Test, self).__init__()

    @Timed
    def decorated(self, *args, **kwargs):
        print(self)
        print(args)
        print(kwargs)
        return dict()

    def call_deco(self):
        self.decorated("Hello", world="World")

if __name__ == "__main__":
    t = Test()
    ret = t.call_deco()

打印

Hello
()
{'world': 'World'}

为什么self参数（应该是Test obj实例）不作为第一个参数传递给修饰函数decorated？

如果我手动执行，例如：

def call_deco(self):
    self.decorated(self, "Hello", world="World")

它按预期工作。但是如果我必须事先知道函数是否装饰，它就会破坏装饰器的整个目的。这里的模式是什么，或者我误解了什么？

Answer 1

<强> TL;博士

您可以通过将Timed类设为descriptor并从__get__返回部分应用的函数来解决此问题，该函数将Test对象应用为其中一个参数，像这样

class Timed(object):
    def __init__(self, f):
        self.func = f

    def __call__(self, *args, **kwargs):
        print(self)
        start = dt.datetime.now()
        ret = self.func(*args, **kwargs)
        time = dt.datetime.now() - start
        ret["time"] = time
        return ret

    def __get__(self, instance, owner):
        from functools import partial
        return partial(self.__call__, instance)

实际问题

引用decorator，

的Python文档

装饰器语法只是语法糖，以下两个函数定义在语义上是等价的：
def f(...):
    ...
f = staticmethod(f)

@staticmethod
def f(...):
    ...

所以，当你说，

@Timed
def decorated(self, *args, **kwargs):

实际上是

decorated = Timed(decorated)

只有函数对象被传递给Timed，它实际绑定的对象不会与它一起传递。所以，当你像这样调用它时

ret = self.func(*args, **kwargs)

self.func将引用未绑定的函数对象，并以Hello作为第一个参数调用它。这就是为什么self打印为Hello。

我该如何解决这个问题？

由于您没有引用Test中的Timed实例，唯一的方法是将Timed转换为描述符类 。引用文档Invoking descriptors部分，

通常，描述符是具有“绑定行为”的对象属性，其属性访问权已被描述符协议中的方法覆盖：__get__()，__set__()和__delete__() 。如果为对象定义了任何这些方法，则称其为描述符。

属性访问的默认行为是从对象的字典中获取，设置或删除属性。例如，a.x的查询链以a.__dict__['x']开头，然后是type(a).__dict__['x']，并继续通过type(a)的基类排除元类。

但是，如果查找的值是定义其中一个描述符方法的对象，则Python可以覆盖默认行为并调用描述符方法。

我们可以通过简单地定义像这样的方法来使Timed成为描述符

def __get__(self, instance, owner):
    ...

此处，self表示Timed对象本身，instance表示发生属性查找的实际对象，owner表示对应的类instance。

现在，在__call__上调用Timed时，将调用__get__方法。现在，不知何故，我们需要将第一个参数作为Test类的实例传递（甚至在Hello之前）。因此，我们创建另一个部分应用的函数，其第一个参数将是Test实例，如此

def __get__(self, instance, owner):
    from functools import partial
    return partial(self.__call__, instance)

现在，self.__call__是绑定方法（绑定到Timed实例），partial的第二个参数是self.__call__调用的第一个参数。

所以，所有这些都像这样有效地翻译

t.call_deco()
self.decorated("Hello", world="World")

现在self.decorated实际上是Timed(decorated)（从现在开始，这将被称为TimedObject）对象。每当我们访问它时，将调用其中定义的__get__方法，并返回partial函数。您可以像这样确认

def call_deco(self):
    print(self.decorated)
    self.decorated("Hello", world="World")

会打印

<functools.partial object at 0x7fecbc59ad60>
...

所以，

self.decorated("Hello", world="World")

被翻译为

Timed.__get__(TimedObject, <Test obj>, Test.__class__)("Hello", world="World")

因为我们返回partial函数，

partial(TimedObject.__call__, <Test obj>)("Hello", world="World"))

实际上是

TimedObject.__call__(<Test obj>, 'Hello', world="World")

因此，<Test obj>也成为*args的一部分，当调用self.func时，第一个参数将是<Test obj>。

Answer 2

首先，您必须了解how function become methods and how self is "automagically" injected。

一旦你知道了，＆＃34;问题＆＃34;很明显：您正在使用+=实例修饰decorated函数 - IOW，Timed是Test.decorated实例，而不是Timed实例 - 以及您的{ {1}}类不会模仿function类型Timed协议的实现。你想要的是这样的：

function

Answer 3

我以下列方式使用装饰器：

def timeit(method):
    def timed(*args, **kw):
        ts = time.time()
        result = method(*args, **kw)
        te = time.time()
        ts = round(ts * 1000)
        te = round(te * 1000)
        print('%r (%r, %r) %2.2f millisec' %
             (method.__name__, args, kw, te - ts))
        return result
    return timed


 class whatever(object):
    @timeit
    def myfunction(self):
         do something

如何使用装饰器类装饰实例方法？

3 个答案: