装饰器的应用

1. 装饰器实现一个函数计时器

1.被装饰的函数有返回值怎么办
2.如何保留被装饰函数的函数名和帮助信息文档

@functools.wraps(func)
这是python提供的装饰器。它能把原函数的元信息拷贝到装饰器里面的 func 函数中。函数的元信息包括docstring、name、参数列表等等。可以尝试去除@functools.wraps(func)，你会发现test.__name__的输出变成了wrapper

import time
import random
import string
import functools   #保留被装饰函数的函数名和帮助信息文档（注释）
                   #不处理时，被装饰函数的函数名和注释不会显示
         
li = [random.choice(string.ascii_letters) for i in range(100)]

#定义一个装饰器
def timeit(func):
    #给装饰器一个系统的装饰器，这样的话，被这个装饰器装饰的函数名就不会被覆盖
    @functools.wraps(func)
    def wrapper(*args, **kwargs):  # 接收可变参数 和关键字参数
        """这是一个装饰器timeit"""
        # 在函数运行之前
        start_time = time.time()
        # 执行函数
        res = func(*args, **kwargs)
        # 在函数运行之后
        end_time = time.time()
        print('运行时间为:%.6f' % (end_time - start_time))
        return res

    return wrapper


@timeit
def con_add():
    s = ''
    for i in li:
        s += (i + ',')
    print(s)


@timeit
def join_add():
    print(','.join(li))


con_add()
join_add()

输出结果：

t,a,l,b,U,y,t,h,R,F,A,O,o,g,F,y,S,G,Q,g,r,X,w,R,p,c,r,f,i,g,O,P,G,s,Z,E,Q,R,p,a,a,B,O,H,x,H,Z,B,m,W,W,O,e,R,M,k,s,x,h,l,X,l,j,v,x,U,L,M,Z,W,m,g,f,U,q,l,j,K,z,x,z,V,Y,b,a,D,t,H,P,m,l,K,f,p,K,G,d,Q,B,D,
运行时间为:0.000063
t,a,l,b,U,y,t,h,R,F,A,O,o,g,F,y,S,G,Q,g,r,X,w,R,p,c,r,f,i,g,O,P,G,s,Z,E,Q,R,p,a,a,B,O,H,x,H,Z,B,m,W,W,O,e,R,M,k,s,x,h,l,X,l,j,v,x,U,L,M,Z,W,m,g,f,U,q,l,j,K,z,x,z,V,Y,b,a,D,t,H,P,m,l,K,f,p,K,G,d,Q,B,D
运行时间为:0.000011

import time
import random
import string
import functools   #保留被装饰函数的函数名和帮助信息文档（注释）
                   #不处理时，被装饰函数的函数名和注释不会显示
         
li = [random.choice(string.ascii_letters) for i in range(100)]

#定义一个装饰器
def timeit(func):
    #给装饰器一个系统的装饰器，这样的话，被这个装饰器装饰的函数名就不会被覆盖
    @functools.wraps(func)
    def wrapper(*args, **kwargs):  # 接收可变参数 和关键字参数
        """这是一个装饰器timeit"""
        # 在函数运行之前
        start_time = time.time()
        # 执行函数
        res = func(*args, **kwargs)
        # 在函数运行之后
        end_time = time.time()
        print('运行时间为:%.6f' % (end_time - start_time))
        return res

    return wrapper


@timeit
def con_add():
    s = ''
    for i in li:
        s += (i + ',')
    print(s)


@timeit
def join_add():
    print(','.join(li))


#con_add()
#join_add()

@timeit
def fun_list(n):     #当被装饰函数有返回值
    """这是fun_list函数"""
    return [2 * i for i in range(n)]
@timeit
def fun_map(n):
    """这是fun_map函数"""
    return list(map(lambda x:x*2,range(n)))

fun_list(100000)
fun_map(100000)

#显示注释
print(fun_map.__doc__)
print(fun_list.__doc__)

#显示函数名
print(fun_map.__name__)
print(fun_list.__name__)

输出结果：

运行时间为:0.014807
运行时间为:0.024916
这是fun_map函数
这是fun_list函数
fun_map
fun_list

2. 创建add_log装饰器

创建装饰器， 要求如下：
1. 创建add_log装饰器， 被装饰的函数打印日志信息；
2. 日志格式为: [字符串时间] 函数名: xxx， 运行时间：xxx, 运行返回值结果:xxx

import time
import functools

def add_log(func):
    @functools.wraps(func)
    def wrapper(*args,**kwargs):

        start_time = time.time()
        res = func(*args,**kwargs)
        end_time = time.time()
        print('[%s] 函数名:%s,运行时间:%.6f,运行返回值的结果'
              ':%d' %(time.ctime(),func.__name__,
                      end_time-start_time,res))
        return res
    return wrapper
@add_log
def add(x,y):
    time.sleep(1)
    return x+y

add(1,10)

输出结果：

[Thu Feb  6 00:30:14 2020] 函数名:add,运行时间:1.000273,运行返回值的结果:11

3. 层层装饰的装饰器

情况一：

def wrapper_out1(func):
    # print('--out11---')
    def inner1(*args,**kwargs):
        print('----in11----')
        res = func(*args,**kwargs)
        print('----in12-----')
        return res
    # print('---out---12')
    return inner1

def wrapper_out2(func):
    # print('--out21---')
    def inner2(*args,**kwargs):
        print('----in21----')
        res = func(*args,**kwargs)
        print('----in22-----')
        return res
    # print('---out---22')
    return inner2

@wrapper_out2  #先执行wrapper_out2，此时它里面的func是inner1，而inner1的func是test（）
@wrapper_out1
def test(): #wrapper_out2(wrapper_out1(test)) === wrapper_out2(inner1)
    print('---test---')
    return 1 * 2

test()
print(test)

输出结果：

----in21----
----in11----
---test---
----in12-----
----in22-----
<function wrapper_out2.<locals>.inner2 at 0x7fe4d47c80d0>

情况二：

def wrapper_out1(func):
    print('--out11---')
    def inner1(*args,**kwargs):
        print('----in11----')
        res = func(*args,**kwargs)
        print('----in12-----')
        return res
    print('---out---12')
    return inner1

def wrapper_out2(func):
    print('--out21---')
    def inner2(*args,**kwargs):
        print('----in21----')
        res = func(*args,**kwargs)
        print('----in22-----')
        return res
    print('---out---22')
    return inner2

@wrapper_out2  #先执行wrapper_out2，此时它里面的func是inner1，而inner1的func是test（）
@wrapper_out1
def test(): #wrapper_out2(wrapper_out1(test)) === wrapper_out2(inner1)
    print('---test---')
    return 1 * 2

test()
print(test)

输出结果：

--out11---
---out---12
--out21---
---out---22
----in21----
----in11----
---test---
----in12-----
----in22-----
<function wrapper_out2.<locals>.inner2 at 0x7fbbe54990d0>

4. 利用装饰器实现登陆系统

import functools
import inspect
login_session = ['root','admin','redhat']
def is_login(fun):
    @functools.wraps(fun)
    def warapper(*args,**kwargs):#('root',)
        if args[0] in login_session:
            temp = fun(*args,**kwargs)
            return temp
        else:
            print('Error:%s 没有登陆成功' %(args[0]))
    return warapper

def is_admin(fun):
    @functools.wraps(fun)
    # """
    #  inspect.getcallargs会返回一个字典
    #  key:形参
    #  value:对应的实参
    # """
    def wrapper(*args,**kwargs):
        inspect_res = inspect.getcallargs(fun,*args,**kwargs)
        print('inspect的返回值是:%s' %(inspect_res))
        if inspect_res.get('name') == 'root':
            temp = fun(*args,**kwargs)
            return temp
        else:
            print('not root user,no permisson add user')
    return wrapper


@is_login
@is_admin
def add_user(name): # is_login((is_admin(adduser)) is_login(wrapper())
    print('add_user')

add_user('python')
print('--------')
add_user('root')
print('--------')
add_user('redhat')

输出结果：

Error:python 没有登陆成功
--------
inspect的返回值是:{'name': 'root'}
add_user
--------
inspect的返回值是:{'name': 'redhat'}
not root user,no permisson add user

5. 利用装饰器实现整形数的输入

编写装饰器required_ints, 条件如下:
1). 确保函数接收到的每一个参数都是整数;
2). 如果参数不是整形数， 打印 TypeError:参数必须为整形

import functools
def required_ints(func):
    @functools.wraps(func)
    def wrapper(*args,**kwargs): # (1,2,....)
        for i in args:
            # 方式一：
            # if isinstance(i,int):
            #     pass
            # else:
            #     print('函数所有的参数并非全是int型')

            #方式二：
            if not  isinstance(i,int):
                print('函数所有的参数并非都是int型')
                break
        else:
            res = func(*args,**kwargs)
            return res

    return wrapper

@required_ints
def add(a,b):
    return a+b
@required_ints
def mymax(a,b,c,d):
    return max(a,b,c,d)

print(add(1,2.0))
print('-----')
print(add(1,2))

输出结果：

函数所有的参数并非都是int型
None
-----
3

补充：
isinstance() 函数来判断一个对象是否是一个已知的类型，类似 type()。

只要是元组中的一个就返回True

6. 带参数的装饰器

import time
import functools

def log(kind):
    def add_log(func):
        @functools.wraps(func)
        def wrapper(*args,**kwargs):

            start_time = time.time()
            res = func(*args,**kwargs)
            end_time = time.time()
            print('<%s> [%s] 函数名:%s,运行时间:%.6f,运行返回值的结果'
              ':%d' %(kind,time.ctime(),func.__name__,
                      end_time-start_time,res))
            return res
        return wrapper
    return add_log

@log('debug')
def add(x,y):
    time.sleep(1)
    return x+y

add(1,10)

输出结果：

<debug> [Thu Feb  6 01:18:23 2020] 函数名:add,运行时间:1.001075,运行返回值的结果:11

7. 多个装饰器的练习

编写装饰器required_types, 条件如下:
1). 当装饰器为@required_types(int,float)确保函数接收到的每一个参数都是int或者float类型;
2). 当装饰器为@required_types(list)确保函数接收到的每一个参数都是list类型;
3). 当装饰器为@required_types(str,int)确保函数接收到的每一个参数都是str或者int类型;
4). 如果参数不满足条件， 打印 TypeError:参数必须为xxxx类型

import functools
def required_type(*kind):
    def require(fun):
        @functools.wraps(fun)
        def wrapper(*args,**kwargs):
            for i in args:
                if not isinstance(i,kind):
                    print('函数所有的参数并非',kind)
                    break
            else:
                res = fun(*args,**kwargs)
                return res
        return wrapper
    return require
# a = 1.0
# print(isinstance(a,(int,float)))
@required_type(int,float)
def add(a,b):
    return a+b

print(add(1,1.2))
print('---------')
print(add(1,'a'))

输出结果：

2.2
---------
函数所有的参数并非 (<class 'int'>, <class 'float'>)
None