python之装饰器详解

装饰器的定义

装饰器是一个函数，它可以不改变另外一个函数的代码给其添加新功能。这是参与多人项目必须要学会的技能，学python可不能错过装饰器。

装饰器的入门

要掌握装饰器先得理解闭包，如果还没掌握闭包的朋友可以先看看我昨天写的关于闭包的内容，掌握了闭包以后再学装饰器就很容易了。今天继续昨天闭包的案例来讲装饰器。

首先我们有一个计算商品出售时应付款和实付款的函数，代码如下：

def count(x, prince, number):  # x是折扣比例，prince是单价，number是数量
    result = prince * number  # result是应付款，等于prince乘以number
    pay = result * x  # pay是实付款，等于应付款乘以x折扣比例
    print(f'总价是{result}元,实付{pay}元')

现在客户提了新的需求，要求运行count前先校验密码，密码不对的不能执行，密码对的才能执行。

一般来说要满足新的需求肯定得改动相应的函数才能办到，但是在大型项目里改动不是自己写的的函数很容易引起问题。

在python中有一种不需要改动原来函数的代码就能对其增加功能的好办法。办法如下：

def checkpwd(func):  # 实现密码校验功能的装饰器
    def inner(*args, **kwargs):
        pwd = input('请输入密码：')
        if pwd == "123456":
            print("密码正确！")
            return func(*args, **kwargs)  # 执行函数前校验密码，密码对才能执行
        else:
            print('密码错误')
    return inner

@checkpwd  # 装饰器。功能等价于count=checkpwd(count)
def count(x, prince, number):
    result = prince * number
    pay = result * x
    print(f'总价是{result}元,实付{pay}元')

count(0.8, 2.88, 100)


out:
请输入密码：123456
密码正确！
总价是288.0元,实付230.4元

多重装饰器

现在客户又提出了新的需求，运行count前先要校验折扣值，值的范围必须在0.5和1之间。

那么我们需要再写一个校验折扣值范围的装饰器，代码如下：

def checkdisct(func):
    def inner(*args, **kwargs):
        disct = args[0]
        if disct >= 0.5 and disct <= 1:
            print('折扣值合理！')
            return func(*args, **kwargs)
        else:
            print('折扣值不合理!')

    return inner


def checkpwd(func):
    def inner(*args, **kwargs):
        pwd = input('请输入密码：')
        if pwd == "123456":
            print("密码正确！")
            return func(*args, **kwargs)
        else:
            print('密码错误!')

    return inner

@checkpwd
@checkdisct
def count(x, prince, number):
    result = prince * number
    pay = result * x
    print(f'总价是{result}元,实付{pay}元')


count(0.8, 2.88, 100)
count(0.3, 2.88, 100)

out:
请输入密码：123456
密码正确！
折扣值合理！
总价是288.0元,实付230.4元
请输入密码：1234
密码错误!

注意，多重装饰器需要注意加载顺序和执行顺序。

1. 装饰器的加载顺序是由内而外，以上案例中加载顺序是先加载checkdisct函数，后加载checkpwd函数。好比穿衣服，先穿内衣，后穿外衣。
2. 装饰器的运行顺序是由外而内，以上案例中执行顺序是先运行完checkpwd函数，后运行完checkdisct函数。好比脱衣服，先脱外衣，再脱内衣。

装饰器的伪装

通过以上案例我们学习了用装饰器的功能来实现不改动原来函数的基础上给其添加功能，但是还存在一个重要的细节没有做好。就是被装饰的函数说明文档会被遮蔽。说明文档是非常关键的信息，我们可以用如下的方法实现既能用好装饰器又能保证原函数的说明文档信息不被遮蔽。

这段是未加装饰器的函数，打印说明文档内容正常。

def count(x, prince, number):
    '''功能：计算商品应付款和实付款的函数。
参数：x是float型，指定折扣额度；prince是float型，指定商品的单价；number是int型，指定商品的数量。'''
    result = prince * number
    pay = result * x
    print(f'总价是{result}元,实付{pay}元')

print(count.__doc__)
out:
功能：计算商品应付款和实付款的函数。
参数：x是float型，指定折扣额度；prince是float型，指定商品的单价；number是int型，指定商品的数量。

如果需要加了装饰器还能正常打印函数的说明文档需要这样做：

import functools  # 导入函数工具模块


def checkdisct(func):
    @functools.wraps(func)  # 使用functools模块的wraps函数，保存func的说明文档
    def inner(*args, **kwargs):
        disct = args[0]
        if disct >= 0.5 and disct <= 1:
            print('折扣值合理！')
            return func(*args, **kwargs)
        else:
            print('折扣值不合理!')

    return inner


def checkpwd(func):
    @functools.wraps(func)  # 使用functools模块的wraps函数，保存func的说明文档
    def inner(*args, **kwargs):
        pwd = input('请输入密码：')
        if pwd == "123456":
            print("密码正确！")
            return func(*args, **kwargs)
        else:
            print('密码错误!')

    return inner


@checkpwd
@checkdisct
def count(x, prince, number):
    '''功能：计算商品应付款和实付款的函数。
参数：x是float型，指定折扣额度；prince是float型，指定商品的单价；number是int型，指定商品的数量。'''
    result = prince * number
    pay = result * x
    print(f'总价是{result}元,实付{pay}元')


# count(0.8, 2.88, 100)
# count(0.3, 2.88, 100)
print(count.__doc__)

out:
功能：计算商品应付款和实付款的函数。
参数：x是float型，指定折扣额度；prince是float型，指定商品的单价；number是int型，指定商品的数量。

最后

装饰器的内容还有一节，关于装饰器本身参数，留待明天再详细讲。

关于装饰器内容不少，但是并不难，要学好装饰器需要多多练习才能真正掌握。

希望学python的朋友都能掌握好装饰器。