草根学Python（十六） 装饰器（逐步演化成装饰器）

上一篇文章将经过解决一个需求问题来了解了闭包，本文也将同样，经过慢慢演变一个需求，一步一步来了解 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
昵称：两点水  部门：作鸭事业部 上班打卡成功
复制代码

经过代码，能知道装饰器函数通常作这三件事：

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

但是，认真一看这代码，这装饰器的写法怎么比函数式编程还麻烦啊。并且看起来比较复杂，甚至有点画蛇添足的感受。

那是由于咱们尚未用到装饰器的 “语法糖” ，咱们看上面的代码能够知道， 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}
复制代码

至此，草根学 Python 入门系列文章结束了。若是感兴趣的话，能够关注微信公众号，回复 “Python” 获取更多的 Python 学习资料。