装饰器

1.知识储备

	想要学习装饰器需掌握可变长度参数（*  **）的使用、名称空间与作用域、函数对象、
函数嵌套、闭包函数。可以参考前三篇博客。

2.装饰器

1、什么是装饰器

器指的是工具，可以定义成成函数
装饰指的是为其他事物添加额外的东西点缀

合到一起的解释：
    装饰器指的定义一个函数，该函数是用来为其他函数添加额外的功能

2、为何要用装饰器

	软件的设计应该遵循开放封闭原则，即对扩展是开放的，而对修改是封闭的。
对扩展开放，意味着有新的需求或变化时，可以对现有代码进行扩展，以适应
新的情况。对修改封闭，意味着对象一旦设计完成，就可以独立完成其工作，而
不要对其进行修改。
	软件包含的所有功能的源代码以及调用方式，都应该避免修改，否则一旦改错，
则极有可能产生连锁反应，最终导致程序崩溃，而对于上线后的软件，新需求或者
变化又层出不穷，我们必须为程序提供扩展的可能性，这就用到了装饰器。

开放封闭原则
    开放：指的是对拓展功能是开放的
    封闭：指的是对修改源代码是封闭的
    
装饰器就是在不修改被装饰器对象源代码以及调用方式的前提下为被装饰对象添加新功能

3、如何用

3.1、无参装饰器

需求：在不修改index函数的源代码以及调用方式的前提下为其添加统计运行时间的功能
def index(x,y):
    time.sleep(3)
    print('index %s %s' %(x,y))

index(111,222)
# index(y=111,x=222)
# index(111,y=222)

解决方案一：失败
问题：没有修改被装饰对象的调用方式，但是修改了其源代码
import time

def index(x,y):
    start=time.time()
    time.sleep(3)
    print('index %s %s' %(x,y))
    stop = time.time()
    print(stop - start)

index(111,222)

解决方案二：失败
问题：没有修改被装饰对象的调用方式，也没有修改了其源代码，并且加上了新功能
     但是代码冗余
import time

def index(x,y):
    time.sleep(3)
    print('index %s %s' %(x,y))

start=time.time()
index(111,222)
stop=time.time()
print(stop - start)



start=time.time()
index(111,222)
stop=time.time()
print(stop - start)


start=time.time()
index(111,222)
stop=time.time()
print(stop - start)

解决方案三：失败
问题：解决了方案二代码冗余问题，但带来一个新问题即函数的调用方式改变了
import time

def index(x,y):
    time.sleep(3)
    print('index %s %s' %(x,y))

def wrapper():
    start=time.time()
    index(111,222)
    stop=time.time()
    print(stop - start)

wrapper()

方案三的优化一：将index的参数写活了
import time

def index(x,y,z):
    time.sleep(3)
    print('index %s %s %s' %(x,y,z))

def wrapper(*args,**kwargs):
    start=time.time()
    index(*args,**kwargs) # index(3333,z=5555,y=44444)
    stop=time.time()
    print(stop - start)

# wrapper(3333,4444,5555)
# wrapper(3333,z=5555,y=44444)

方案三的优化二：在优化一的基础上把被装饰对象写活了，原来只能装饰index
import time

def index(x,y,z):
    time.sleep(3)
    print('index %s %s %s' %(x,y,z))

def home(name):
    time.sleep(2)
    print('welcome %s to home page' %name)


def outter(func):
    # func = index的内存地址
    def wrapper(*args,**kwargs):
        start=time.time()
        func(*args,**kwargs) # index的内存地址()
        stop=time.time()
        print(stop - start)
    return wrapper

index=outter(index) # index=wrapper的内存地址
home=outter(home) # home=wrapper的内存地址


home('egon')
# home(name='egon')

方案三的优化三：将wrapper做的跟被装饰对象一模一样，以假乱真
import time

def index(x,y,z):
    time.sleep(3)
    print('index %s %s %s' %(x,y,z))

def home(name):
    time.sleep(2)
    print('welcome %s to home page' %name)

def outter(func):
    def wrapper(*args,**kwargs):
        start=time.time()
        res=func(*args,**kwargs)
        stop=time.time()
        print(stop - start)
        return res



    return wrapper
# 偷梁换柱：home这个名字指向的wrapper函数的内存地址
home=outter(home)


res=home('egon') # res=wrapper('egon')
print('返回值--》',res)

大方向：如何在方案三的基础上不改变函数的调用方式

语法糖：让你开心的语法
import time

装饰器
def timmer(func):
    def wrapper(*args,**kwargs):
        start=time.time()
        res=func(*args,**kwargs)
        stop=time.time()
        print(stop - start)
        return res
    return wrapper

# 在被装饰对象正上方的单独一行写@装饰器名字
# @timmer # index=timmer(index)
def index(x,y,z):
    time.sleep(3)
    print('index %s %s %s' %(x,y,z))

# @timmer # home=timmer(ome)
def home(name):
    time.sleep(2)
    print('welcome %s to home page' %name)


index(x=1,y=2,z=3)
home('egon')

总结无参装饰器模板
def outter(func):
    def wrapper(*args,**kwargs):
        # 1、调用原函数
        # 2、为其增加新功能
        res=func(*args,**kwargs)
        return res
    return wrapper

扩展：

#偷梁换柱，即将原函数名指向的内存地址偷梁换柱成wrapper函数
#        所以应该将wrapper做的跟原函数一样才行
from functools import wraps  

def outter(func):
    @wraps(func)		#调用该方法可以将wrapper伪装成index更像
    def wrapper(*args, **kwargs):
        """这个是主页功能"""
        res = func(*args, **kwargs) # res=index(1,2)
        return res

    # 手动将原函数的属性赋值给wrapper函数
    # 1、函数wrapper.__name__ = 原函数.__name__    将wrapper名字换成index
    # 2、函数wrapper.__doc__ = 原函数.__doc__	将wrapper注释换成index的注释
    # wrapper.__name__ = func.__name__
    # wrapper.__doc__ = func.__doc__

    return wrapper



@outter # index=outter(index)
def index(x,y):
    """这个是主页功能"""
    print(x,y)
print(index.__name__)
print(index.__doc__) #help(index)
index(1,2) # wrapper(1,2)

3.2、有参装饰器

现在有一个需求，需要为一个函数增加认证功能,可以使用装饰器加语法糖实现
def auth(func):
    def wrapper(*args, **kwargs):
        name=input('your name>>>: ').strip()
        pwd=input('your password>>>: ').strip()
		if name = 'egon' and pwd = '123':
			func()
			print('登录成功')
    return wrapper

@auth  
def index(x,y):
    print('index->>%s:%s' %(x,y))
 现在又有一个需求，需要增加不同认证方式供用户选择，如果在wrapper角度来实现
 普通玩法一：
def auth(func,db_type):  #可以通过在上层函数中增加一个参数
    def wrapper(*args, **kwargs):
        name=input('your name>>>: ').strip()
        pwd=input('your password>>>: ').strip()
        if db_type == 'file':
            print('基于文件的验证')
            if name == 'egon' and pwd == '123':
                res = func(*args, **kwargs)
                return res
            else:
                print('user or password error')
        elif db_type == 'mysql':
            print('基于mysql的验证')
        elif db_type == 'ldap':
            print('基于ldap的验证')
        else:
            print('不支持该db_type')

    return wrapper

def index(x,y):
    print('index->>%s:%s' %(x,y))
def home(name):
    print('home->>%s' %name)
def transfer():
    print('transfer')
index=auth(index,'file')   #通过传参传给auth（函数参数，db_type）
home=auth(home,'mysql')
transfer=auth(transfer,'ldap')
以上可以实现我们需要的功能，但是我们无法应用语法糖功能。
由于语法糖@的限制，auth函数只能有一个参数，并且该参数只用来接收
被装饰对象的内存地址
def auth(func):
    # func = 函数的内存地址
    def wrapper(*args,**kwargs):
        res=func(*args,**kwargs)
        return res
    return wrapper
# @auth # index=outter(index) # index=>wrapper
@auth # auth(index)
def index(x,y):
    print(x,y)

我们应用装饰器希望偷梁换柱之后：
index的参数什么样子，wrapper的参数就应该什么样子
index的返回值什么样子，wrapper的返回值就应该什么样子
index的属性什么样子，wrapper的属性就应该什么样子==》from functools import wraps

普通玩法二：
我们可以通过再包一层函数继续制作一个装饰器来为内层函数传参。
def auth(db_type):
    def deco(func):
        def wrapper(*args, **kwargs):
            name=input('your name>>>: ').strip()
            pwd=input('your password>>>: ').strip()

            if db_type == 'file':
                print('基于文件的验证')
                if name == 'egon' and pwd == '123':
                    res = func(*args, **kwargs)
                    return res
                else:
                    print('user or password error')
            elif db_type == 'mysql':
                print('基于mysql的验证')
            elif db_type == 'ldap':
                print('基于ldap的验证')
            else:
                print('不支持该db_type')

        return wrapper
    return deco

deco=auth(db_type='file')  #将内层函数deco的内存地址赋给全局变量deco
@deco # 账号密码的来源是文件  #应用语法糖为index装饰
def index(x,y):
    print('index->>%s:%s' %(x,y))

deco=auth(db_type='mysql')
@deco # 账号密码的来源是数据库
def home(name):
    print('home->>%s' %name)

deco=auth(db_type='ldap')
@deco # 账号密码的来源是ldap
def transfer():
    print('transfer')
index(1,2)
home('egon')
transfer()

以上方式相对与第一种有了改进，但是每给需要被装饰的函数之前都要重复的调用deco
还是不完美，所以有以下方式：

语法糖
def auth(db_type):
    def deco(func):
        def wrapper(*args, **kwargs):
            name = input('your name>>>: ').strip()
            pwd = input('your password>>>: ').strip()

            if db_type == 'file':
                print('基于文件的验证')
                if name == 'egon' and pwd == '123':
                    res = func(*args, **kwargs)  # index(1,2)
                    return res
                else:
                    print('user or password error')
            elif db_type == 'mysql':
                print('基于mysql的验证')
            elif db_type == 'ldap':
                print('基于ldap的验证')
            else:
                print('不支持该db_type')
        return wrapper
    return deco


@auth(db_type='file')  # @deco # index=deco(index) # index=wrapper
def index(x, y):
    print('index->>%s:%s' % (x, y))

@auth(db_type='mysql')  # @deco # home=deco(home) # home=wrapper
def home(name):
    print('home->>%s' % name)
@auth(db_type='ldap')  # 账号密码的来源是ldap
def transfer():
    print('transfer')
index(1, 2)
home('egon')
transfer()

有参装饰器模板
def 有参装饰器(x,y,z):   #有参装饰器最外层，对于参数数量没有额外的限制，可以
						#传送多个参数
    def outter(func):
        def wrapper(*args, **kwargs):
            res = func(*args, **kwargs)
            return res
        return wrapper
    return outter

@有参装饰器(1,y=2,z=3)
def 被装饰对象():
    pass

4、叠加多个装饰器的加载、运行分析（了解***）

def deco1(func1): # func1 = wrapper2的内存地址
    def wrapper1(*args,**kwargs):
        print('正在运行===>deco1.wrapper1')
        res1=func1(*args,**kwargs)
        return res1
    return wrapper1

def deco2(func2): # func2 = wrapper3的内存地址
    def wrapper2(*args,**kwargs):
        print('正在运行===>deco2.wrapper2')
        res2=func2(*args,**kwargs)
        return res2
    return wrapper2

def deco3(x):
    def outter3(func3): # func3=被装饰对象index函数的内存地址
        def wrapper3(*args,**kwargs):
            print('正在运行===>deco3.outter3.wrapper3')
            res3=func3(*args,**kwargs)
            return res3
        return wrapper3
    return outter3


# 加载顺序自下而上(了解)
@deco1      # index=deco1(wrapper2的内存地址)        ===> index=wrapper1的内存地址
@deco2      # index=deco2(wrapper3的内存地址)        ===> index=wrapper2的内存地址
@deco3(111) # ===>@outter3===> index=outter3(index) ===> index=wrapper3的内存地址
def index(x,y):
    print('from index %s:%s' %(x,y))

# 执行顺序自上而下的，即wraper1-》wrapper2-》wrapper3
index(1,2) # wrapper1(1,2)