python 16 装饰器

目录

• 1、什么是装饰器
• 2、为何要用装饰器
• 3、如何用——提出需求引出装饰器
• 解决方案一：失败
• 解决方案二：失败
• 解决方案三：失败
• 语法糖：让你开心的语法
• 总结无参装饰器模板
• 案例：
• 装饰器补充：
• 有参装饰器
• 有参装饰器模板
• 叠加多个装饰器的加载、运行分析

1、什么是装饰器

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

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

​

2、为何要用装饰器

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

3、如何用——提出需求引出装饰器

需求：在不修改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，如果想函数写活，func得是一个变量，然而*args和**kwargs
  传函数名作为参数，

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的内存地址，如果这样定义的话就不func和index绑定了，变量死了，所以变量要放到outter（）里、
    def wrapper(*args,**kwargs):
        start=time.time()
        func(*args,**kwargs) # index的内存地址()
        stop=time.time()
        print(stop - start)
    return wrapper
'''
index=outter(index)   Outter加（）代表将Outter的返回值赋值给index即wrapper，wrapper是修饰过的index
所以效果就是将修饰过的index又赋值给index了，这里再调用index就是调用修饰之后的index了。
home=outter(home) 同理，这样函数名就活了。调用函数只需输入该函数原本需要的参数就行。
'''

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')

• 思考题（选做），叠加多个装饰器，加载顺序与运行顺序
  @deco1 # index=deco1(deco2.wrapper的内存地址)
  @deco2 # deco2.wrapper的内存地址=deco2(deco3.wrapper的内存地址)
  @deco3 # deco3.wrapper的内存地址=deco3(index)
  def index():
  pass

总结无参装饰器模板

def outter(func):
    def wrapper(*args,**kwargs):
        # 1、调用原函数
        # 2、为其增加新功能
        res=func(*args,**kwargs)
        return res
    return wrapper

案例：

def auth(func):
    def wrapper(*args,**kwargs):
        # 1、调用原函数
        # 2、为其增加新功能
        name=input('your name>>: ').strip()
        pwd=input('your password>>: ').strip()
        if name == 'egon' and pwd == '123':
            res=func(*args,**kwargs)
            return res
        else:
            print('账号密码错误')
    return wrapper



@auth
def index():
    print('from index')

index()

装饰器补充：

偷梁换柱，即将原函数名指向的内存地址偷梁换柱成wrapper函数，所以应该将wrapper做的跟原函数一样才行。
index的参数什么样子，wrapper的参数就应该什么样子
index的返回值什么样子，wrapper的返回值就应该什么样子
index的属性什么样子，wrapper的属性就应该什么样子==》from functools import wraps

from functools import wraps

def outter(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        """这个是主页功能"""
        res = func(*args, **kwargs) # res=index(1,2)
        return res

    # 手动将原函数的属性赋值给wrapper函数
    # 1、函数wrapper.__name__ = 原函数.__name__
    # 2、函数wrapper.__doc__ = 原函数.__doc__
    # wrapper.__name__ = func.__name__
    # wrapper.__doc__ = func.__doc__

    return wrapper

有参装饰器

一：新需求
由于语法糖@的限制，outter函数只能有一个参数，并且该才是只用来接收被装饰对象的内存地址
由于被修饰函数的限制，wrepper只能传index需要的参数。
如果函数还需要其他参数咋办？

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

叠加多个装饰器的加载、运行分析

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)