Python之装饰器

Python之装饰器

• 什么是装饰器

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

• 装饰器的示例

银行节日登陆信息：

import time

def desc(f):  # 需要传递的函数(要装饰的函数)
     def add_info():
         print('儿童节快乐')
         f()
         print('欢迎登陆')

     return desc

@desc
def login():
     print('login...')
     
@desc
def logout():
     print('logout....')

def savemoney():
     print('savemoney.....')


def transfermoney():
     print('transfermoney....')
login()

print(time.time())

time模块：时间戳，时间戳表示的是从1970年1月1日00:00:00开始按秒计算

[kiosk@foundation1 ~]$ cat test.py 
import time
print(time.time())
[kiosk@foundation1 ~]$ /usr/local/python3/bin/python3 test.py
1559459432.4063501
[kiosk@foundation1 ~]$ /usr/local/python3/bin/python3 test.py
1559459434.5299308

用装饰器实现一个计时器（返回值和打印信息）：
functools 模块可以说主要是为函数式编程而设计，用于增强函数功能。
functools模块用以为可调用对象（callable objects）定义高阶函数或操作。

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()

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

fun_list(5000)
fun_map(5000)
print(fun_list.__doc__)
print(fun_map.__doc__)
print(fun_list.__name__)
print(fun_map.__name__)

创建装饰器， 要求如下：
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)

多个装饰器装饰函数，从上到下执行

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)

多个装饰器的应用场景：
会采用多个装饰器先验证是否登陆成功，再验证登陆权限是否足够
inspect.getcallargs会返回一个字典，

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')

带有参数的装饰器：
查看自己编写的函数执行时间：

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)

END