python函数装饰器

一、简单了解装饰器

装饰器(Decorators)是 Python 的一个重要部分。简单地说：他们是修改其他函数的功能的函数。他们有助于让我们的代码更简短，也更Pythonic（Python范儿）。
通俗的讲：就是把一个函数当作参数,返回一个替代版的函数
本质上就是一个返回函数的函数
作用：在不改变原函数的基础上,给函数增加功能
（1）在没有使用装饰器的情况

当我们想要添加内容时：
（2）一个简单的装饰器

这正是 python 中装饰器做的事情！它们封装一个函数，并且用这样或者那样的方式来修改它的行为。现在你也许疑惑，我们在代码里并没有使用 @ 符号？那只是一个简短的方式来生成一个被装饰的函数。这里是我们如何使用 @ 来运行之前的代码：

装饰器练习：

二、装饰器练习

练习一：
装饰器实现一个函数计时器
1.被装饰的函数如果有 返回值的时候 怎么办？
2.如何保留被装饰函数的函数名字和帮助文档信息？

import functools
import random
import string
import time
li = [random.choice(string.ascii_letters) for i in range(100)]

def timeit(fun):
    #@functools.wraps(fun)
    def wrapper(*args,**kwargs):# 接收可变参数和关键字参数
        """这是一个装饰器timeit"""
        # 在函数执行之前
        start_time = time.time()
        # 执行函数
        res = fun(*args,**kwargs)
        # 在函数执行之后
        stop_time = time.time()
        print('运行事件为:%.6f' %(stop_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函数 被装饰器timeis装饰"""
    return list(map(lambda x:x*2,range(n)))
# fun_list(10000)
# fun_map(10000)

print(fun_list.__name__)
print(fun_list.__doc__)

print(fun_map.__name__)
print(fun_map.__doc__)

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

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('local2')
def add(x,y):
    time.sleep(1)
    return x+y

add(1,10)

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

import functools
import inspect


def is_login(fun):
    @functools.wraps(fun)
    def warapper(*args, **kwargs):  # ('admin',)
        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)
    # nspect.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


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

三、多个装饰器

当我们遇到多个装饰器：
（我们可以将装饰器理解为，假设现在有一双鞋子，然后，我们用两层包装将其包装起来，当我们拆时就是我们装饰器在起作用，一层一层依次拆开。我们包装的顺序和我们拆的顺序是不一样的）

def decorator_a(fun):
    print('a')
    def inner_a(*args,**kwargs):
        print('Get in inner_a')
        fun(*args,**kwargs)
    return inner_a

def decorator_b(fun):
    print('b')
    def inner_b(*args,**kwargs):
        print('Get in inner_b')
        fun(*args,**kwargs)
    return inner_b
# 多个装饰器装饰函数 从上到下去执行的
# @decorator_a
# @decorator_b
# def f(x):
#     print('Gat in f')
# # f(1)
# f = decorator_b(f)

四、装饰器拓展

1. 基础版(无参数的装饰器)

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

import functools
def required_ints(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):  # args=(1,2,..)
        for i in args:
            # if isinstance(i,int):
            #     pass
            # else:
            #     print('函数所有的参数并非都是int型')
            #     break
            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))

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_type(*kind):
    def required(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 required

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

print(add(1,1.2))