一、前言

学习python的过程中，装饰器的概念我一直没有明白。看过很多文章，但是讲的都不是很透彻。后来在菜鸟教程看到了这篇文章，我才搞懂了装饰器到底是做什么的。这篇博客讲的很细致，从函数的调用一点点的讲解。现在把这篇文章转到我的博客，做个备份。文章内容有一些改动，改动的地方主要是描述，代码改动不多。

二、文章来源

Python进阶

三、什么是装饰器

装饰器是对函数的封装，用来实现修改函数功能的函数。 下面通过一些例子来说明什么是装饰器。

1. 一切皆对象

在python中一切皆是对象，所以函数，类均可以赋值给变量。

#!/usr/bin/env python

def hi(name="yasoob"): 
    return "hi " + name 

print(hi())
# output: 'hi yasoob'

# 我们甚至可以将一个函数赋值给一个变量，比如 
greet = hi
# 我们这里没有在使用小括号，因为我们并不是在调用hi函数，而是将函数赋值给变量。

#我们尝试运行下这个:
print(greet()) 
# output: 'hi yasoob' 

# 如果我们删掉旧的hi函数，看看会发生什么！ 
del hi 
print(hi()) 
#outputs: NameError 

print(greet()) 
#outputs: 'hi yasoob'

#函数删除以后，可以看到旧删除不可以在调用。但是新赋值的变量还是可以调用。

2. 在函数中定义函数

在python中，可以在函数中定义函数和调用函数

#!/usr/bin/env python

def hi(name="yasoob"): 
    print("now you are inside the hi() function") 

    def greet(): 
        return "now you are in the greet() function" 

    def welcome(): 
        return "now you are in the welcome() function" 

    print(greet())
    print(welcome()) 
    print("now you are back in the hi() function") 

hi() 
#output:now you are inside the hi() function 
#       now you are in the greet() function 
#       now you are in the welcome() function 
#       now you are back in the hi() function 
# 上面展示了无论何时你调用hi(), greet()和welcome()将会同时被调用。

# greet()和welcome()函数在hi()函数之外是不能访问的，比如：
greet() 
#outputs: NameError: name 'greet' is not defined

3. 从函数中返回函数

既然python中一切都是对象，那在函数中定义的函数，也可以作为输出返回出来。

#!/usr/bin/env python

def hi(name="yasoob"): 
    def greet(): 
        return "now you are in the greet() function" 

    def welcome():
        return "now you are in the welcome() function" 

    if name == "yasoob": 
        return greet 
    else: 
        return welcome 

a = hi() 
print(a) 
#outputs: <function greet at 0x7f2143c01500> 
#上面清晰地展示了`a`现在指向到hi()函数中的greet()函数 

#现在试试这个 
print(a()) 
#outputs: now you are in the greet() function

通过上面的代码可以看到，hi函数返回的是hi函数中的greet函数。在返回的配置中，我们写的是greet和welcome。这样写是因为，函数名称后面跟小括号，就代表调用函数，函数会执行，并把函数执行的结果赋值或返回。如果函数名称后面不跟小括号，则函数不执行，只是把函数赋值或返回。

上面函数的执行过程 a = hi(), hi函数会被执行，由于没有传递参数，形参name使用的默认值”yasoob”，所以hi最后返回的是greet函数。

4. 将函数作为参数传给另一个函数

#!/usr/bin/env python

def hi(): 
    return "hi yasoob!" 

def doSomethingBeforeHi(func): 
    print("I am doing some boring work before executing hi()") 
    print(func()) 

doSomethingBeforeHi(hi)
#outputs:I am doing some boring work before executing hi() 
# hi yasoob!

上面的程序中，将hi这个函数做为参数传递给了doSomethingBeforeHi函数。在doSomethingBeforeHi函数内容调用了hi此函数。

5. 第一个装饰器

上面的程序例子就是python装饰器的原理，下面我们通过一个更详细的例子学习。

#!/usr/bin/env python

def a_new_decorator(a_func):

    def wrapTheFunction():
        print("I am doing some boring work before executing a_func()")

        a_func()

        print("I am doing some boring work after executing a_func()")

    return wrapTheFunction

def a_function_requiring_decoration():
    print("I am the function which needs some decoration to remove my foul smell")

a_function_requiring_decoration()
#outputs: "I am the function which needs some decoration to remove my foul smell"

a_function_requiring_decoration = a_new_decorator(a_function_requiring_decoration)
#now a_function_requiring_decoration is wrapped by wrapTheFunction()

a_function_requiring_decoration()
#outputs:I am doing some boring work before executing a_func()
#        I am the function which needs some decoration to remove my foul smell
#        I am doing some boring work after executing a_func()

定义两个函数a_new_decorator和a_function_requiring_decoration，a_new_decorator中又定义了一个函数wrapTheFunction。
a_function_requiring_decoration = a_new_decorator(a_function_requiring_decoration)中调用a_new_decorator函数，并把a_function_requiring_decoration函数作为参数传递给a_new_decorator函数。
a_new_decorator函数执行以后，返回了a_new_decorator函数中定义的函数wrapTheFunction赋值给a_function_requiring_decoration。
调用a_function_requiring_decoration函数，然后执行wrapTheFunction中的输出和调用函数。

上面的程序就是装饰器详细的原理。装饰器封装一个函数，在执行函数前做一些操作。上面的代码中为了显示原理所以没有使用@，使用@以后的代码如下:

#!/usr/bin/env python

def a_new_decorator(a_func):

    def wrapTheFunction():
        print("I am doing some boring work before executing a_func()")

        a_func()

        print("I am doing some boring work after executing a_func()")

    return wrapTheFunction

@a_new_decorator
def a_function_requiring_decoration():
    print("I am the function which needs some decoration to remove my foul smell")

a_function_requiring_decoration()
#outputs: I am doing some boring work before executing a_func()
#         I am the function which needs some decoration to remove my foul smell
#         I am doing some boring work after executing a_func()

#the @a_new_decorator is just a short way of saying:
a_function_requiring_decoration = a_new_decorator(a_function_requiring_decoration)

使用了装饰器以后，我们在调用函数的__name__方法的时候，返回的名称不再是函数的名称，而是装饰器中最后返回函数的名称。

print(a_function_requiring_decoration.__name__)
# Output: wrapTheFunction

比如前面的程序调用函数名称，返回的就是：wrapTheFunction，而我们想要的是a_function_requiring_decoration。这个可以通过python提供的functools.wraps函数来解决。

修改前面程序的代码:

#!/usr/bin/env python

from functools import wraps

def a_new_decorator(a_func):
    @wraps(a_func)
    def wrapTheFunction():
        print("I am doing some boring work before executing a_func()")
        a_func()
        print("I am doing some boring work after executing a_func()")
    return wrapTheFunction

@a_new_decorator
def a_function_requiring_decoration():
    """Hey yo! Decorate me!"""
    print("I am the function which needs some decoration to "
          "remove my foul smell")

print(a_function_requiring_decoration.__name__)
# Output: a_function_requiring_decoration

可以看到这个程序可以输出正确的函数名称了。 @wraps接受一个函数来进行装饰，并加入了复制函数名称、注释文档、参数列表等等的功能。这可以让我们在装饰器里面访问在装饰之前的函数的属性。

四、装饰器的常用场景

1. 授权

装饰器可以检查某个用户是否被授权去使用web应用的端点(endpoint)。装饰器被大量使用于Flask和Django web框架中，这里是一个例子来使用基于装饰器的授权。

#!/usr/bin/env python

from functools import wraps

def requires_auth(f):
    @wraps(f)
    def decorated(*args, **kwargs):
        auth = request.authorization
        if not auth or not check_auth(auth.username, auth.password):
            authenticate()
        return f(*args, **kwargs)
    return decorated

2. 日志

装饰器还可以运用于日志。

#!/usr/bin/env python

from functools import wraps

def logit(func):
    @wraps(func)
    def with_logging(*args, **kwargs):
        print(func.__name__ + " was called")
        return func(*args, **kwargs)
    return with_logging

@logit
def addition_func(x):
   """Do some math."""
   return x + x


result = addition_func(4)
# Output: addition_func was called

五、带参数的装饰器

@wraps也是一个装饰器，但是，它可以接收一个参数，就像任何普通的函数能做的那样。那么，为什么我们不也那样做呢？ 这是因为，当你使用@my_decorator语法时，你是在应用一个以单个函数作为参数的一个包裹函数。记住，Python里每个东西都是一个对象，而且这包括函数！记住了这些，我们可以编写一下能返回一个包裹函数的函数。

1. 在函数中嵌入装饰器

我们回到日志的例子，并创建一个包裹函数，能让我们指定一个用于输出的日志文件。

#!/usr/bin/env python

from functools import wraps

def logit(logfile='out.log'):
    def logging_decorator(func):
        @wraps(func)
        def wrapped_function(*args, **kwargs):
            log_string = func.__name__ + " was called"
            print(log_string)
            # 打开logfile，并写入内容
            with open(logfile, 'a') as opened_file:
                # 现在将日志打到指定的logfile
                opened_file.write(log_string + '\n')
            return func(*args, **kwargs)
        return wrapped_function
    return logging_decorator

@logit()
def myfunc1():
    pass

myfunc1()
# Output: myfunc1 was called
# 现在一个叫做 out.log 的文件出现了，里面的内容就是上面的字符串

@logit(logfile='func2.log')
def myfunc2():
    pass

myfunc2()
# Output: myfunc2 was called
# 现在一个叫做 func2.log 的文件出现了，里面的内容就是上面的字符串

六、装饰器类

现在我们有了能用于正式环境的logit装饰器，但当我们的应用的某些部分还比较脆弱时，异常也许是需要更紧急关注的事情。比方说有时你只想打日志到一个文件。而有时你想把引起你注意的问题发送到一个email，同时也保留日志，留个记录。这是一个使用继承的场景，但目前为止我们只看到过用来构建装饰器的函数。 幸运的是，类也可以用来构建装饰器。那我们现在以一个类而不是一个函数的方式，来重新构建logit。

#!/usr/bin/env python

from functools import wraps

class logit(object):
    def __init__(self, logfile='out.log'):
        self.logfile = logfile

    def __call__(self, func):
        @wraps(func)
        def wrapped_function(*args, **kwargs):
            log_string = func.__name__ + " was called"
            print(log_string)
            # 打开logfile并写入
            with open(self.logfile, 'a') as opened_file:
                # 现在将日志打到指定的文件
                opened_file.write(log_string + '\n')
            # 现在，发送一个通知
            self.notify()
            return func(*args, **kwargs)
        return wrapped_function

    def notify(self):
        # logit只打日志，不做别的
        pass

这个实现有一个附加优势，在于比嵌套函数的方式更加整洁，而且包裹一个函数还是使用跟以前一样的语法：

#!/usr/bin/env python

@logit()
def myfunc1():
    pass

现在，我们给 logit 创建子类，来添加 email 的功能(虽然 email 这个话题不会在这里展开)。

#!/usr/bin/env python

class email_logit(logit):
    '''
    一个logit的实现版本，可以在函数调用时发送email给管理员
    '''
    def __init__(self, email='admin@myproject.com', *args, **kwargs):
        self.email = email
        super(email_logit, self).__init__(*args, **kwargs)

    def notify(self):
        # 发送一封email到self.email
        # 这里就不做实现了
        pass