Python 装饰器

1. 装饰器介绍

2. 装饰器示例 

3. 两个装饰器

4. 被装饰的函数带参数

5. 被装饰的函数带 return

6. 带参数的装饰器

 

 

1. 装饰器介绍

装饰器（decorator）是程序开发中经常会用到的一个功能，用好了装饰器，开发效率如虎添翼，所以这也是 Python 面试中必问的问题。但对于好多初次接触这个知识的人来讲，这个功能有点绕，自学时直接绕过去了。装饰器是程序开发的基础知识，若不懂装饰器，则不能自称会 Python 了。

装饰器本质上是一个可调用对象（callable object），它可以让其它函数内部在不需要做任何代码改动的前提下增加额外的功能。装饰器的返回值也是一个函数对象。有了装饰器，可以抽离出大量的与其它函数功能本身无关的相同代码，提高复用性。

装饰器常用于有切面需求的场景：

• 引入日志
• 函数执行时间统计
• 执行函数前预备处理
• 执行函数后清理功能
• 权限校验等场景
• 缓存

 

2. 装饰器示例

首先理解函数引用

>>> def foo():
...     print("foo")
...
>>> foo  # foo这个名称所指向的函数体内存地址
<function foo at 0x0313DC88>
>>> foo()  # 执行函数
foo
>>> foo = lambda x: x+1
>>> foo()  # 此时调用的是匿名函数，因为foo这个名称已经重新指向了另一个匿名函数
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: <lambda>() missing 1 required positional argument: 'x'

需求

有一个通用的验证功能（函数），需要其它每个函数在执行时都需要先进行验证功能的调用。

普通实现方式

def check_login():
    # 验证1
    # 验证2
    # 验证3
    pass

def f1():
    check_login()
    print('f1')

def f2():
    check_login()
    print('f2')

def f3():
    check_login()
    print('f3')

def f4():
    check_login()
    print('f4')

装饰器实现方式

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

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

如果将开放封闭原则应用在上述需求中，那么就不允许在函数 f1 、f2、f3 等的内部进行修改代码。接下来看下使用装饰器的实现方式：

# 通用功能使用闭包实现
def check(func):
    
    def check_inner():
        print("验证通过")
        func()  # 保存的是原f1或f2的函数对象
    
    return check_inner
    
   
@check  # 等价于f1 = check(f1)，f1先作为参数传递给check()后，f1再接收并指向check()返回的check_inner
def f1():
    print("f1")

@check  # 等价于f2 = check(f2)
def f2():
    print("f2")   

f1()
f2()

"@函数名"是 python 的一种语法糖。对于上述代码，仅仅对通用功能的代码进行修改，就可以实现在其他人调用函数 f1、f2 时无需修改函数内部代码就可以进行“验证”操作。

装饰器的开始执行时间

 # 通用功能使用闭包实现
def check(func):
    
    print("---decoration---")
    
    def check_inner():
        print("验证通过")
        func()
    
    return check_inner
    
    
@check  # python解释器在执行到该行时，已在调用内部函数外的代码
def f1():
    print("f1")

此时的执行结果：

E:\python_pra>python test.py
---decoration---

 

3. 两个装饰器

注意执行顺序：

# 定义函数，完成前端包裹数据的效果
def makeBold(fn):
    def wrapped():
        return "<b>" + fn() + "</b>"
    return wrapped    
    
    
def makeItalic(fn):
    def wrapped():
        return "<i>" + fn() + "</i>"
    return wrapped  
    

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

@makeItalic    
def test2():
    return "hello world-2"
    
@makeBold  # test3 = makeBold(test3)。test3最终指向makeBold的wrapped
@makeItalic  # test3 = makeItalic(test3)。调用结果返回给makeBold()
def test3():  
    return "hello world-3"
    
    
print(test1())  # <b>hello world-1</b>
print(test2())  # <i>hello world-2</i>
print(test3())  # <b><i>hello world-3</i></b>。即先调用makeItalic()，再调用makeBold()

 

4. 被装饰的函数带参数

from time import ctime, sleep

def timefun(func):
    def wrappedfunc(a, b):  # 如果没有参数，会导致16、18行调用失败
        print("%s called at %s" % (func.__name__, ctime()))
        print(a, b)
        func(a, b)  # 如果没有参数，会导致12行调用失败
    return wrappedfunc
    

@timefun
def foo(a, b):
    print(a + b)
    
    
foo(3, 5)
sleep(2)
foo(2, 4)

执行结果：

foo called at Tue Feb 25 21:59:37 2020
3 5
8
foo called at Tue Feb 25 21:59:39 2020
2 4
6

 

5. 被装饰的函数带 return

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

from time import ctime, sleep

def timefun(func):
    def wrappedfunc():
        print("%s called at %s" % (func.__name__, ctime()))
        return func()  # 接收原getInfo函数的返回值，并返回给result
    return wrappedfunc
    

@timefun
def getInfo():
    return "--get the infomation--"
    
    
result = getInfo()
print(result)

执行结果：

getInfo called at Tue Feb 25 22:52:53 2020
--get the infomation--

通用的装饰器

可装饰无参数、有参数、带 return 的函数。

from time import ctime, sleep

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

@timefunc
def getRetun():
    return "--get the return--"

@timefunc
def getPrint():
    print("---get print ---")    
        
@timefunc
def getArgs(*args, **kwargs):
    print(args)
    print(kwargs)

@timefunc
def getArg(a, b, c):
    print(a+b+c)


print(getRetun())
print(getPrint())
print(getArgs(1, "a", a=1, b=2))
print(getArg(1, 2, 3))

执行结果：

getRetun called at Tue Feb 25 23:29:23 2020
--get the return--
getPrint called at Tue Feb 25 23:29:23 2020
---get print ---
None
getArgs called at Tue Feb 25 23:29:23 2020
(1, 'a')
{'a': 1, 'b': 2}
None
getArg called at Tue Feb 25 23:29:23 2020
6
None

 

6. 带参数的装饰器

def func_arg(check_num):
    def func(funcname):
        def func_in():
            print("---记录日志---")
            # 带有参数的装饰器，能够起到在运行时，有不同的功能
            # if check_num ... 
            print("check time: {}".format(check_num))
            funcname()
        return func_in
    return func
    
# 1. 先执行func_arg("check1")函数，然后返回的是func这个函数的引用
# 2. @func
# 3. 使用@func对test进行修饰    
@func_arg("check1")
def test1():
    print("--test1--")
    
@func_arg("check2")
def test2():
    print("--test2--")
    
test1()
test2()

执行结果：

---记录日志---
check time: check1
--test1--
---记录日志---
check time: check2
--test2--