python教程笔记:装饰器

这是看廖老师python教程的第一个的笔记,因为这是这份教程最难的章节之一,我来来回回看了三遍,终于有所突破,写在这里是为了巩固自己的理解,同时也是希望有错的地方能够得到指正。具体内容见廖雪峰老师的课程原址。

装饰器,起到增强函数的作用,同时我们不需要改动这个函数。这个部分之所以难,我觉得主要是难在对于返回函数的多次调用,容易打乱初学者的思路。接下来将分为以下三部分进行介绍:

初识装饰器

首先,装饰器要修饰的是一个函数,因此接收到函数是主体,是装饰器首要考虑的参数。以下是一个装饰器的基本模板。

#这是一个装饰器,接收一个函数func作为参数def decorator(func):        #接下来,要建一个对函数func进行处理的函数wrapper(这是装饰器的意义所在嘛)    #这个函数是有要求的:1.接收所要处理函数func的参数(以wrapper参数接收)。2.函数func的返    #回值,需要通过wrapper的返回值传回    def wrapper(*args, **kw):                {一系列函数调用前的操作}                r = func(*args, **kw)      #r保存了返回值                {一系列函数调用后的操作}                return r    return wrapper

尔后,这里有一个返回函数,返回函数,在调用外围函数的时候,它是不会马上执行的,需要接受到它特有的参数才行。

我们分析下课本的例子体会一下。首先,是一个简单的函数。

def now():    print("2015-3-25")

现在,我们希望在这个基础上,打印出函数的调用日志。我们来填充上面那个模板。

def decorator(func):        def wrapper(*args, **kw):                #填充,函数执行前日志        print('%s() start'%func.__name__)                r = func(*args, **kw)      #r保存了返回值                #填充,函数执行后日志        print('%s() end'%func.__name__)                return r    return wrapper

接下来调用这个函数

now = decorator(now)  #这里是一个返回函数,返回了wrappernow()         

返回值如下

image

接下来我们希望简化上面的过程,只需在now()定义的上方加上@decorator,看起来高大上,其实就是想说,now = decorator(now)。有了这个符号以后,直接调用now(),效果和上方完全一样了有木有,可以动手试一试。

@decoratordef now():    print("2015-3-25")

关于参数传递和返回值处理

由于上一个例子的now()没有参数,我们实际上并不能很好的体会装饰器内部的参数传递机制,也就是def wrapper(*args, **kw)这里的参数有什么用。接下来看下一个例子。

image

错误提示里说,wrapper不能接受参数而add函数给了两个参数,啥意思?这里明明是在给add传参那。如果看到这里犯了这样的迷糊,那对装饰器的原理还没有理解。

上一节说过,当加了@decorator之后,就相当于add = decorator(add)。所以,这个时候add已经不是add了,它其实是返回的wrapper;所以,我们在In[3]的地方看到的add函数,实际上是wrapper函数了。

到此,可以看得很清楚,add需要的参数,需要通过wrapper的参数来传递,它的返回值,则需要通过wrapper的返回值来返回。(注:此时原add函数通过decorator(func)函数的形参func保存在外围函数中,具体原理且见返回函数那一节),做了修正,我们得到如下的运行结果。

image

到这里已经很完美了,但是,我们希望装饰器是一个通用物件,它不止是为add函数服务呀,还可以为其他各种函数打印运行日志。这个时候,便引入可变参数来替代原来的位置参数。运行如下。

image

补充关于装饰器有参数的说明

到这里其实装饰器的基本原理已经说明白了,但是这一节还有一个知识点有点捉急,如果装饰器本身也有参数(比如下文的text),就不止要操作的函数func有参数了。这里直接用课本的例子如下:

image

这里要指出,其实装饰器本质上就是一个处理函数的函数,因此核心是接收了func的那个函数(在本文就是decorator,因为它接收并处理函数),至于外围的log只是希望借助返回参数的闭包原理锁住text参数的。这一点由In[11]上的@log('execute')就可以看的很明白。log('exwcute')是啥,其实就是处理func的decorator函数呢。

技巧:不管嵌套了几层返回函数,最后@符号后面跟住的一定是处理函数的那个函数,如本文@decorator中的decorator函数,还有@log('execute'),其中log('execute')返回的返回函数,不正是decorator吗。

你可能感兴趣的:(python教程笔记:装饰器)