Python学习笔记·装饰器

给一个函数添加新功能


1. 装饰器介绍

def hello(func):
    def newfunc():
        print("hello", end = " ")
        func()
        return
    return newfunc
    
@hello
def xiaoli():
    print("xiaoli")
    return
xiaoli()
#输出: hello xiaoli

如上面代码所示,装饰器是一个函数 可调用对象,接收一个函数作为参数,并将其替换成一个函数。

2. “装饰”过程

分析1的代码,函数xiaoli在定义时只会输出"xiaoli",而调用时却额外输出了"hello ",显然我们的调用过程事实上调用的是hello内部定义的newfunc,并且func即为我们实际定义的xiaoli。
先无视第8行的@hello尝试手动实现这个效果。

def hello(func):
    def newfunc():
        print("hello", end = " ")
        func()
        return
    return newfunc
    
def xiaoli():
    print("xiaoli")
    return
xiaoli()
#输出:xiaoli

去掉了@hello,正常的调用了xiaoli,这里和hello没有什么关系。

hello(xiaoli)
#无输出

外层函数hello被调用,查看返回值发现返回一个函数对象,根据hello的定义这里返回了内层函数newfunc。
尝试调用它:

hello(xiaoli)()
#输出:hello xiaoli

这样输出就和1的示例一致了,为了让调用过程也保持一致,加入一行代码:

xiaoli = hello(xiaoli)
xiaoli()
#输出:hello xiaoli

这样就实现了和1中示例代码同样的效果。对于那个@hello我们可以理解为它就是在函数定义结束后添加了一行xiaoli = hello(xiaoli)。至少目前看来这二者没有什么区别。

3. 装饰带参数和返回值的函数

了解了装饰器的用法后我们可以试图让所有自己定义的函数都变得懂礼貌,只需要在定义时使用hello装饰器即可。如:

@hello
def xiaoyu():
    print("xiaoyu")
    return    
@hello
def xiaoliu():
    print("xiaoliu")
    return    
@hello
def xiaozhou():
    print("xiaozhou")
    return

充分发扬懒惰精神,我们可以写成这样

@hello
def xiaonashei(nashei):
    print(xiao + str(nashei))
    return

看上去就有毛病,调用果然出错:

In [133]: xiaonashei("nashei")
---------------------------------------------------------------------------
TypeError   Traceback (most recent call last)
<ipython-input-133-e12e640621a4> in <module>()
----> 1 xiaonashei("nashei")
TypeError: newfunc() takes 0 positional arguments but 1 was given

显然是写hello考虑不周,newfunc应当考虑不同参数情况。

def hello(func):
    def newfunc(*args):
        print("hello ", end = "")
        func(*args)
        return 
    return newfunc

顺便发现第5行内部函数居然没有返回值,一并解决。

def hello(func):
    def newfunc(*args):
        print("hello ", end = "")
        result = func(*args)
        return result
    return newfunc

然后就可以愉快地装饰xiaonashei了。

@hello
def xiaonashei(nashei):
    print(xiao + str(nashei))
    return

xiaonashei("penyou")
#输出:hello xiaopenyou

带返回值的函数也能正确获取返回值。

@hello
def bbs(nasha):
    return abs(nasha)

b = bbs(-1)
#输出: hello
print(b)
#输出: 1

4. 参数化装饰器

既然装饰器也是函数,理应可以接受其他参数以实现不同功能,尝试根据性别打招呼。

def hello(func,sex):
    def newfuncforboy(*args):
        print("hello boy ", end = "")
        result = func(*args)
        return result
    def newfuncforgirl(*args):
        print("hello girl ", end = "")
        result = func(*args)
        return result
    return newfuncforboy if sex == "m" else newfuncforgirl

运行试试

In [130]: @hello("m")
     ...: def xiaoxiao():
     ...:     print("xiaoxiao")
     ...:
---------------------------------------------------------------------------
TypeError   Traceback (most recent call last)
<ipython-input-130-fd7cd46b49f4> in <module>()
----> 1 @hello("m")
      2 def xiaoxiao():
      3     print("xiaoxiao")
      4
TypeError: hello() missing 1 required positional argument: 'sex'

为什么会这样?回忆2里对@hello的替换,

    @hello("m")
    def xiaoxiao():
    ...

看成

    def xiaoxiao():
    ...
    xiaoxiao = hello("m")(xiaoxiao)

也就是说,xiaoxiao并不会被当做参数传入hello,而是被传入hello("m"),事实上,在那之前代码就会因为hello("m")这个错误的函数调用而中止。
回忆1讲过的内容,装饰器是一个可调用对象,接收一个函数作为参数,并将其替换成一个函数。@符号永远认为其紧跟着的是一个装饰器,在无参的情况下hello是一个装饰器,在带参数的情况下hello("m")也应当是一个装饰器。也就是说hello("m")的返回值才应当是作用于xiaoxiao的装饰器。
再加入一层函数嵌套:

def hello(sex):
    def inner(func):
        def newfuncforboy(*args):
            print("hello boy ", end = "")
            result = func(*args)
            return result
        def newfuncforgirl(*args):
            print("hello girl ", end = "")
            result = func(*args)
            return result
        return newfuncforboy if sex == "m" else newfuncforgirl
    return inner
    
@hello("m")
def xiaoming():
    print("xiaoming")
    return
    
@hello("w")
def xiaohong():
    print("xiaohong")
    return

xiaoming()
#输出: hello boy xiaoming
xiaohong()
#输出: hello girl xiaohong

终于正常实现功能了。
事实上如果使用一开始的写法,手动装饰。

def hello(func,sex):
    def newfuncforboy(*args):
        print("hello boy ", end = "")
        result = func(*args)
        return result
    def newfuncforgirl(*args):
        print("hello girl ", end = "")
        result = func(*args)
        return result
    return newfuncforboy if sex == "m" else newfuncforgirl
   
def xiaoming():
    print("xiaoming")
    return
xiaoming = hello(xiaoming,"m")

def xiaohong():
    print("xiaohong")
    return
xiaohong = hello(xiaohong,"w")

xiaoming()
#输出: hello boy xiaoming
xiaohong()
#输出: hello girl xiaohong

好像同样能够实现这一功能,但是这样会导致叠放装饰器的时候很麻烦,所以还是建议使用前面的写法。

5. 叠放装饰器

可以叠放多个装饰器,装饰器自下而上作用。

def hell0(func):
    print("!hell0")
    def newfunc():
        print("hell0", end = " ")
        func()
        return
    return newfunc
    
def hell1(func):
    print("!hell1")
    def newfunc():
        print("hell1", end = " ")
        func()
        return
    return newfunc

def hell2(func):
    print("!hell2")
    def newfunc():
        print("hell2", end = " ")
        func()
        return
    return newfunc

@hell2
@hell1
@hell0
def xiaoli():
    print("xiaoli")
    return
    
xiaoli()

运行上面的代码,观察输出时机和顺序即可。

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

推荐阅读更多精彩内容

  • 第2章 基本语法 2.1 概述 基本句法和变量 语句 JavaScript程序的执行单位为行(line),也就是一...
    悟名先生阅读 4,145评论 0 13
  • Scala与Java的关系 Scala与Java的关系是非常紧密的!! 因为Scala是基于Java虚拟机,也就是...
    灯火gg阅读 3,429评论 1 24
  • 第5章 引用类型(返回首页) 本章内容 使用对象 创建并操作数组 理解基本的JavaScript类型 使用基本类型...
    大学一百阅读 3,226评论 0 4
  • (图片来自网络) 如今,离开微信,生活会缺了一道滋味。微信世界里,人们每天的必修课是看新闻、发信息、回信息、发红包...
    珠珠姑娘阅读 657评论 0 5
  • 你静,挂一串星河 你闹,动一城春色 你哭,流一江轻愁 你爱,写一世邂逅
    时正谋芳阅读 146评论 0 0