python中的装饰器简单介绍

装饰器

把一个函数当作参数，返回一个替代版的函数，本质就是一个返回函数的函数
在不改变原函数的基础上，给函数增加功能

def func1():
    # print('~~~~~~~~~~~~')
    print('hello python')

def outer():
    print('~~~~~~~~~~~~~~')
    func1()

func1()
outer()

def outer(a):
    def inner():
        a()
        print('~~~~~~~~~~~~~~~')
    return inner


func1 = outer(func1)
func1()
输出结果：
hello python
~~~~~~~~~~~~~~
hello python
hello python
~~~~~~~~~~~~~~~

装饰器：对修改是封闭的，对扩展是开放的

import time

def decorator(func):
    def wrapper():
        print(time.time())
        func()
    return wrapper

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

# f1 = decorator(f1)
f1()

运行结果输出：
1554855284.7584538
This is a function

使用关键字参数的装饰器

import time

def decorator(func):
    def wrapper(*args,**kwargs):
        print(time.time())
        func(*args,**kwargs)
    return wrapper

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

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

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

# f1('test')
# f2('test1','test2')
f3('test1','test2',a=1,b=2,c='westos')


运行结果：
1554855700.9218414
This is function test1
This is function test2
{'a': 1, 'b': 2, 'c': 'westos'}

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

import time
import random
import string
import functools

#问题1：被装饰的函数有返回值
#问题2：如何保留被装饰函数的函数名和帮助信息文档

li = [random.choice(string.ascii_letters) for i in range(100)]
# print(li)

def timeit(fun):
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        """这是一个wrapper函数"""
        start_time = time.time()
        res = fun(*args,**kwargs)
        end_time = time.time()
        print('运行时间为:%.6f' %(end_time - start_time))
        return res
    return wrapper

@timeit
def con_add():
    """这是for循环"""
    s = ''
    for i in li:
        s += (i + ',')
    print(s)


@timeit
def join_add():
    """这是join方法"""
    print(','.join(li))

@timeit
def fun_list(n):
    """这是fun_list函数"""
    return [i * 2 for i in range(n)]

@timeit
def fun_map(n):
    """这是fun_map函数"""
    return list(map(lambda x:x*2,range(n)))


# con_add()
# join_add()
# print(con_add.__doc__)
# print(con_add.__name__)
# print(join_add.__doc__)
# print(join_add.__name__)

print(fun_list(5000))
print(fun_map(5000))

运行结果：
1554855912.3667376
This is function test1
This is function test2
{'a': 1, 'b': 2, 'c': 'westos'}

装饰器的练习
1）创建装饰器， 要求如下：

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

print(add(1,10))
# print(time.ctime())

运行结果：
[Wed Apr 10 08:29:55 2019] 函数名:add,运行时间:1.000953,运行返回值结果:11
11

2）

import functools
import inspect

def is_root(fun):
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        #inspect.getcallargs返回值是字典，key值为:形参，value值为:形参对应实参
        inspect_res = inspect.getcallargs(fun,*args,**kwargs)
        print('inspect_res的返回值为:%s' %inspect_res)
        if inspect_res.get('name') == 'root':
            res = fun(*args,**kwargs)
            return res
        else:
            print('not root user')
    return wrapper

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

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

add_student('westos')

运行结果：
inspect_res的返回值为:{'name': 'westos'}
not root user

3）
编写装饰器required_ints, 条件如下:

1. 确保函数接收到的每一个参数都是整数; # 如何判断变量的类型?
   type(s), isinstance(s,str)
2. 如果参数不是整形数， 抛出异常raise TypeError(“参数必须为整形”)

# print(isinstance(1,int))
# print(isinstance(1.0,float))
# print(isinstance('a',str))

# if not isinstance(1,int):
#     raise TypeError("参数必须为整形")

# def add(*args,**kwargs):
#     return sum(args + kwargs.values())
#
# print(add(1,2,3,65,67,1.0,a=1,b=2))

import functools
def required_ints(f):
    @functools.wraps(f)
    def wrapper(*args,**kwargs):
        for arg in args + tuple(kwargs.values()):
            if not isinstance(arg,int):
                raise TypeError('参数必须为整形')
        else:
            return f(*args,**kwargs)
    return wrapper

@required_ints
def add(*args,**kwargs):
    return sum(args + tuple(kwargs.values()))

print(add(1,2,3,65,67,5,a=1,b=2))

运行结果：
146

4）
编写装饰器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_ints(f):
        @functools.wraps(f)
        def wrapper(*args,**kwargs):
            for arg in args:
                if not isinstance(arg,kinds):
                    print('TypeError:参数必须为',kinds)
                    break
            else:
                res = f(*args,**kwargs)
                return res
        return wrapper
    return required_ints

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

print(add(1.1,[1,2,3]))

多个装饰器执行顺序示例

def decorator_a(func):
    print('Get in decorator_a')
    def inner_a(*args,**kwargs):
        print('Get in inner_a')
        res = func(*args,**kwargs)
        return res
    return inner_a

def decorator_b(func):
    print('Get in decorator_b')
    def inner_b(*args,**kwargs):
        print('Get in inner_b')
        res = func(*args,**kwargs)
        return res
    return inner_b


@decorator_b
@decorator_a
def f(x):
    print('Get in f')
    return x * 2

f(1)

运行结果：
Get in decorator_a
Get in decorator_b
Get in inner_b
Get in inner_a
Get in f

装饰器练习

import functools
import inspect

def is_root(fun):
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        #inspect.getcallargs返回值是字典，key值为:形参，value值为:形参对应实参
        inspect_res = inspect.getcallargs(fun,*args,**kwargs)
        print('inspect_res的返回值为:%s' %inspect_res)
        if inspect_res.get('name') == 'root':
            res = fun(*args,**kwargs)
            return res
        else:
            print('not root user')
    return wrapper

login_list = ['root','admin','redhat']

def is_login(fun):
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        if args[0] in login_list:
            res = fun(*args,**kwargs)
            return res
        else:
            print('Error:%s未登录' %args[0])
    return wrapper

@is_login
@is_root
def add_student(name):
    print('添加学生信息...')

add_student('root')

运行结果：
inspect_res的返回值为:{'name': 'root'}
添加学生信息...