python——装饰器

装饰器：

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

@ 符号，那只是一个简短的方式来生成一个被装饰的函数

def paint(func):        参数是一个函数
    def inner():
        print('#########')        这个的整个部分就都是装饰器
        func()
    return  inner
@paint             这个就是函数戴帽子，也就是装饰器
def func():
    print('have a nice day!!')      
@paint
def func2():
    print('hello world')
func()
func2()

#########
have a nice day!!
#########
hello world

1、 被装饰的函数存在参数的时候

在构建装饰器的时候，作为返回值的函数是用来替代作为参数的函数的，所以这两个函数所需要的参数必须一致。就时说再定义函数装饰器的时候，指定作为参数的函数可以由于任意个参数以及作为返回值的函数可以右任意个参数，这样就能保证再实际使用的时候不论被装饰的函数需要几个参数，都能使用该装饰器。

2 、被装饰的函数有返回值的时候

需要再函数装饰器中作为返回值的函数中，接收该作为参数的函数的返回值，饭后再返回该值。

def outter(func):         函数作为参数+
    def inner(*args):
        # if age <=0:
        #     age = 0
        func(*args)     调用函数
    return inner
    
@outter
def say(name,age):
    print('%s is %d years old' %(name,age))
say('redhat',10)

3 、被装饰的函数如何保留自己的函数名和帮助信息文档
当函数被装饰之后，装饰器返回一个新的函数来替代原来的函数进行工作，这时候函数名称以及函数文档都会变成装饰器中定义的函数。

def welcome(func):  # 参数是一个函数
    def inner_f(*args,**kwargs):
        """这是装饰器中的welcome函数"""
        print('welcome'.center(40,'~'))
        res = func(*args,**kwargs)
        return res
    return inner_f   # 返回值是另一个函数
@welcome   # 使用welcome进行装饰
def name(name):
    """这是被装饰的name函数"""
    print('name is %s'  %name)
@welcome     # 使用welcome进行装饰
def stuinfo(name,age):
    """这是被装饰的stuinfo函数"""
    return ('name is %s ,age is %d' %(name,age))
print(name.__name__)   # 输出函数名称
print(name.__doc__)  # 输出函数文档
print(stuinfo.__name__)   # 输出函数名称
print(stuinfo.__doc__)   # 输出函数文档

输出结果：
inner_f
这是装饰器中的welcome函数
inner_f
这是装饰器中的welcome函数    # 任何被装饰的函数民成以及函数文档都变成装饰器中定义的函数

Python提供给我们一个简单的函数来解决这个问题，那就是functools.wraps。wraps接受一个函数来进行装饰，并加入了复制函数名称、注释文档、参数列表等等的功能。这可以让我们在装饰器里面访问在装饰之前的函数的属性。

import time 模块

def desc(f):  # 需要传递的函数(要装饰的函数)
    def add_info():
        print('儿童节快乐～～～')
        f()
        print('欢迎来西部开源～～～')
    return desc
@desc
def login():
    print('login...')
print(time.time())

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

import time
import string
import random
import functools
li = [random.choice(string.ascii_letters)
      for i in range(1000)]
def timeit(fun):
    # 问题1：被装饰的函数有返回值的时候怎么办？
    # 问题2：被装饰的函数如何保留自己的函数名和帮助信息文档？
    @functools.wraps(fun)
    def wapper(*args, **kwargs):
        """这是一个wapper函数"""
        # 在函数的执行之前
        start_time = time.time()
        # 执行函数
        res = fun(*args, **kwargs)
        # 在函数执行之后
        end_time = time.time()
        print('运行的时间为:%.6f' % (end_time - start_time))
        return res
    return wapper
@timeit
def con_add():
    s = ''
    for i in li:
        s += (i + '+')
    print(s)
@timeit
def join_add():
    print('+'.join(li))
con_add()
join_add()

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

import time
import functools
#print(time.ctime())
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）

实验效果
[Mon Jun  3 16:01:39 2019] 函数名:add,运行时间:1.000481,运行返回值的结果：11

装饰器的执行顺序，先上到下执行

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('Gat in f')
    return x*2
f(1)

实验效果
Get in inner_b
Get in inner_a
Gat in f

练习
[‘root’,‘admin’,‘redhat’]
多个装饰器的应用场景：
会采用多个装饰器先验证是否登陆成功，再验证登陆权限是否足够

import inspect
import functools
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':
            temp = fun(*args,**kwargs)
            return temp
        else:
            print('not root user,no permisson add user')
    return wrapper
login_session = ['root','admin','redhat']
def is_login(fun):
    @functools.wraps(fun)
    def wrapper(*args,**kwargs):
        if args[0] in login_session:
            temp = fun(*args,**kwargs)
            return temp
        else:
            print('Error:%s 没有登陆成功' %(args[0]))
    return wrapper
@is_login
@is_admin
def add_user(name):
    print('add user~')
add_user('root')

实验效果
inspect的返回值是：{'name': 'root'}
add user~

带参数的装饰器

import functools
import time

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
print(add(1,2))

编写装饰器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(*k):
    def required(func):
        @functools.wraps(func)
        def wrappers(*args, **kwargs):
            for i in args:
                if not isinstance(i, k):
                    print('参数必须为：', *k)
                    break
            else:
                res = func(*args, **kwargs)
                return res
        return wrappers
    return required
@required_types(int,str)
def output(*args):
    print(*args)