Python——装饰器

Posted 2021-01-06 wf-aiyouwei

####python的装饰器###

 

Alt + Enter   ##当编写程序时，发现没有导包时，在之后导入要使用的包

 

装饰器的概念:

(1)装饰器的实现是函数里面嵌套函数;

(2)装饰器的本质是一个函数， 它可以让其他函数在不需要做任何代码改动的前提下增加额外的功能;

(3)装饰器需要传递一个函数， 返回值也是一个函数对象.

 

 

1.装饰器

 

装饰器需求：获取每个函数的执行时间

    1.函数执行之前计算时间

    2.函数执行之后计算时间

import time

import random

import string

 

#列表生成式  循环生成十个数

#随机生成字符串里的ASCII码里的任意一个字母

 

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

 

#自己写的装饰器：作用是想要计算一条命令的运行时间

def timeit(fun):

    def wrapper(*args, **kwargs):   ##接收可变参数和关键字参数

##args：元组，kwargs：字典

        start_time = time.time()

        fun(*args,**kwargs)

        end_time = time.time()

        print ‘运行的时间是：%.6f‘ % (end_time - start_time)

    return wrapper

 

@timeit

def con_add():

    s = ‘‘

    for i in li:

        s += (i + ‘,‘)

    print s

 

@timeit

def join_add():

    print ‘,‘.join(li)

 

注意：

#这两个函数的作用是一样的，但是输出的结果的时间却不一样

#所以实现的目的相同时，还是使用python的内置函数比较快

 

con_add()

join_add()

 

注意：

time.time()   ##是返回当前的时间戳（1970纪元后经过的浮点秒数）

time.ctime()  ##是返回当前（现在）的时间

 

 

2.装饰器2

 

问题1：被装饰的函数有返回值的时候怎么办？

   当函数有返回值时，和调用函数的时候一样，用一个变量去接收函数的返回值，然后在装饰器完成后，还要return 这个变量接收的值,就相当于有返回值的函数，返回了函数执行的结果一样，这个返回，也是为了返回结果输出结果。如果没有return也没有报错

 

问题2：如何保留被装饰函数的函数名和帮助文档信息

   当添加语法糖以后，打印 fun_list.__name__（函数的名称） 和 fun_list.__doc__（函数的帮助文档信息）就会变成装饰器的名称和文档信息，所以要输出函数的，就要导入functools这个包，并且在wrapper之前写入  @functools.wraps(fun)

 

import time

import random

import string       ##为了生成随机字母而导入的包

import functools    ##是为了解决问题而导入的包

 

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

 

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 fun_list(n):

    """这是fun_list函数，被timeit装饰"""

    return [2 * i for i in range(n)]

 

print fun_list(5)

 

print fun_list.__name__

print fun_list.__doc__

 

 

3.map_和匿名函数

 

   map()传入的第一个参数是一个函数，第二个参数是一个序列

   匿名函数：每一个函数在创建前都要给函数起名，但是如果不想起名的话可以用lambda来代替

 

def f(x):

    return x*x

print map(f,[1,2,3,4])

 

print map(lambda x:x*x,[1,2,3,4])

 

 

4.探究多个装饰器的执行顺序

 

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

 

a = f(1)

print a

 

结果:

 

注意:最后的结果是先从距离函数近的语法糖开始读写,先读取A,再读取B;后从B开始执行装饰器里面的命令.也就相当于根据函数上面语法糖的顺序,从上到下开始执行

 

 

5.多个装饰器的应用

 

import inspect

 

def is_root(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 ‘Error：no permisson add studnet‘

 

    return wrapper

 

 

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

 

 

def is_login(fun):

    def warrper(*args, **kwargs):

        if args[0] in login_session:

            res = fun(*args, **kwargs)

            return res

        else:

            print ‘Error:%s未登陆!‘ % args[0]

 

    return warrper

 

@is_login

@is_root

def add_student(name):

    print ‘添加学生信息。。‘

 

add_student(‘root‘)

 

 

6.练习题

 

（1）创建装饰器，要求如下：

--创建add_log装饰器， 打印被装饰的函数日志信息；

--日志格式为: [字符串时间] 函数名: 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,运行时间:%.5f,运行返回值结果:%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,2)

 

（2）用户登陆验证的装饰器 is_login

--如果用户登陆成功，则执行被装饰的函数

--如果用户登陆不成功，则执行登陆函数

 

login_users = [‘admin‘, ‘root‘]

 

def is_login(fun):

    def wrapper(*args, **kwargs):

        # 判断写博客这个用户是否登陆成功

        if kwargs.get(‘name‘) in login_users:

            res = fun(*args, **kwargs)

            return res

        else:

            res = login()

            return res

    return wrapper

 

def login():

    return ‘登陆。。。‘

 

@is_login

def writeBlog(name):

    return ‘编写博客。。‘

 

print writeBlog(name=‘adminss‘)

 

（3）编写装饰器required_ints

   条件如下:

--确保函数接收到的每一个参数都是整数;

--如果参数不是整形数， 打印 TypeError:参数必须为整形

 

def required_ints(fun):

    def wrapper(*args, **kwargs):

        for i in args:

            if not isinstance(i, int):

                print ‘TypeError:参数必须为整形‘

                break

        else:

            res = fun(*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)

print myMax(1,2,3,4)

 

注意：

isinstance()——布尔函数判断一个类是否为一个类的子类

isinstance(i, int)   是用来判断前面的 i 变量是否为后面 int 输入的那个类型，如果是，返回True；不是的话，就返回False

 

(4)编写装饰器required_types

--当装饰器为@required_types(int,float)确保函数接收到的每一个参数都是int或者float类型;

--当装饰器为@required_types(list)确保函数接收到的每一个参数都是list类型;

--当装饰器为@required_types(str,int)确保函数接收到的每一个参数都是str或者int类型;

--如果参数不满足条件， 打印 TypeError:参数必须为xxxx类型

 

 

def required_types(*kinds):  #可变参数,输入的参数的个数是随意的

    def required_ints(fun):

        def wrapper(*args, **kwargs):

            for i in args:

                if not isinstance(i, kinds):

                    print ‘TypeError:参数必须为‘,kinds

                    break

            else:

                res = fun(*args, **kwargs)

                return res

        return wrapper

    return required_ints

 

@required_types(float,float)

##这样语法糖就需要添加参数,就比如这个,就可填写数据类型,如果不是填写的数据类型,就会报错.

def add(a, b):

    return a + b

 

print add(1.1,3)

 

注意:这个之前的装饰器都不能传参数,这个装饰器就可以传参数