Python入门之装饰器详解

1 装饰器

1.1 什么是装饰器：

把一个函数当作参数传递给一个函数，返回一个替代版的函数。本质上就是一个返回函数的函数，即：在不改变原函数的基础上，给函数增加功能。
实际上装饰器就是一个嵌套函数，接收一个被装饰的函数作为参数，并返回一个包装过的函数
1.2 装饰器示例：在函数运行前输出时间

import time
def decorator(func):            #func为形参
    def wrapper(*args,**kwargs):
        print(time.time())
        func(*args,**kwargs)
    return wrapper              #返回wrapper函数

@decorator
def f1():
     print('This is a function')

f1()
# f = decorator(f1)
# f()

@decorator
 def f2(func_name1,func_name2):
     print('This is function ' + func_name1)
     print('This is function ' + func_name2)

 f2('test1','test2')

@decorator
def f3(func_name1,func_name2,**kwargs):
    print('This is function ' + func_name1)
    print('This is function ' + func_name2)
    print(kwargs)

f3('test1','test2',a=1,b=2,c='westos')

执行结果：
1562873050.4234898
This is a function
1562873050.4235475
This is function test1
This is function test2
1562873050.42357
This is function test1
This is function test2
{'a': 1, 'b': 2, 'c': 'westos'}

2 装饰器具体应用

2.1 装饰器实现一个函数计时器：

import time

"""
装饰器实现一个函数计时器
"""
import random
import string
import functools

li = [random.choice(string.ascii_letters) for i in range(10)]

# print(li)
def timec(fun):
    """这是一个装饰器timec"""
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        """这是一个wrapper函数"""
        #args:元组 kwargs:字典
        #函数执行前
        start_time = time.time()
        res = fun(*args,**kwargs)
        end_time = time.time()
        print('运行时间为: %.6f' %(end_time - start_time))
        return res
    return wrapper

@timec
def con_add():
    """这是一个con_add函数"""
    s = ''
    for i in li:
        s += (i + ',')
    print(s)

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

con_add()
join_add()

@timec
def fun_list(n):
    return [2 * i for i in range(n)]

@timec
def fun_map(n):
    return list(map(lambda x:x*2,range(n)))

print(fun_list(10))
print(fun_map(10))

D,L,N,k,U,h,p,w,F,V,
运行时间为: 0.000033
D,L,N,k,U,h,p,w,F,V
运行时间为: 0.000008
运行时间为: 0.000005
[0, 2, 4, 6, 8, 10, 12, 14, 16, 18]
运行时间为: 0.000007
[0, 2, 4, 6, 8, 10, 12, 14, 16, 18]

2.2 被装饰的函数如何保留自己的函数名和帮助信息文档：

（1）当函数被装饰器装饰，返回其函数名及帮助信息文档时，会返回为装饰器的函数名及帮助信息文档

import time
def timeit(func):
    def wapper(*args,**kwargs):
        """这是一个wapper函数"""
        starttime=time.time()
        res=func(*args,**kwargs)
        endtime=time.time()
        print('运行时间为：%.6f' %(endtime-starttime))
        return res
    return wapper
@timeit
def add():
    """这是一个被timeit装饰的函数"""
    s = 1
    for i in range(10):
        s+=i
    print(s)
add()
print(add.__doc__)  ##输出其帮助信息文档
print(add.__name__)  ##输出函数名

   46
运行时间为：0.000041
这是一个wapper函数  ##输出的是装饰器的帮助信息文档
wapper  ##输出的是装饰器的函数名

（2）让被装饰的函数返回自己的帮助信息文档及函数名

import time
import functools  ##获取该模块
def timeit(func):
    @functools.wraps(func)  ##对自定义的装饰器再加上functools.wraps装饰器，　作用是让自定义的装饰器函数wrapped在传给func时，仍保留func函数的解释文档__doc__及函数名__name__
    def wapper(*args,**kwargs):
        """这是一个wapper函数"""
        starttime=time.time()
        res=func(*args,**kwargs)
        endtime=time.time()
        print('运行时间为：%.6f' %(endtime-starttime))
        return res
    return wapper
@timeit
def add():
    """这是一个被timeit装饰的函数"""
    s = 1
    for i in range(10):
        s+=i
    print(s)
add()
print(add.__doc__)
print(add.__name__)

46
运行时间为：0.000030
这是一个被timeit装饰的函数
add

2.3 创建装饰器， 要求如下：

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

import time

import functools

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

@add_log
def add(x,y):
    time.sleep(1)
    return x + y

add(1,2)

2.4 判断是否是超级用户
判断是否是超级用户，如果是超级用户，则可以添加或者删除用户信息：

import functools
import inspect

def is_admin(fun):
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        #inspect.getcallargs返回一个字典,key值:形参 value值:对应的实参
        inspect_res = inspect.getcallargs(fun,*args,**kwargs)
        print('inspect的返回值: %s' %inspect_res)
        if inspect_res.get('name') == 'root':
            res = fun(*args,**kwargs)
            return res
        else:
            print('Permission denied!')
    return wrapper



@is_admin
def add_student(name):
    print('添加学生信息')

def del_student(name):
    print('删除学生信息')

add_student('westos')

inspect的返回值: {'name': 'westos'}
Permission denied!

2.5 当装饰器带有参数时：
在不改变原函数及函数调用方式的情况下添加函数功能，我们引入了装饰器，装饰器是对函数进行修饰，它接收的参数是一个函数，那么怎样可以让装饰器可以接收除函数以外的参数呢？

import time
import functools
 
def log_kind(kind):         #接受参数的装饰器
    def add_log(fun):       #装饰函数的装饰器
        @functools.wraps(fun)
        def wrapper(*args,**kwargs):    #添加功能函数，可以输出装饰器的参数
            start_time = time.time()
            res = fun(*args,**kwargs)
            end_time = time.time()
            print('<%s>[%s] 函数名: %s, 运行时间: %.6f, 运行返回值结果: %d'
                  %(kind,time.ctime(),fun.__name__,end_time - start_time,res))
            return res
        return wrapper
    return add_log
 
@log_kind('debug')      #调用装饰器
def add(x,y):
    time.sleep(1)
    return x + y
add(1,2)    #调用函数add

2.6 装饰器带有参数时的练习：

"""
  编写装饰器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_types(*kinds):
    def required(fun):
        @functools.wraps(fun)
        def wrapper(*args,**kwargs):
            for i in args:
                if not isinstance(i,kinds):
                    # print('TypeError:参数必须为',kinds)
                    # break
                    raise TypeError('参数必须为%s,%s' %kinds)
            else:
                res = fun(*args,**kwargs)
                return res
        return wrapper
    return required

@required_types(int,int)
def add(a,b):
    return a + b

print(add(1.2,2.0))

2.7 存在多个装饰器时：

def decorator_a(fun):
    def inner_a(*args,**kwargs):
        print('Get in inner_a')
        return fun(*args,**kwargs)
    return inner_a
 
def decorator_b(fun):
    def inner_b(*args,**kwargs):
        print('Get in inner_b')
        return fun(*args,**kwargs)
    return inner_b
 
@decorator_b
@decorator_a
def f(x):
    print('Get in f')
    return x*2
f(1)

练习：采用多个装饰器先验证是否登陆成功，再验证登陆权限是否足够

import functools
import inspect

login_tables = ['root','admin','westos']


def is_admin(fun):
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        #inspect.getcallargs返回一个字典,key值:形参 value值:对应的实参
        inspect_res = inspect.getcallargs(fun,*args,**kwargs)
        print('inspect的返回值: %s' %inspect_res)
        if inspect_res.get('name') == 'root':
            res = fun(*args,**kwargs)
            return res
        else:
            print('Permission denied!')
    return wrapper


def login(fun):
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        if args[0] in login_tables:
            res = fun(*args,**kwargs)
            return res
        else:
            print('Error:无此用户')
    return wrapper


@login
@is_admin
def add_student(name):
    print('添加学生信息')

def del_student(name):
    print('删除学生信息')

add_student('root')