带有@ syntax的python decorator参数

时间:2014-03-08 16:27:33

标签: python decorator python-decorators

我正在尝试使用可以接受参数的缓存属性装饰器。

我查看了这个实现:http://www.daniweb.com/software-development/python/code/217241/a-cached-property-decorator

from functools import update_wrapper 

def cachedProperty (func ,name =None ):
  if name is None :
    name =func .__name__ 
  def _get (self ):
    try :
      return self .__dict__ [name ]
    except KeyError :
      value =func (self )
      self .__dict__ [name ]=value 
      return value 
  update_wrapper (_get ,func )
  def _del (self ):
    self .__dict__ .pop (name ,None )
  return property (_get ,None ,_del )

但我遇到的问题是,如果我想使用参数,我不能用@语法调用装饰器:

@cachedProperty(name='test') # This does NOT work
def my_func(self):
    return 'ok'

# Only this way works
cachedProperty(my_func, name='test')

如何在装饰器参数中使用@语法?

由于

1 个答案:

答案 0 :(得分:7)

你需要一个装饰工厂生成装饰器的另一个包装器:

from functools import wraps 

def cachedProperty(name=None):
    def decorator(func):
        if decorator.name is None:
            decorator.name = func.__name__ 
        @wraps(func)
        def _get(self):
            try:
                return self.__dict__[decorator.name]
            except KeyError:
                value = func(self)
            self.__dict__[decorator.name] = value 
            return value 
        def _del(self):
            self.__dict__.pop(decorator.name, None)
        return property(_get, None, _del)
    decorator.name = name
    return decorator

将此用作:

@cachedProperty(name='test')
def my_func(self):
    return 'ok'

装饰者真的只是语法糖:

def my_func(self):
    return 'ok'
my_func = cachedProperty(name='test')(my_func)

所以只要@之后的表达式返回你的装饰器 [*] ,表达式本身实际上做什么并不重要。

在上面的示例中,@cachedProperty(name='test')部分首先执行cachedProperty(name='test'),并且该调用的返回值用作装饰器。在上面的示例中,返回decorator,因此通过调用my_func来装饰decorator(my_func)函数,并且该调用的返回值为property对象,这就是'll替换my_func


[*] @表达式语法故意限制允许执行的程度。你可以进行属性查找和调用,就是这样,decorator grammar rule只允许带点参数的可选调用(点是可选的):

decorator               ::=  "@" dotted_name ["(" [argument_list [","]] ")"] NEWLINE)

这是语法的deliberate limitation