python装饰器

知识内容:

1.装饰器介绍

2.开放封闭原则

3.装饰器逐步实现

4.参数与装饰器

5.多个装饰器装饰一个函数

一、装饰器介绍

1.装饰器的定义

定义:   定义一个函数，在运行时动态增加功能，又不改动函数本身的代码和调用方式

2.装饰器的功能及本质

功能: 在不修改原函数及其调用方式的情况下对原函数功能进行拓展

本质: 就是一个函数，也可以说是一个闭包函数

3.装饰器的原则

(1)不能修改被装饰的函数的源代码

(2)不能修改被装饰的函数的调用方式

以上两点说白了就算装饰器对被装饰的函数来说是透明的，也就是被装饰的函数中根本不知道装饰函数的存在，

被装饰的函数还是和原来一样

4.一个简单的装饰器

# 统计程序运行时间的装饰器:
import time

def timmer(func):
    def warpper(*args, **kwargs):
        start_time = time.time()
        func()
        stop_time = time.time()
        print("The func run time is %s" % (stop_time-start_time))
    return warpper

@timmer
def test1():
    time.sleep(3)
    print("In the test1")


test1()

上面这个函数可能你第一眼看的很懵逼，我也是一样，不用急，慢慢把后面看完就能理解上面的代码了

5.实现装饰器需要的知识

实现装饰器的知识储备:

(1)函数即"变量"

(2)高阶函数

(3)嵌套函数

高阶函数 + 嵌套函数 -> 装饰器

关于以上内容可以见我另外一篇博客，具体位置: 点这里

二、开放封闭原则

开放封闭原则是开发中的一个重要概念，主要内容如下:

• 对扩展是开放的
• 对修改是封闭的

当然在python的开发中使用装饰器可以很好地实现这个原则，因为装饰器可以在不修改原函数及其调用方式的情况下对原函数功能进行拓展

三、装饰器逐步实现

1.不修改函数源代码

在不修改函数内部代码的情况下实现增加功能可以借助高阶函数来实现，具体实例如下

import time

def decorator(func):
    start_time = time.time()
    func()
    end_time = time.time()
    print("The run time is", end_time - start_time)

def test1():
    time.sleep(3)
    print("in the test1")

def test2():
    time.sleep(3)
    print("in the test2")

decorator(test1)
decorator(test2)

以上的代码中通过不修改函数内源代码的方式实现增加统计时间功能，但是改变了函数的调用方式，在本质上说还不是真正的装饰器

2.不修改函数的调用方式

在不修改函数调用方式的情况下实现增加功能可以借助嵌套函数来实现，具体实例如下

import time
def timer(func):        # timer(test1) func = test1
    def decorator():
        start_time = time.time()
        func()
        end_time = time.time()
        print("The run time is", end_time - start_time)
    return decorator

def test1():
    time.sleep(3)
    print("in the test1")

def test2():
    time.sleep(3)
    print("in the test2")

test1 = timer(test1)
test1()                 # 实际上是在执行decorator
test2 = timer(test2)
test2()                 # 实际上是在执行decorator

以上的代码中其实不光用到了嵌套函数，也用到了高阶函数，可以说实现了在不修改原函数及其调用方式的情况下对原函数功能进行拓展，但是这还不是真正的装饰器

3.真正的装饰器

(1)装饰器实现

import time
def timer(func):        # timer(test1) func = test1
    def decorator():
        start_time = time.time()
        func()
        end_time = time.time()
        print("The run time is", end_time - start_time)
    return decorator

@timer          # test1 = timer(test1)
def test1():
    time.sleep(3)
    print("in the test1")

@timer          # test2 = timer(test2)
def test2():
    time.sleep(3)
    print("in the test2")

test1()                 # 实际上是在执行decorator
test2()                 # 实际上是在执行decorator

注:  @timer本质是test1 = timer(test1)

上面的实例就是一个真正的装饰器，与在2.不修改函数的调用方式中的代码相比较，只是把test1 = timer(test1)换成了@timer并加在要装饰的函数的函数名前

(2)装饰器实现详解

以(1)代码中的test1为例:

• 导入模块，定义函数timer
• 运行@timer也就是在调用timer，把test1函数作为变量传给timer函数，定义decorator函数，再将decorator函数返回给test1
• 运行test1()，此时test1在前面已经接受了返回的值(decorator函数)，也就是在运行decorator函数
• 运行decorator函数，decorator函数在@timer运行时已经传入了开始的test1
• 在decorator函数中调用之前传入的test1函数对应的函数func，其前后的代码即是增加的功能

了解装饰器程序运行的流程最好的方法就是单步调试，一步一步的去看程序运行的过程

pycharm单步调试看网友的这篇博客：https://blog.csdn.net/u013088062/article/details/50216015

4.装饰器的固定结构

import time
def wrapper(func):  # 装饰器
    def inner(*args, **kwargs):
        '''函数执行之前的内容扩展'''
        ret = func(*args, **kwargs)
         '''函数执行之后的内容扩展'''
        return ret
    return inner

@wrapper  # f=wrapper(f)
def f():
    time.sleep(1)
    print('fdfgdg')
f()

以上是装饰器的固定格式，并且被装饰的函数可以带参数，也可以不带参数，具体带参数的装饰器见下面详解

四、参数与装饰器

1.被修饰的函数带有参数

import time


def timer(func):        # timer(test1) func = test1
    def decorator(*args, **kwargs):
        start_time = time.time()
        func(*args, **kwargs)
        end_time = time.time()
        print("The run time is", end_time - start_time)
    return decorator


@timer          # test1 = timer(test1)
def test1():
    time.sleep(3)
    print("in the test1")


@timer          # test2 = timer(test2)
def test2(name, age):
    time.sleep(3)
    print("in the test2")
    print("name: %s, age: %d" % (name, age))


test1()                 # 实际上是在执行decorator
test2("wyb", 21)        # 实际上是在执行decorator

2.带参数的装饰器

当加了很多装饰器时，想把某装饰器给去掉了，但是那么多的代码，一个个去很麻烦，那么我们可以用带参数的装饰器去装饰它，这就他就像一个开关一样，要的时候就调用了，不用的时候就去掉。给装饰器里面传个参数，那么那个语法糖也要带个括号。在语法糖的括号内传参。在这里，我们可以用三层嵌套，弄一个标识为去标识

# 带参数的装饰器：（相当于开关）为了给装饰器传参
F = True  # 为True时就加上装饰器
# F = False  # 为False时就去掉装饰器


def outer(flag):
    def wrapper(func):
        def inner(*args, **kwargs):
            if flag:
                print('before')
                ret = func(*args, **kwargs)
                print('after')
            else:
                ret = func(*args, **kwargs)
            return ret
        return inner
    return wrapper


@outer(F)   # outer(F) = wrapper -> @wrapper -> f1 = wrapper(f1)
def f1():
    print('in f1')


@outer(F)   # outer(F) = wrapper -> @wrapper -> f2 = wrapper(f2)
def f2():
    print('in f2')


f1()
f2()

五、多个装饰器装饰一个函数

def before(func):                       #定义装饰器
    def wrapper(*args, **kwargs):
        print('Before function called.')
        return func(*args, **kwargs)
    return wrapper

def after(func):                         #定义修装饰器
    def wrapper(*args, **kwargs):
        result = func(*args, **kwargs)
        print('After function called.')
        return result
    return wrapper

@before
@after
def test():                              #同时使用两个装饰器装饰函数
    print(3)
test()                                   #调用被装饰的函数

运行结果:

Before function called.
3
After function called.

def s(fun):
    def inner(*args, **kwargs):
        print('in s: before')
        ret = fun(*args, **kwargs)
        print('in s: after')
        return ret
    return inner


def f(fun):
    def inner(*args, **kwargs):
        print('in f: before')
        ret = fun(*args, **kwargs)
        print('in f: after')
        return ret
    return inner


@s
@f
def func():
    print('in the func')

func()

 运行结果:

in s: before
in f: before
in the func
in f: after
in s: after