61

我正在尝试编写一个装饰器来进行日志记录:

def logger(myFunc):
    def new(*args, **keyargs):
        print 'Entering %s.%s' % (myFunc.im_class.__name__, myFunc.__name__)
        return myFunc(*args, **keyargs)

    return new

class C(object):
    @logger
    def f():
        pass

C().f()

我想打印这个:

Entering C.f

但相反,我收到此错误消息:

AttributeError: 'function' object has no attribute 'im_class'

大概这与 'logger' 中的 'myFunc' 的范围有关,但我不知道是什么。

4

9 回答 9

50

Claudiu 的答案是正确的,但您也可以通过从self参数中获取类名来作弊。这会在继承的情况下给出误导性的日志语句,但会告诉您正在调用其方法的对象的类。例如:

from functools import wraps  # use this to preserve function signatures and docstrings
def logger(func):
    @wraps(func)
    def with_logging(*args, **kwargs):
        print "Entering %s.%s" % (args[0].__class__.__name__, func.__name__)
        return func(*args, **kwargs)
    return with_logging

class C(object):
    @logger
    def f(self):
        pass

C().f()

正如我所说,如果您从父类继承了函数,这将无法正常工作。在这种情况下,你可能会说

class B(C):
    pass

b = B()
b.f()

Entering B.f在您真正想要获取消息的地方获取消息,Entering C.f因为那是正确的类。另一方面,这可能是可以接受的,在这种情况下,我会推荐这种方法而不是 Claudiu 的建议。

于 2008-11-20T18:08:33.400 回答
29

函数仅在运行时成为方法。也就是说,当你C.f得到一个绑定函数(和C.f.im_class is C)。在定义您的函数时,它只是一个普通函数,它不绑定到任何类。这个未绑定和分离的函数是由 logger 修饰的。

self.__class__.__name__将为您提供类的名称,但您也可以使用描述符以更通用的方式完成此操作。这种模式在一篇关于 Decorators 和 Descriptors 的博客文章中进行了描述,特别是您的 logger 装饰器的实现如下所示:

class logger(object):
    def __init__(self, func):
        self.func = func
    def __get__(self, obj, type=None):
        return self.__class__(self.func.__get__(obj, type))
    def __call__(self, *args, **kw):
        print 'Entering %s' % self.func
        return self.func(*args, **kw)

class C(object):
    @logger
    def f(self, x, y):
        return x+y

C().f(1, 2)
# => Entering <bound method C.f of <__main__.C object at 0x...>>

显然可以改进输出(例如,通过使用getattr(self.func, 'im_class', None)),但这种通用模式适用于方法和函数。但是它不适用于旧式课程(但不要使用那些;)

于 2008-11-20T23:16:51.123 回答
18

这里提出的想法非常好,但也有一些缺点:

  1. inspect.getouterframes并且args[0].__class__.__name__不适合普通函数和静态方法。
  2. __get__必须在一个被拒绝的类中@wraps
  3. @wraps本身应该更好地隐藏痕迹。

所以,我结合了这个页面的一些想法,链接,文档和我自己的头脑,
终于找到了一个解决方案,它缺乏上述所有三个缺点。

结果,method_decorator

  • 知道装饰方法绑定到的类。
  • 通过更正确地回答系统属性来隐藏装饰器跟踪functools.wraps()
  • 包含用于绑定未绑定实例方法、类方法、静态方法和普通函数的单元测试。

用法:

pip install method_decorator
from method_decorator import method_decorator

class my_decorator(method_decorator):
    # ...

有关使用详情,请参阅完整的单元测试

这里只是method_decorator类的代码:

class method_decorator(object):

    def __init__(self, func, obj=None, cls=None, method_type='function'):
        # These defaults are OK for plain functions
        # and will be changed by __get__() for methods once a method is dot-referenced.
        self.func, self.obj, self.cls, self.method_type = func, obj, cls, method_type

    def __get__(self, obj=None, cls=None):
        # It is executed when decorated func is referenced as a method: cls.func or obj.func.

        if self.obj == obj and self.cls == cls:
            return self # Use the same instance that is already processed by previous call to this __get__().

        method_type = (
            'staticmethod' if isinstance(self.func, staticmethod) else
            'classmethod' if isinstance(self.func, classmethod) else
            'instancemethod'
            # No branch for plain function - correct method_type for it is already set in __init__() defaults.
        )

        return object.__getattribute__(self, '__class__')( # Use specialized method_decorator (or descendant) instance, don't change current instance attributes - it leads to conflicts.
            self.func.__get__(obj, cls), obj, cls, method_type) # Use bound or unbound method with this underlying func.

    def __call__(self, *args, **kwargs):
        return self.func(*args, **kwargs)

    def __getattribute__(self, attr_name): # Hiding traces of decoration.
        if attr_name in ('__init__', '__get__', '__call__', '__getattribute__', 'func', 'obj', 'cls', 'method_type'): # Our known names. '__class__' is not included because is used only with explicit object.__getattribute__().
            return object.__getattribute__(self, attr_name) # Stopping recursion.
        # All other attr_names, including auto-defined by system in self, are searched in decorated self.func, e.g.: __module__, __class__, __name__, __doc__, im_*, func_*, etc.
        return getattr(self.func, attr_name) # Raises correct AttributeError if name is not found in decorated self.func.

    def __repr__(self): # Special case: __repr__ ignores __getattribute__.
        return self.func.__repr__()
于 2010-08-05T07:54:48.090 回答
7

似乎在创建类时,Python 创建了常规函数对象。之后它们只会变成未绑定的方法对象。知道这一点,这是我能找到做你想做的事的唯一方法:

def logger(myFunc):
    def new(*args, **keyargs):
        print 'Entering %s.%s' % (myFunc.im_class.__name__, myFunc.__name__)
        return myFunc(*args, **keyargs)

    return new

class C(object):
    def f(self):
        pass
C.f = logger(C.f)
C().f()

这将输出所需的结果。

如果您想将所有方法包装在一个类中,那么您可能需要创建一个 wrapClass 函数,然后您可以像这样使用它:

C = wrapClass(C)
于 2008-11-20T17:47:52.380 回答
6

类函数应始终将 self 作为其第一个参数,因此您可以使用它来代替 im_class。

def logger(myFunc):
    def new(self, *args, **keyargs):
        print 'Entering %s.%s' % (self.__class__.__name__, myFunc.__name__)
        return myFunc(self, *args, **keyargs)

    return new 

class C(object):
    @logger
    def f(self):
        pass
C().f()

起初我想使用self.__name__,但这不起作用,因为实例没有名称。您必须使用self.__class__.__name__来获取类的名称。

于 2008-11-20T18:05:01.410 回答
6

inspect我使用该库找到了另一个非常相似的问题的解决方案。当调用装饰器时,即使函数尚未绑定到类,您也可以检查堆栈并发现哪个类正在调用装饰器。您至少可以获取类的字符串名称,如果这就是您所需要的(可能还不能引用它,因为它正在创建)。然后你不需要在类创建后调用任何东西。

import inspect

def logger(myFunc):
    classname = inspect.getouterframes(inspect.currentframe())[1][3]
    def new(*args, **keyargs):
        print 'Entering %s.%s' % (classname, myFunc.__name__)
        return myFunc(*args, **keyargs)
    return new

class C(object):
    @logger
    def f(self):
        pass

C().f()

虽然这不一定比其他方法更好,但这是我在调用装饰器期间发现未来方法的类名的唯一方法。请注意不要在inspect库文档中保留对框架的引用。

于 2010-07-21T15:21:22.450 回答
3

Asa Ayers 的回答所示,您不需要访问类对象。值得知道的是,从 Python 3.3 开始,您还可以使用__qualname__,它为您提供了完全限定的名称:

>>> def logger(myFunc):
...     def new(*args, **keyargs):
...         print('Entering %s' % myFunc.__qualname__)
...         return myFunc(*args, **keyargs)
... 
...     return new
... 
>>> class C(object):
...     @logger
...     def f(self):
...         pass
... 
>>> C().f()
Entering C.f

这具有在嵌套类的情况下也可以工作的额外优势,如取自PEP 3155的示例所示:

>>> class C:
...   def f(): pass
...   class D:
...     def g(): pass
...
>>> C.__qualname__
'C'
>>> C.f.__qualname__
'C.f'
>>> C.D.__qualname__
'C.D'
>>> C.D.g.__qualname__
'C.D.g'

另请注意,在 Python 3 中该im_class属性已消失,因此如果您真的希望在装饰器中访问该类,则需要其他方法。我目前使用的方法涉及object.__set_name__并在我对“实例方法的 Python 装饰器可以访问该类吗?”的回答中进行了详细说明。

于 2019-01-22T21:26:06.987 回答
0

您还可以使用new.instancemethod()从函数创建实例方法(绑定或未绑定)。

于 2008-11-20T18:12:34.810 回答
0

当函数不知道它的类时,不要在定义时注入装饰代码,而是延迟运行此代码,直到函数被访问/调用。描述符对象有助于在访问/调用时后期注入自己的代码:

class decorated(object):
    def __init__(self, func, type_=None):
        self.func = func
        self.type = type_

    def __get__(self, obj, type_=None):
        return self.__class__(self.func.__get__(obj, type_), type_)

    def __call__(self, *args, **kwargs):
        name = '%s.%s' % (self.type.__name__, self.func.__name__)
        print('called %s with args=%s kwargs=%s' % (name, args, kwargs))
        return self.func(*args, **kwargs)

class Foo(object):
    @decorated
    def foo(self, a, b):
        pass

现在我们可以在访问时(__get__)和调用时(__call__)检查类。这种机制适用于普通方法以及静态|类方法:

>>> Foo().foo(1, b=2)
called Foo.foo with args=(1,) kwargs={'b': 2}

完整示例位于:https ://github.com/aurzenligl/study/blob/master/python-robotwrap/Example4.py

于 2018-01-28T20:47:57.100 回答