python 装饰器

1.装饰器

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

2.一切皆对象

首先我们来理解下Python中的函数

def hi(name="yasoob"):    return "hi " + nameprint(hi())# output: 'hi yasoob'# 我们甚至可以将一个函数赋值给一个变量，比如greet = hi# 我们这里没有在使用小括号，因为我们并不是在调用hi函数# 而是在将它放在greet变量里头。我们尝试运行下这个print(greet())# output: 'hi yasoob'# 如果我们删掉旧的hi函数，看看会发生什么！del hiprint(hi())#outputs: NameErrorprint(greet())#outputs: 'hi yasoob'

3.在函数中定义函数

刚才那些就是函数的基本知识了。我们来让你的知识更进一步。在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

那现在我们知道了可以在函数中定义另外的函数。也就是说：我们可以创建嵌套的函数。现在你需要再多学一点，就是函数也能返回函数。

4.从函数中返回函数

其实并不需要在一个函数里去执行另一个函数，我们也可以将其作为输出返回出来：

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 welcomea = hi()print(a)#outputs: <function greet at 0x7f2143c01500>#上面清晰地展示了`a`现在指向到hi()函数中的greet()函数#现在试试这个print(a())#outputs: now you are in the greet() function

再次看看这个代码。在if/else语句中我们返回greet和welcome，而不是greet()和welcome()。为什么那样？这是因为当你把一对小括号放在后面，这个函数就会执行；然而如果你不放括号在它后面，那它可以被到处传递，并且可以赋值给别的变量而不去执行它。

你明白了吗？让我再稍微多解释点细节。

当我们写下a = hi()，hi()会被执行，而由于name参数默认是yasoob，所以函数greet被返回了。如果我们把语句改为a = hi(name = "ali")，那么welcome函数将被返回。我们还可以打印出hi()()，这会输出now you are in the greet() function。

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

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!

现在你已经具备所有必需知识，来进一步学习装饰器真正是什么了。装饰器让你在一个函数的前后去执行代码。

6.你的第一个装饰器

在上一个例子里，其实我们已经创建了一个装饰器！现在我们修改下上一个装饰器，并编写一个稍微更有用点的程序：

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 wrapTheFunctiondef 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()

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

@a_new_decoratordef a_function_requiring_decoration():    """Hey you! Decorate me!"""    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)

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

print(a_function_requiring_decoration.__name__)# Output: wrapTheFunction

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

from functools import wrapsdef 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_decoratordef 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

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

蓝本规范:

from functools import wrapsdef 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_namedef func():    return("Function is running")can_run = Trueprint(func())# Output: Function is runningcan_run = Falseprint(func())# Output: Function will not run

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