装饰器

  • 装饰器是程序开发中经常会用到的一个功能,用好了装饰器,开发效率如虎添翼,所以这也是Python面试中必问的问题,但对于好多初次接触这个知识的人来讲,这个功能有点绕,自学时直接绕过去了,然后面试问到了就挂了,因为装饰器是程序开发的基础知识。

装饰器(decorator)功能

  1. 引入日志
  2. 函数执行时间统计
  3. 执行函数前预备处理
  4. 执行函数后清理功能
  5. 权限校验等场景
  6. 缓存

个人理解+示例

import time

"""
装饰器理解:
前提:
定义一个函数 def foo()
foo是函数的引用
foo()是执行这个函数

定义一个闭包calTime(func),把函数的引用的传到闭包中,保留该函数,并可以通过()调用函数
通过@calTime 使test = callTime(test),新的函数中有之前函数的引用(因为闭包的特性),
并且 在没有调用函数之前就已经装填。
这样就可以在执行之前的函数前,做一些操作。

装饰器的实质是创建了一个新的函数,只是引用名是相同的,实际是不同的两个函数
执行新的函数,实际是执行闭包中的函数。
"""


# 不带参数的装饰器
def calTime(func):
    def cal():
        start_time = time.time()
        func()
        stop_time = time.time()
        print("执行时间 %f" % (stop_time - start_time))

    return cal


@calTime  # 相当于test = callTime(test) 在没有调用函数之前就已经装填
def test():
    for i in range(100000):
        pass


test()


# 带参数的装饰器
def set_func(func):
    def call_func(a):
        print("验证权限----->1")
        func(a)

    return call_func


@set_func
def test_num(num):
    print("打印参数:%d" % num)


test_num(10)


# 不定长参数的装饰器
def set_func(func):
    def call_func(*args, **kwargs):
        print("验证权限----->1")
        # func(args,kwargs) 不能这么写,相当于传递了两个参数:一个元组,一个字典
        func(*args, **kwargs)  # * ** 的作用是拆包,拆成一个一个的数据

    return call_func


@set_func
def test_num(num, *args, **kwargs):
    print("打印参数:%d" % num)
    print("打印参数:", args)
    print("打印参数:", kwargs)


test_num(10)
test_num(10, 20)
test_num(10, 20, 30, k=3)


# 有返回值的装饰器。装饰没有返回值的函数时,返回None,不会出现问题。
# 通用的装饰器
def set_func(func):
    def call_func(*args, **kwargs):
        print("验证权限----->1")
        # func(args,kwargs) 不能这么写,相当于传递了两个参数:一个元组,一个字典
        return func(*args, **kwargs)  # * ** 的作用是拆包,拆成一个一个的数据

    return call_func


@set_func
def test_num(num, *args, **kwargs):
    print("打印参数:%d" % num)
    print("打印参数:", args)
    print("打印参数:", kwargs)
    return "ok"


ret = test_num(10)
print(ret)


# 多个装饰器装饰一个函数
def add_qx(func):
    print("开始装饰权限")

    def call_func(*args, **kwargs):
        print("增加权限")
        # func(args,kwargs) 不能这么写,相当于传递了两个参数:一个元组,一个字典
        return func(*args, **kwargs)  # * ** 的作用是拆包,拆成一个一个的数据

    return call_func


def add_xx(func):
    print("开始装饰功能")

    def call_func(*args, **kwargs):
        print("增加功能")
        # func(args,kwargs) 不能这么写,相当于传递了两个参数:一个元组,一个字典
        return func(*args, **kwargs)  # * ** 的作用是拆包,拆成一个一个的数据

    return call_func


# 装填顺序add_xx add_qx 先装填距离函数最近的
# 执行顺序add_qx add_xx 最后装填的先执行,因为最后的指向是它,然后一层调用回去
@add_qx
@add_xx
def test_num(num, *args, **kwargs):
    print("打印参数:%d" % num)
    return "ok"


ret = test_num(10)
print(ret)


# 练习 实现 

haha

def add_h1(func): def call_h1(): return "

" + func() + "

" return call_h1 @add_h1 def test_string(): return "haha" print(test_string())

1、先明白这段代码

#### 第一波 ####
def foo():
    print('foo')

foo  # 表示是函数
foo()  # 表示执行foo函数

#### 第二波 ####
def foo():
    print('foo')

foo = lambda x: x + 1

foo()  # 执行lambda表达式,而不再是原来的foo函数,因为foo这个名字被重新指向了另外一个匿名函数

函数名仅仅是个变量,只不过指向了定义的函数而已,所以才能通过 函数名()调用,如果 函数名=xxx被修改了,那么当在执行 函数名()时,调用的就不知之前的那个函数了

2、使用原因

写代码要遵循开放封闭原则,虽然在这个原则是用的面向对象开发,但是也适用于函数式编程,简单来说,它规定已经实现的功能代码不允许被修改,但可以被扩展,即:

  • 封闭:已实现的功能代码块
  • 开放:对扩展开发

如果将开放封闭原则应用在上述需求中,那么就不允许在函数 f1 、f2、f3、f4的内部进行修改代码,于是就有了下面的实现方案:

def w1(func):
    def inner():
        # 验证1
        # 验证2
        # 验证3
        func()
    return inner

@w1
def f1():
    print('f1')
@w1
def f2():
    print('f2')
@w1
def f3():
    print('f3')
@w1
def f4():
    print('f4')

对于上述代码,也是仅仅对基础平台的代码进行修改,就可以实现在其他人调用函数 f1 f2 f3 f4 之前都进行【验证】操作,并且无需做任何操作。

详解:

单独以f1为例:

def w1(func):
    def inner():
        # 验证1
        # 验证2
        # 验证3
        func()
    return inner

@w1
def f1():
    print('f1')

python解释器就会从上到下解释代码,步骤如下:

  1. def w1(func): ==>将w1函数加载到内存
  2. @w1

没错, 从表面上看解释器仅仅会解释这两句代码,因为函数在 没有被调用之前其内部代码不会被执行。

从表面上看解释器着实会执行这两句,但是 @w1 这一句代码里却有大文章, @函数名 是python的一种语法糖。

上例@w1内部会执行一下操作:

执行w1函数

执行w1函数 ,并将 @w1 下面的函数作为w1函数的参数,即:**@w1 等价于 w1(f1) **所以,内部就会去执行:

def inner(): 
    #验证 1
    #验证 2
    #验证 3
    f1()    # func是参数,此时 func 等于 f1 
return inner# 返回的 inner,inner代表的是函数,非执行函数 ,其实就是将原来的 f1 函数塞进另外一个函数中

w1的返回值

将执行完的w1函数返回值 赋值 给@w1下面的函数的函数名f1 即将w1的返回值再重新赋值给 f1,即:

新f1 = def inner(): 
            #验证 1
            #验证 2
            #验证 3
            原来f1()
        return inner

所以,以后业务部门想要执行 f1 函数时,就会执行 新f1 函数,在新f1 函数内部先执行验证,再执行原来的f1函数,然后将原来f1 函数的返回值返回给了业务调用者。

如此一来, 即执行了验证的功能,又执行了原来f1函数的内容,并将原f1函数返回值 返回给业务调用着

Low BBB 你明白了吗?要是没明白的话,我晚上去你家帮你解决吧!!!

3. 再议装饰器


# 定义函数:完成包裹数据
def makeBold(fn):
    def wrapped():
        return "" + fn() + ""
    return wrapped

# 定义函数:完成包裹数据
def makeItalic(fn):
    def wrapped():
        return "" + fn() + ""
    return wrapped

@makeBold
def test1():
    return "hello world-1"

@makeItalic
def test2():
    return "hello world-2"

@makeBold
@makeItalic
def test3():
    return "hello world-3"

print(test1())
print(test2())
print(test3())

运行结果:

hello world-1
hello world-2
hello world-3

4. 装饰器示例

例1:无参数的函数


from time import ctime, sleep

def timefun(func):
    def wrapped_func():
        print("%s called at %s" % (func.__name__, ctime()))
        func()
    return wrapped_func

@timefun
def foo():
    print("I am foo")

foo()
sleep(2)
foo()

上面代码理解装饰器执行行为可理解成

foo = timefun(foo)
# foo先作为参数赋值给func后,foo接收指向timefun返回的wrapped_func
foo()
# 调用foo(),即等价调用wrapped_func()
# 内部函数wrapped_func被引用,所以外部函数的func变量(自由变量)并没有释放
# func里保存的是原foo函数对象

例2:被装饰的函数有参数

from time import ctime, sleep

def timefun(func):
    def wrapped_func(a, b):
        print("%s called at %s" % (func.__name__, ctime()))
        print(a, b)
        func(a, b)
    return wrapped_func

@timefun
def foo(a, b):
    print(a+b)

foo(3,5)
sleep(2)
foo(2,4)

例3:被装饰的函数有不定长参数

from time import ctime, sleep

def timefun(func):
    def wrapped_func(*args, **kwargs):
        print("%s called at %s"%(func.__name__, ctime()))
        func(*args, **kwargs)
    return wrapped_func

@timefun
def foo(a, b, c):
    print(a+b+c)

foo(3,5,7)
sleep(2)
foo(2,4,9)

例4:装饰器中的return

from time import ctime, sleep

def timefun(func):
    def wrapped_func():
        print("%s called at %s" % (func.__name__, ctime()))
        func()
    return wrapped_func

@timefun
def foo():
    print("I am foo")

@timefun
def getInfo():
    return '----hahah---'

foo()
sleep(2)
foo()

print(getInfo())

执行结果:

foo called at Fri Nov  4 21:55:35 2016
I am foo
foo called at Fri Nov  4 21:55:37 2016
I am foo
getInfo called at Fri Nov  4 21:55:37 2016
None

如果修改装饰器为return func(),则运行结果:

foo called at Fri Nov  4 21:55:57 2016
I am foo
foo called at Fri Nov  4 21:55:59 2016
I am foo
getInfo called at Fri Nov  4 21:55:59 2016
----hahah---

总结:

  • 一般情况下为了让装饰器更通用,可以有return

例5:装饰器带参数,在原有装饰器的基础上,设置外部变量

#decorator2.py

from time import ctime, sleep

def timefun_arg(pre="hello"):
    def timefun(func):
        def wrapped_func():
            print("%s called at %s %s" % (func.__name__, ctime(), pre))
            return func()
        return wrapped_func
    return timefun

# 下面的装饰过程
# 1\. 调用timefun_arg("itcast")
# 2\. 将步骤1得到的返回值,即time_fun返回, 然后time_fun(foo)
# 3\. 将time_fun(foo)的结果返回,即wrapped_func
# 4\. 让foo = wrapped_fun,即foo现在指向wrapped_func
@timefun_arg("itcast")
def foo():
    print("I am foo")

@timefun_arg("python")
def too():
    print("I am too")

foo()
sleep(2)
foo()

too()
sleep(2)
too()

可以理解为

foo()==timefun_arg("itcast")(foo)()

例6:类装饰器(扩展,非重点)

装饰器函数其实是这样一个接口约束,它必须接受一个callable对象作为参数,然后返回一个callable对象。在Python中一般callable对象都是函数,但也有例外。只要某个对象重写了 __call__() 方法,那么这个对象就是callable的。

class Test():
    def __call__(self):
        print('call me!')

t = Test()
t()  # call me

类装饰器demo


class Test(object):
    def __init__(self, func):
        print("---初始化---")
        print("func name is %s"%func.__name__)
        self.__func = func
    def __call__(self):
        print("---装饰器中的功能---")
        self.__func()
#说明:
#1\. 当用Test来装作装饰器对test函数进行装饰的时候,首先会创建Test的实例对象
#   并且会把test这个函数名当做参数传递到__init__方法中
#   即在__init__方法中的属性__func指向了test指向的函数
#
#2\. test指向了用Test创建出来的实例对象
#
#3\. 当在使用test()进行调用时,就相当于让这个对象(),因此会调用这个对象的__call__方法
#
#4\. 为了能够在__call__方法中调用原来test指向的函数体,所以在__init__方法中就需要一个实例属性来保存这个函数体的引用
#   所以才有了self.__func = func这句代码,从而在调用__call__方法中能够调用到test之前的函数体
@Test
def test():
    print("----test---")
test()
showpy()#如果把这句话注释,重新运行程序,依然会看到"--初始化--"

运行结果如下:

---初始化---
func name is test
---装饰器中的功能---
----test---

你可能感兴趣的:(装饰器)