虽然我喜欢认为自己是一个相当称职的Python程序员,但我始终无法理解该语言的一个方面是装饰器。

我知道它们是什么(表面上),我读过教程,例子,关于Stack Overflow的问题,我理解语法,可以自己写,偶尔使用@classmethod和@staticmethod,但我从来没有想过在我自己的Python代码中使用装饰器来解决问题。我从来没有遇到过这样的问题:“嗯……这看起来像是装修师的工作!”

所以,我想知道你们是否可以提供一些在你们自己的程序中使用装饰器的例子,希望我能有一个“啊哈!”的时刻,并得到它们。


当前回答

一个明显的用途当然是日志记录:

import functools

def log(logger, level='info'):
    def log_decorator(fn):
        @functools.wraps(fn)
        def wrapper(*a, **kwa):
            getattr(logger, level)(fn.__name__)
            return fn(*a, **kwa)
        return wrapper
    return log_decorator

# later that day ...
@log(logging.getLogger('main'), level='warning')
def potentially_dangerous_function(times):
    for _ in xrange(times): rockets.get_rocket(NUCLEAR=True).fire()

其他回答

我主要使用它们来调试(打印函数的参数和结果的包装)和验证(例如,检查参数的类型是否正确,或者在web应用程序的情况下,用户是否有足够的权限调用特定的方法)。

装饰器用于您希望透明地“包装”附加功能的任何内容。

Django使用它们在视图函数中包装“登录必需”的功能,以及注册过滤器函数。

可以使用类装饰器将命名日志添加到类中。

任何可以“附加”到现有类或函数行为上的足够通用的功能都可以用作装饰。

在Python-Dev新闻组中也有关于用例的讨论,PEP 318—函数和方法的装饰器。

我使用装饰器主要是为了计时

def time_dec(func):

  def wrapper(*arg):
      t = time.clock()
      res = func(*arg)
      print func.func_name, time.clock()-t
      return res

  return wrapper


@time_dec
def myFunction(n):
    ...

装饰器既可以用来定义函数的属性,也可以用作修改函数的样板;它们可能返回完全不同的函数,但这是违反直觉的。看看这里的其他响应,最常见的用途之一似乎是限制一些其他进程的范围——无论是日志记录、概要分析、安全检查等等。

CherryPy使用对象调度将url匹配到对象,并最终匹配到方法。这些方法上的装饰符表示是否允许CherryPy使用这些方法。例如,改编自教程:

class HelloWorld:

    ...

    def secret(self):
        return "You shouldn't be here."

    @cherrypy.expose
    def index(self):
        return "Hello world!"

cherrypy.quickstart(HelloWorld())

装饰器可以用来轻松地创建函数方法变量。

def static_var(varname, value):
    '''
    Decorator to create a static variable for the specified function
    @param varname: static variable name
    @param value: initial value for the variable
    '''
    def decorate(func):
        setattr(func, varname, value)
        return func
    return decorate

@static_var("count", 0)
def mainCallCount():
    mainCallCount.count += 1