Python装饰器类的使用——bound/unbound method

引言

在学习装饰器类方法时发现,如果装饰器类只有__ call __方法则只能装饰普通的函数(function),不能对实例方法(instance method)进行装饰,经过研究发现与python的函数实现有关。本文就此展开讨论,并给出一个完整的装饰器类实现方法。

问题发现

我们都知道,当我们调用一个类的实例方法时,实例会作为方法的第一个入参self。而在下面的例子中,实例方法foo被装饰器类Decorator装饰后,Decorated().foo('hello, world')的第一个入参self并不是Decorated实例,而是我们传进去的"hello, world",很明显这是不符合我们预期的。实际上这与python的函数调用有关,bound method(通过实例调用的方法)会自动将实例本身作为方法的第一个入参,而function和unbound method(类直接调用的方法)不会自动注入实例。当我们用装饰器装饰后,被传入Decorator中的func失去了bound属性,自然也不会自动注入实例。

class Decorator(object):
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        print("Decorator: self: {}, args: {}, kwargs: {}".format(self, args, kwargs))
        return self.func(*args, **kwargs)

class Decorated(object):
    @Decorator
    def foo(self, *args, **kwargs):
        print("Method Decorated: self: {}, args: {}, kwargs: {}".format(self, args, kwargs))

Decorated().foo('hello, world')
# Decorator: self: <__main__.Decorator object at 0x7f978aeb0290>, args: ('hello, world',), kwargs: {}
# Method Decorated: self: hello, world, args: (), kwargs: {}

function、bound method与unbound method的区别

上一节我们说到了bound method和unboud method,本小节将对这些概念进行具体说明。

 class Cls(object):

     def foo(self):
        pass
 instance = Cls()

 print 'foo' in Cls.__dict__                # True
 print 'foo' in instance.__dict__           # False

 print Cls.foo              # <unbound method Cls.foo>
 print instance.foo         # <bound method Cls.foo of <__main__.Cls object at 0x7ff05ddef390>>
 print Cls.__dict__['foo']  # <function foo at 0x7ff05dde98c0>

我们发现,foo是以function类型存在类的__dict__中的,但通过实例访问是会得到一个bound method,通过类访问是会得到一个unbound method。这是因为在python中,所有的函数都是非资料描述器(no data descriptor)。通过类或实例访问时,会被__get__方法会包装一层返回unbound method或bound method,而unboud和bound的区别在于method的im_self是否为空。bound method会自动将instance作为第一个入参,而unbound method对参数不做任何处理。
在上一小节的例子中,foo作为Decorator的一个成员变量,其type是一个function,所以不会自动地注入实例。

Cls.foo会被翻译成Cls.__dict __[‘foo’].__get__(None, Cls),返回一个unbound method(im_self is None)
instance.foo会被翻译成type(instance).__dic __[‘foo’].__get__(instance, type(instance)),返回一个bound method(im_self == instance)
instance.foo(args, kwargs) 等价于 Cls.foo(instance, args, kwargs)

修改方法

通过分析,我们发现根本原因在于,被装饰的foo作为Decorator实例的成员变量,其类型是一个function,失去了bound属性,不能自动地将instance实例注入到函数的第一个参数中去。为了解决这个,我们可以将Decorator实现成一个描述器,当被类或实例访问时,通过types.MethodType将Decorator实例包装成一个method。

class Decorator(object):

    def __init__(self, func):
        self.func = func

    def __get__(self, instance, owner):
        return types.MethodType(self, instance, owner)

    def __call__(self, *args, **kwargs):
        print("Decorator: self: {}, args: {}, kwargs: {}".format(self, args, kwargs))
        return self.func(*args, **kwargs)

参考文献

The Inside Story on New-Style Classes
python - Instancemethod or function? - Stack Overflow
Chris’s Wiki :: blog/python/HowFunctionsToMethods
Descriptor HowTo Guide — Python 2.7.15 documentation
python - How can I decorate an instance method with a decorator class? - Stack Overflow
Glossary — Python 2.7.15 documentation

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 包(lib)、模块(module) 在Python中,存在包和模块两个常见概念。 模块:编写Python代码的py...
    清清子衿木子水心阅读 3,801评论 0 27
  • 文/博土 终于记清楚日子了,因为开始营业了,每天都要记账。 二姐说他们在他们茶馆旁边找一个一室的自己住,我得自己找...
    博土阅读 129评论 0 0
  • 最近学习英语估计把耳朵听坏了,白天一整天感觉有好多只淘气的小蜜蜂在耳朵里“嗡嗡”作响。要是继续这样下去:革命尚未成...
    修墨68阅读 215评论 0 1
  • 个人目标 8月完成阅读2本书 睡前背成语10个 工作寻求新突破,改变。 每周持续微课学习!及时...
    柠檬少女心阅读 205评论 0 0