从零讲解什么是函数装饰器（修饰符）【重点节选】

fc5igm

本文节选自《Intermediate Python》的中译本《Python进阶》
原文地址：https://eastlakeside.gitbooks.io/interpy-zh/content/decorators/
转载自：https://www.runoob.com/w3cnote/python-func-decorators.html
本文针对原文中部分对理解装饰器重要关键却未被翻译的文本进行了修改翻译

装饰器(Decorators)是 Python 的一个重要部分。简单地说：他们是修改其他函数的功能的函数。他们有助于让我们的代码更简短，也更Pythonic（Python范儿）。大多数初学者不知道在哪儿使用它们，所以我将要分享下，哪些区域里装饰器可以让你的代码更简洁。 首先，让我们讨论下如何写你自己的装饰器。

这可能是最难掌握的概念之一。我们会每次只讨论一个步骤，这样你能完全理解它。
.
.
.
（原文包含大量基础教学，本转载对此跳过，如需观看，请查看以上两个链接）
.
.
.
将函数作为参数传给另一个函数

def hi():
    return "hi yasoob!"
 
def doSomethingBeforeHi(func):
    print("我在hi()执行之前")
    print(func())
 
doSomethingBeforeHi(hi)
#输出:我在hi()执行之前
#     hi yasoob!

现在你已经具备所有必需知识，来进一步学习装饰器真正是什么了。装饰器让你在一个函数的前后去执行代码。
你的第一个装饰器
在上一个例子里，其实我们已经创建了一个装饰器！现在我们修改下上一个装饰器，并编写一个稍微更有用点的程序：

def a_new_decorator(a_func): #一个新的装饰器(一个函数)
 
    def wrapTheFunction(): #对函数进行包裹
        print("我在a_func()执行之前")
 
        a_func() #一个函数
 
        print("我在a_func()执行之后")
 
    return wrapTheFunction
 
def a_function_requiring_decoration(): #一个需要装饰器的函数
    print("我是那个需要被装饰器修饰的函数")
 
a_function_requiring_decoration() #一个需要装饰器的函数
#输出: "我是那个需要被装饰器修饰的函数"
 
a_function_requiring_decoration = a_new_decorator(a_function_requiring_decoration) #一个需要装饰器的函数=一个新的装饰器(一个需要装饰器的函数)
#now a_function_requiring_decoration is wrapped by wrapTheFunction() #现在一个需要装饰器的函数（即a_function_requiring_decoration）被函数warpTheFunction所包裹
 
a_function_requiring_decoration() #一个需要装饰器的函数
#输出:我在a_func()执行之前
#     我是那个需要被装饰器修饰的函数
#     我在a_func()执行之后

你看明白了吗？我们刚刚应用了之前学习到的原理。这正是 python 中装饰器做的事情！它们封装一个函数，并且用这样或者那样的方式来修改它的行为。现在你也许疑惑，我们在代码里并没有使用 @ 符号？那只是一个简短的方式来生成一个被装饰的函数。这里是我们如何使用 @ 来运行之前的代码：

@a_new_decorator
def a_function_requiring_decoration(): #一个需要装饰器的函数
    """请装饰器对我进行修饰！""" 
    print("我是那个需要被装饰器 "
          "修饰的函数")
 
a_function_requiring_decoration() #一个需要装饰器的函数
#输出:我在a_func()执行之前
#     我是那个需要被装饰器修饰的函数
#     我在a_func()执行之后
 
#the @a_new_decorator is just a short way of saying: #@a_new_decorator只是对如下公式的一种简写表达
a_function_requiring_decoration = a_new_decorator(a_function_requiring_decoration) #一个需要装饰器的函数=一个新的装饰器(一个需要装饰器的函数)

希望你现在对 Python 装饰器的工作原理有一个基本的理解。如果我们运行如下代码会存在一个问题：

print(a_function_requiring_decoration.__name__)
# 输出: wrapTheFunction

这并不是我们想要的！输出应该是"a_function_requiring_decoration"。这里的函数被warpTheFunction替代了。它重写了我们函数的名字和注释文档(docstring)。幸运的是Python提供给我们一个简单的函数来解决这个问题，那就是functools.wraps。我们修改上一个例子来使用functools.wraps：

from functools import wraps
 
def a_new_decorator(a_func):
    @wraps(a_func)
    def wrapTheFunction():
        print("我在a_func()执行之前")
        a_func()
        print("我在a_func()执行之后")
    return wrapTheFunction
 
@a_new_decorator
def a_function_requiring_decoration():
    """请装饰器对我进行修饰！"""
    print("我是那个需要被装饰器"
          "修饰的函数")
 
print(a_function_requiring_decoration.__name__)
# 输出: a_function_requiring_decoration

现在好多了。我们接下来学习装饰器的一些常用场景。

蓝本规范:

from functools import wraps
def decorator_name(f):
    @wraps(f)
    def decorated(*args, **kwargs):
        if not can_run:
            return "Function will not run"
        return f(*args, **kwargs)
    return decorated
 
@decorator_name
def func():
    return("Function is running")
 
can_run = True
print(func())
# 输出: Function is running
 
can_run = False
print(func())
# 输出: Function will not run

注意：@wraps接受一个函数来进行装饰，并加入了复制函数名称、注释文档、参数列表等等的功能。这可以让我们在装饰器里面访问在装饰之前的函数的属性。
.
.
.
本段之后的后续标题：
使用场景、带参数的装饰器、装饰器类
具体内容请参阅原文