装饰器

yzqdev2022/5/25大约 5 分钟

装饰器

上一篇文章通过解决一个需求问题了解了闭包，本文也将通过逐步演变一个需求，一步一步来了解 Python 装饰器。

首先有一个输出员工打卡信息的函数：

def punch():
    print('昵称：两点水  部门：做鸭事业部 上班打卡成功')


punch()

输出的结果如下：

昵称：两点水  部门：做鸭事业部 上班打卡成功

然后，产品反馈需要加上打卡的具体日期。直接添加打印日期的代码如下：

import time


def punch():
    print(time.strftime('%Y-%m-%d', time.localtime(time.time())))
    print('昵称：两点水  部门：做鸭事业部 上班打卡成功')


punch()

输出结果如下：

2018-01-09
昵称：两点水  部门：做鸭事业部 上班打卡成功

这样改是可以，但是改变了函数的功能结构。这个函数定义的时候就是打印员工信息和提示打卡成功，现在增加打印日期的代码，可能会造成代码重复的问题。比如还有一个地方只需要打印员工信息和打卡成功就行了，不需要日期，那么就需要重写一个函数。打印当前日期的功能方法是经常使用的，可以作为公共函数给各个模块方法调用。

既然是这样，可以使用函数式编程来修改这部分代码。通过之前的学习，知道 Python 函数有两个特点：函数也是一个对象，而且函数里可以嵌套函数。那么修改一下代码变成下面这个样子：

import time


def punch():
    print('昵称：两点水  部门：做鸭事业部 上班打卡成功')


def add_time(func):
    print(time.strftime('%Y-%m-%d', time.localtime(time.time())))
    func()


add_time(punch)

输出结果：

2018-01-09
昵称：两点水  部门：做鸭事业部 上班打卡成功

这样是不是发现，这样就没有改动 punch 方法，而且任何需要打印当前日期的函数都可以把函数传入 add_time 就可以了，例如：

import time


def punch():
    print('昵称：两点水  部门：做鸭事业部 上班打卡成功')


def add_time(func):
    print(time.strftime('%Y-%m-%d', time.localtime(time.time())))
    func()


def holiday():
    print('天气太冷，今天放假')


add_time(punch)
add_time(holiday)

打印结果：

2018-01-09
昵称：两点水  部门：做鸭事业部 上班打卡成功
2018-01-09
天气太冷，今天放假

使用函数式编程是不是很方便，但是每次调用时都需要把原来的函数作为参数传递进去，能否有更好的实现方式呢？有的，就是本文要介绍的装饰器。装饰器的写法跟闭包是差不多的，不过没有了自由变量。那么这里直接给出上面那段代码的装饰器写法，来对比一下装饰器写法和函数式编程有什么不同。

import time


def decorator(func):
    def punch():
        print(time.strftime('%Y-%m-%d', time.localtime(time.time())))
        func()

    return punch


def punch():
    print('昵称：两点水  部门：做鸭事业部 上班打卡成功')


f = decorator(punch)
f()

输出的结果：

2018-01-09
昵称：两点水  部门：做鸭事业部 上班打卡成功

通过代码，通过代码，可以知道装饰器函数一般做这三件事：

接收一个函数作为参数
嵌套一个包装函数，包装函数会接收原函数的相同参数，并执行原函数，且还会执行附加功能
返回嵌套函数

可是，装饰器的写法看起来比函数式编程还复杂。

那是因为还没有用到装饰器的"语法糖"。Python 在引入装饰器(Decorator)的时候，没有引入任何新的语法特性，都是基于函数的语法特性。这也就说明了装饰器不是 Python 特有的，而是每个语言通用的一种编程思想。只不过 Python 设计出了 @ 语法糖，让定义装饰器、把装饰器调用原函数再把结果赋值为原函数的对象名的过程变得更加简单、方便，所以 Python 装饰器的核心可以说就是它的语法糖。那么如何使用它的语法糖呢？很简单，根据上面的写法写完装饰器函数后，直接在原来的函数上加 @ 和装饰器的函数名。如下：

import time


def decorator(func):
    def punch():
        print(time.strftime('%Y-%m-%d', time.localtime(time.time())))
        func()

    return punch

@decorator
def punch():
    print('昵称：两点水  部门：做鸭事业部 上班打卡成功')

punch()

输出结果：

2018-01-09
昵称：两点水  部门：做鸭事业部 上班打卡成功

这样就方便很多了。使用了装饰器后，直接在原本的函数上加上装饰器的语法糖即可，本函数无需任何改变，调用的地方也不需修改。

不过这里一直有个问题，输出打卡信息的是固定的，如果需要通过参数来传递，装饰器该怎么写呢？装饰器中的函数可以使用 *args 可变参数，可是仅仅使用 *args 不能完全包括所有参数的情况，比如关键字参数就不能了。为了兼容关键字参数，还需要加上 **kwargs。

因此，装饰器的最终形式可以写成这样：

import time


def decorator(func):
    def punch(*args, **kwargs):
        print(time.strftime('%Y-%m-%d', time.localtime(time.time())))
        func(*args, **kwargs)

    return punch


@decorator
def punch(name, department):
    print('昵称：{0}  部门：{1} 上班打卡成功'.format(name, department))


@decorator
def print_args(reason, **kwargs):
    print(reason)
    print(kwargs)


punch('两点水', '做鸭事业部')
print_args('两点水', sex='男', age=99)

输出结果如下：

2018-01-09
昵称：两点水  部门：做鸭事业部 上班打卡成功
2018-01-09
两点水
{'sex': '男', 'age': 99}

装饰器

装饰器

详情