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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,591评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,448评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,823评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,204评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,228评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,190评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,078评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,923评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,334评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,550评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,727评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,428评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,022评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,672评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,826评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,734评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,619评论 2 354

推荐阅读更多精彩内容