装饰器使用Python应用于类定义

时间:2010-10-05 02:51:28

标签: python decorator

与应用于函数的装饰器相比,理解应用于类的装饰器并不容易。

@foo
class Bar(object):
    def __init__(self, x):
        self.x = x
    def spam(self):
        statements

装饰器对类的用例是什么?怎么用?

2 个答案:

答案 0 :(得分:23)

它以更简单的方式取代了自定义元类的绝大多数经典用途。

以这种方式思考:直接在类体中的任何东西都不能引用类对象,因为类对象直到body完成运行之后才存在(这是元类创建类对象的工作 - 对于没有自定义元类的所有类,通常为type

但是,类装饰器中的代码在创建类对象之后运行(事实上,将类对象作为参数!),因此可以很好地引用该类对象(通常需要这样做。)

例如,考虑:

def enum(cls):
  names = getattr(cls, 'names', None)
  if names is None:
    raise TypeError('%r must have a class field `names` to be an `enum`!',
                    cls.__name__)
  for i, n in enumerate(names):
    setattr(cls, n, i)
  return cls

@enum
class Color(object):
  names = 'red green blue'.split()

现在您可以参考Color.redColor.green和& c,而不是01等。(当然,您通常会添加偶数更多功能来制作“enum”,但在这里我只是展示了在类装饰器中添加此类功能的简单方法,而不是需要自定义元类! - )

答案 1 :(得分:6)

我能想到的一个用例是你想用一个函数装饰器包装一个类的所有方法。假设您有以下装饰者:

def logit(f):
    def res(*args, **kwargs):
        print "Calling %s" % f.__name__
        return f(*args, **kwargs)
    return res

以下课程:

>>> class Pointless:
    def foo(self): print 'foo'
    def bar(self): print 'bar'
    def baz(self): print 'baz'

>>> p = Pointless()
>>> p.foo(); p.bar(); p.baz()
foo
bar
baz

您可以装饰所有方法:

>>> class Pointless:
    @logit
    def foo(self): print 'foo'
    @logit
    def bar(self): print 'bar'
    @logit
    def baz(self): print 'baz'

>>> p = Pointless()
>>> p.foo(); p.bar(); p.baz()
Calling foo
foo
Calling bar
bar
Calling baz
baz

但那就是LAME!相反,你可以这样做:

>>> def logall(cls):
for a in dir(cls):
    if callable(getattr(cls, a)):
        setattr(cls, a, logit(getattr(cls, a)))
return cls

>>> @logall
class Pointless:
    def foo(self): print 'foo'
    def bar(self): print 'bar'
    def baz(self): print 'baz'

>>> p = Pointless()
>>> p.foo(); p.bar(); p.baz()
Calling foo
foo
Calling bar
bar
Calling baz
baz

更新:logall的更通用版本:

>>> def wrapall(method):
    def dec(cls):
        for a in dir(cls):
            if callable(getattr(cls, a)):
                setattr(cls, a, method(getattr(cls, a)))
        return cls
    return dec

>>> @wrapall(logit)
class Pointless:
        def foo(self): print 'foo'
        def bar(self): print 'bar'
        def baz(self): print 'baz'

>>> p = Pointless()
>>> p.foo(); p.bar(); p.baz()
Calling foo
foo
Calling bar
bar
Calling baz
baz
>>> 

完全披露:我从来没有这样做,我只是举起了这个例子。