Python从入门到实践：函数之装饰器

目录

一、开放封闭原则与装饰器

二、装饰器的实现

2.1无参装饰器

2.2有参装饰器

2.3wraps装饰器

2.4多个装饰器的使用

---

一、开放封闭原则与装饰器

说道装饰器之前，我们先看一个实际的需求，我们设计了一个功能，比如是登录系统，我们现在要在登录系统这个程序中添加验证功能，也就是在在登陆的时候，需要验证码验证，验证通过才能登录，不正确就推出，这是一个非常实际的需求，我们如果直接在原来的登录系统中的代码修改，会出现很多问题，比如把原来的程序改错，把原来能运行的程序改成bug，这就破坏了程序的封闭原则，登录的功能我们一般是不做修改的。

开放式功能的对外拓展，比如登录系统的功能可以对外拓展很多功能。所以，有没有什么办法，没在不修改原来的代码情况下，添加功能？这就是装饰器！

二、装饰器的实现

2.1无参装饰器

我们有一个需求，我需要为下面代码添加一个计算执行时间的功能。

def func(name,age):
   # start = time.time()
    print('name%s,age%s'%(name,age))
    time.sleep(1)
    #end = time.time()
    #print('消耗时间%s'%(end - start))
    return 1+1

添加功能，我们需要明白一个原则：不修改原函数对象源代码和调用方式（原函数是几个参数，就是几个参数）

#添加一个计时功能

def timer(func1):
    def wrapy(*args,**kwargs):
        start = time.time()
        res = func1(*args,**kwargs)
        end = time.time()
        print('消耗时间%s'%(end - start))
        return res
    return wrapy

func = timer(func)

 注意：

*args,**kwargs是为了让装饰器可以修饰带参数和不带参数的函数！

我们有一个语法糖的概念：

语法糖（Syntactic sugar），也译为糖衣语法，是由英国计算机科学家彼得·约翰·兰达（Peter J. Landin）发明的一个术语，指计算机语言中添加的某种语法，这种语法对语言的功能并没有影响，但是更方便程序员使用。通常来说使用语法糖能够增加程序的可读性，从而减少程序代码出错的机会。

但是为了简洁而优雅地使用装饰器,Python提供了专门的装饰器语法来取代index=timer(index)的形式,需要在被装饰对象的正上方单独一行添加@timer（这就是语法糖的一种应用）,当解释器解释到@timer时就会调用timer函数,且把它正下方的函数名当做实参传入,然后将返回的结果重新赋值给原函数名。当然，这种方法需要在函数的最开始就定义好要添加的功能！

@timer 
def func(name,age):
   # start = time.time()
    print('name%s,age%s'%(name,age))
    time.sleep(1)
    #end = time.time()
    #print('消耗时间%s'%(end - start))
    return 1+1
func('xioaming',22)

总结一下装饰器模板：

#无参装饰器模板
def outter(func):
    def wrapper(*args, **kwargs):
        #添加功能
        res = func(* args, ** kwargs)
        return res
    return wrapper

另外，在深度学习里面，我们在训练完模型之后，需要验证模型，需要用到：with torch.no_grad()，但我们还遇到一种写法就是@torch.no_grad()，具体见：深度学习基础：with torch.no_grad()或@torch.no_grad() 用法

 @torch.no_grad()其实就是装饰器的应用！

2.2有参装饰器

我们先看下面代码

def auth(driver):
    def deco(func):
        if driver == 'file':
            def wrapper(*args,**kwargs):
                res=func(*args,**kwargs)
                print('正在用文件读取数据')
                return res
            return wrapper
        elif driver == 'databese':
            def wrapper(* args, ** kwargs):
                res = func(* args, ** kwargs)
                print('正在用数据库读取数据')
                return res
            return wrapper
        else:
             def wrapper(* args, ** kwargs):
                res = func(* args, ** kwargs)
                print('正在用其他读取数据')
                return res
             return wrapper
    return deco

我们需要添加一个功能，我们每次在执行func之前，需要判断一下读取数据文件的类型，这时候就需要接收一个参数，我们需要明白一点：wrapper和deco中的参数都是不能变的，这时候，我们就需要在外面在嵌套一层函数！

@auth(driver='file')
def index():
    time.sleep(1)

我们分析一波怎么得到@auth(driver='file)的：

我们一开始deco =auth(driver='file) ,然后再@deco,其实就是@auth(driver='file)

2.3wraps装饰器

 装饰器的目的是“不知不觉”为函数添加一个功能，这个“不知不觉”是为了然用户感觉不到变化，也就是调用方式，函数名，文档信息等，都和原来一样，这时候需要另一个装饰器wraps

from functools import wraps
 
def timer(func):
    @wraps(func)
    def wrapper(*args,**kwargs):
        start_time=time.time()
        res=func(*args,**kwargs)
        stop_time=time.time()
        print('run time is %s' %(stop_time-start_time))
        return res
    return wrapper

2.4多个装饰器的使用

假设我们要为一个函数添加多个功能，

@deco3
@deco2
@deco1
def index():
    pass

 我们调用的顺序有一定讲究

index=deco3(deco2(deco1(index)))

我们举一个例证，我们要为这个函数添加两个功能：

def index():
    time.sleep(1)

功能1：判断文件的类型

def auth(driver):
    def deco(func):
        if driver == 'file':
            def wrapper(*args,**kwargs):
                res=func(*args,**kwargs)
                print('正在用文件读取数据')
                return res
            return wrapper
        elif driver == 'databese':
            def wrapper(* args, ** kwargs):
                res = func(* args, ** kwargs)
                print('正在用数据库读取数据')
                return res
            return wrapper
        else:
             def wrapper(* args, ** kwargs):
                res = func(* args, ** kwargs)
                print('正在用其他读取数据')
                return res
             return wrapper
    return deco

功能2：计算该函数执行的时间

#添加一个计时功能

def timer(func1):
    def wrapy(*args,**kwargs):
        start = time.time()
        res = func1(*args,**kwargs)
        end = time.time()
        print('消耗时间%s'%(end - start))
        return res
    return wrapy

这时候，调用方式：

@timer
@auth(driver='file')
def index():
    time.sleep(1)