Python——装饰器

一、装饰器介绍

1.1 什么是装饰器

• 器指的是工具，可以定义成函数
• 装饰：为其他事物添加额外的东西点缀
• 装饰器指的是定义一个函数，该函数是用来为其他函数添加额外的功能

1.2 为什么要用装饰器

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

二、装饰器的实现

2.1 无参装饰器的实现

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

# 解决方案三：
# 问题：解决了方案二代码冗余问题，但带来一个新问题即函数的调用方式改变了
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()

# 方案三的优化
import time
def index(x,y):
    time.sleep(3)
    print('index %s %s' %(x,y))

def wrapper(*args,**kwargs):
    start=time.time()
    index(*args,**kwargs)
    stop=time.time()
    print(stop - start)

wrapper(111,222)

# 解决方案四
# 问题：解决了方案三函数的调用方式改变问题，但带来一个新问题即被装饰对象有返回值时返回值为None
import time
def run_time(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        func(*args, **kwargs)
        stop = time.time()
        print(stop-start)
    return wrapper

def index(x,y):
    time.sleep(1)
    print('index %s,%s' % (x,y))
    return 123
res = index(111, 222)
print(res)

# 方案四优化（装饰器终极版）：给func用res来接收返回值然后return res，来实现对被装饰函数返回值的接收
import time
def run_time(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        res = func(*args, **kwargs)
        stop = time.time()
        print(stop-start)
        return res
    return wrapper

def index(x,y):
    time.sleep(1)
    print('index %s,%s' % (x,y))
    return 123
index = run_time(index)
res = index(111, 222)
print(res)

2.2 语法糖：让你开心的语法

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

# 在被装饰对象正上方的单独一行写@装饰器名字
@run_time # index = run_time(index)
def index(x,y):
    time.sleep(1)
    print('index %s,%s' % (x,y))
    return 123
res = index(111, 222)
print(res)

# 补充：wraps的使用
from functools import wraps
# 无参装饰器模板
def outter(func):
    @wraps(func)
    def wrapper(*args,**kwargs):
        # 1、调用原函数
        # 2、为其增加新功能
        res=func(*args,**kwargs)
        return res
    # wrapper.__name__ = func.__name__
    # wrapper.__doc__ = func.__doc__
    return wrapper

def index():
    """这个是主页功能"""
    print('welcome index')

print(index.__name__)
print(index.__doc__)

2.3 有参装饰器的实现

def auth(db_type='file'):
    def deco(func):
        def wrapper(*args,**kwargs):
            name = input("your name:").strip()
            pwd = input("your password:").strip()
            if db_type == 'file':
                print("基于文件的验证")
                if name == 'umi' 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

@auth(db_type='file')
def index():
    print('welcome index')

@auth(db_type='mysql')
def home():
    print('welcome home')

@auth(db_type='ldap')
def refier():
    print('welcome index')

index()
home()
refier()

2.4 总结

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

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

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

@有参装饰器(1,y=2,z=3)
def index():
    print('welcome index')
index()

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

def deco1(func1):
    def wrapper1(*args,**kwargs):
        print('正在运行===>deco1.wrapper1')
        res1=func(*args,**kwargs)
        return res1
	return wrapper1

def deco2(func2):
    def wrapper2(*args,**kwargs):
        print('正在运行===>deco2.wrapper2')
        res2=func(*args,**kwargs)
        return res2
	return wrapper2

def deco3(x):
    def outter(func3):
        def wrapper3(*args,**kwargs):
            print('正在运行===>deco3.outter3.wrapper3')
            res3=func(*args,**kwargs)
            return res3
        return wrapper3
    return outter


# 加载顺序，自下而上
@deco1
@deco2
@deco3(233)
def index(x, y):
    print('from index %s:%s' % (x, y))
    
# 执行顺序：自上而下的，即wrapper1-->wrapper2-->wrapper3
index(22,33)