Python中的装饰器

现在,我们用一个函数pay()模拟一下商城购物时付款的场景。

import time

def pay():
    print('开始付款。。。')
    time.sleep(1)
    print('付款完毕。。。')

就这样付款成功了?可是我们都没有做验证啊,就这样随随便就付款成功了?扣了谁的钱了啊?我们该如何解决这个问题呢?
我们可以直接修改这个函数,将函数改成如下:

import time

def pay():
    print("正在验证用户。。。")
    time.sleep(3)
    print("验证用户完成。。。")
    print('开始付款。。。')
    time.sleep(1)
    print('付款完毕。。。')

这样的确解决了验证的问题。可是,我们编程有个原则“单一职责”原则。像我们这样来修改函数,使得函数具备了两个功能(1、验证用户。2、进行付款操作。)这显然是违背了这个原则。

那我们怎么做可以既遵守这个原则,不去修改原有的付款函数,并且又能够在付款之前加上验证用户的功能呢?

我们可以用Python的装饰器。它就是可以在代码运行期间动态增加功能的方式。

所以,我们现在要定义一个能验证用户的装饰器函数

def validate(func):
    def wrapper(*args, **kwargs):
        print("正在验证。。。")
        time.sleep(3)
        print("验证完成。。。")
        func(*args, **kwargs)

    return wrapper

观察上面的validate,因为它是一个装饰器,所以接受一个函数作为参数,并且返回一个函数,我们要借助Python的@语法,把装饰器置于函数的定义处

@validate
def pay():
    print('开始付款。。。')
    time.sleep(1)
    print('付款完毕。。。')

调用pay()函数,不仅会运行pay()函数本身,还会在运行pay()函数前先运行验证用户

>>> pay()

正在验证。。。
验证完成。。。
开始付款。。。
付款完毕。。。

@validate放到pay()函数的定义处,相当于执行语句

pay = validate(pay)

由于validate()是一个装饰器,返回一个函数,所以,原来的pay()函数仍然存在,只是现在同名的pay变量指向了新的函数,于是调用pay()将执行新函数,即在validate()函数中返回的wrapper()函数。

那如果我们的pay()函数是需要接收参数的,那怎么办呢?比如:

import time

@validate
def pay(amount):
    print('付款金额:¥{}, 开始付款。。。'.format(amount))
    time.sleep(1)
    print('付款完毕。。。')

现在这个pay()函数要接收一个付款金额的参数。

那么除了在付款之前我们需要验证用户,其他一些操作可能也要去验证用户,比如添加购物车的操作之前也需要先验证用户的状态。

import time

def add_cart(good):
    print('添加商品:{}到购物车。。。'.format(good))
    time.sleep(1)
    print('添加购物车成功。。。')

这时候,add_cart()函数接收的一个参数就是字符串类型,或者是商品Product类型的数据。作为装饰器就应该通用,既要能够装饰在pay()函数上运行正常,也要装饰在add_cart函数上正常运行。

这也就是为什么我们在定义装饰器内部函数wrapper()的时候给的参数(*args, **kwargs)的原因。wrapper()函数可以接收任意参数的调用。在wrapper()函数内,首先执行用户验证,再紧接着调用原始函数。

那么如果装饰器本身需要传入参数,那就需要再外面再套一层,将decorator的返回出去,写出来会更复杂。比如validate()函数要接收用户名和密码作为参数,进行验证

def validate(username, password):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print("开始验证用户。。。")

            if username == 'admin' and password == 'admin123':
                print("验证用户成功!")
                return func(*args, **kwargs)
            else:
                print("验证用户失败!")
                return None

        return wrapper

    return decorator

这个三层嵌套的装饰器的用法如下

@validate('admin', 'admin123')
def pay(amount):
    print('付款金额:¥{}, 开始付款。。。'.format(amount))
    time.sleep(1)
    print('付款完毕。。。')

执行结果如下

>>> pay(20)

开始验证用户。。。
验证用户成功!。
付款金额:¥20, 开始付款。。。
付款完毕。。。

和两层嵌套的装饰器相比,三层嵌套的效果是这样的

>>> now = validate('admin', 'admin123')(pay)

我们来剖析上面的语句,首先执行validate('admin', 'admin123'),返回的是dectorator函数,再调用返回函数,参数是pay函数,返回值最终是wrapper函数。

以上两种装饰器的定义都没有问题,但还差最后一步,因为我们讲了函数也是对象,它__name__等属性,但是你去看经过装饰器装饰之后的函数,它的__name__已经从原来的pay变成wrapper

>>> pay.__name__

'wrapper'

因为返回的那个wapper()函数名字就是wrapper所以,需要把原始的函数__name__等属性复制到 wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。

不需要编写wrapper.__name__ = func.__name__这样的代码,Python内置的```functools.wraps``就是干这个事的,所以,一个完整的装饰器的写法如下`

import functools

def validate(username, password):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            print("开始验证用户。。。")

            if username == 'admin' and password == 'admin123':
                print("验证用户成功!")
                return func(*args, **kwargs)
            else:
                print("验证用户失败!")
                return None

        return wrapper
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容