深入浅出Python装饰器

1.前言

装饰器是Python的特有的语法,刚接触装饰器的同学可能会觉得装饰器很难理解,装饰器的功能也可以不用装饰器实现,但是装饰器无疑是提高你Python代码质量的利器(尤其是使用在一些具有重复功能的场景),是Python程序员的必备技能.下面我将由浅入深的讲解装饰器语法.在学习装饰器前请记住一点.

装饰器的本质就是函数

2.Python函数

既然装饰器是函数,那我们就先从函数说起

Python中的函数很简单,比如:

def add(a, b):
    return a+b

这就是一个标准的函数,有形参有返回值,知道这么多就够了!

3.在函数里面定义函数

Python的语法很自由,这使我们可以在函数里面定义一个函数.举个例子:

def func():
    def inFunc():
        print("---我在里面---")

当然这么写那么里面的函数就永远不会被执行.如何让里面的函数执行呢?有两种方法,我相信聪明的你们都已经猜到了!

1.在函数里面调用函数里面定义的函数,请看例子:

def func():
    def inFunc():
        print("---我在里面---")
    inFunc()

这样子当我们在调用func()函数时,就实现了两步:

1. 定义了一个函数inFunc()
2. 调用了刚刚定义的函数

这样就可以执行内部函数了

2.第二种方法就是将内部函数返回给外部变量,用外部变量调用

4.返回一个函数

def func():
    def inFunc():
        print("---我在里面---")
    return inFunc

f = func()

if __name__ == '__main__':
	f()

注意返回时不要在函数名后面加(),因为加上()代表执行这个函数的意思.

上面的代码运行到f = func()时因为func后面加了()就回去执行func函数,func函数先会定义一个inFunc函数,然后没有执行就把刚定义的函数返回,变量f接收了func返回的函数,f()就执行了刚刚接收的函数,即inFunc函数

5.函数作为参数

既然函数里面可以定义函数,函数又可以返回函数,那么函数的参数也可以是函数吗?答案是肯定的,看个例子:

def func():
    print("---我是函数func---")

def otherFunc(f):
    f()

if __name__ == '__main__':
	otherFunc(func)

这个例子很简单,你们可以自己理一下,这里就不在解释了,这个例子只是为了说明Python中函数的参数是可以为函数的.

6.把上面的组合起来

其实我们认为高大上的装饰器就是把我上面所说的拼在一个函数里就是装饰器了.

如下所示:

def myDecorator(func):  # 函数参数
    def inMyDecorator():  # 定义内部函数
        func()  # 调用参数传进来的函数
        print("---我就加了一丢丢新功能---")   

    return inMyDecorator  # 返回内部定义的函数

那我们要怎么调用它呢,按照之前的逻辑先要定义一个函数作为上面那个函数的参数吧(其实这就是被装饰的函数)这里定义一个函数myFunc如下

def myFunc():
    print("---这是我的函数---")

然后呢?总要用一个变量来接收上面那个函数吧,接收完后总要调用吧.那么总的代码如下:

def myDecorator(func):  # 函数参数
    def inMyDecorator():  # 定义内部函数
        func()  # 调用参数传进来的函数
        print("---我就加了一丢丢新功能---")

    return inMyDecorator  # 返回内部函数

def myFunc():
    print("---这是我的函数---")

f = myDecorator(myFunc)

if __name__ == '__main__':
	f()

输出:

---这是我的函数---
---我就加了一丢丢新功能---

看!这是不是有点像装饰器的样子了呢!但总感觉有什么不像(装饰器可没有变量f),那好吧,把f换成myFunc就好了吧(虽然他是之前函数名,但我们是可以改变他指向的内存空间的,一句话:用过的名字还是可以再被利用的)

再看:

def myDecorator(func):  # 函数参数
    def inMyDecorator():  # 定义内部函数
        func()  # 调用参数传进来的函数
        print("---我就加了一丢丢新功能---")

    return inMyDecorator  # 返回内部函数

def myFunc():
    print("---这是我的函数---")

myFunc = myDecorator(myFunc)

if __name__ == '__main__':
    myFunc()

输出:

---这是我的函数---
---我就加了一丢丢新功能---

这下看着舒服多了.

解释一下上面代码的执行过程:

1. 定义了函数myDecorator(实际上就是装饰器)
2. 定义了函数myFunc(实际上就是被装饰的函数)
3. 执行到myFunc = myDecorator(myFunc)
   1. 这里转去执行myDecorator函数,并把myFunc作为参数传给myDecorator函数
   2. myDecorator函数的形参func接收了实参myFunc函数
   3. 在myDecorator函数里面定义了一个inMyDecorator函数,没有执行这个函数而是把这个函数给返回了
   4. 变量myFunc接收了myDecorator函数的返回值即inMyDecorator函数
4. 调用myFunc函数,注意这里的myFunc函数已经不是最初定义的那个函数了,而是inMyDecorator函数
   1. 执行myFunc函数相当于执行inMyDecorator函数
   2. 在inMyDecorator函数内先调用了 func,这个func就是第2步定义的函数
      1. 转去执行第2步定义的函数,即打印"---这是我的函数---"
   3. 执行到print("---我就加了一丢丢新功能---")这句打印"---我就加了一丢丢新功能---"
5. 结束

7.使用@符号

其实Python中为了我们的省力把很多的步骤都用一个@符号代替掉了

看一个装饰器的官方写法(使用@符号):

def myDecorator(func):  # 函数参数
    def inMyDecorator():  # 定义内部函数
        func()  # 调用参数传进来的函数
        print("---我就加了一丢丢新功能---")

    return inMyDecorator  # 返回内部函数

@myDecorator
def myFunc():
    print("---这是我的函数---")

if __name__ == '__main__':
    myFunc()

其实这段代码的功能和之前的写法是一模一样的.

@myDecorator
def myFunc():
    print("---这是我的函数---")

等价于

def myFunc():
    print("---这是我的函数---")

myFunc = myDecorator(myFunc)

8.被装饰的函数带参数

之前写的函数例子都是不带参数的,但是实际上带参数的函数更为常见,那如何向函数传参数呢?仔细想想,myFunc函数在被装饰后就是inMyDecorator函数.那么只要想办法步参数传给inMyDecorator函数不就行了嘛

代码稍作修改(就改了两处):

def myDecorator(func):  # 函数参数
    def inMyDecorator(*args, **kwargs):  # 定义内部函数
        func(*args, **kwargs)  # 调用参数传进来的函数
        print("---我就加了一丢丢新功能---")

    return inMyDecorator  # 返回内部函数

def myFunc(a):
    print("---这是我的函数参数:{}---".format(a))

myFunc = myDecorator(myFunc)

if __name__ == '__main__':
    myFunc("kainhuck")

输出:

---这是我的函数参数:kainhuck---
---我就加了一丢丢新功能---

8.没想到你坚持看到了这里

希望看完这篇文章后你能写一个自己的装饰器,后续我会继续更新,装饰器带参数,和用类写一个装饰器.觉得有帮助请点个推荐吧.

往期精彩:提升Python编程效率的几种方法