【Python魔术方法】几个特殊的__get*__方法

简述

结合代码区分一下python的几个魔术方法__get__, __getattr__, __getattribute__, __getitem__

操作环境

win7_64 + Python 2.7.16 + IPython 5.9.0

__dict__

首先我们通过obj.attr的方式访问对象属性的时候,在python内部,实际是访问了obj.__dict__[attr]__dict__有文章单独说明,这里只需要简单理解,一般情况下,我们访问一个对象的属性,其实是在读取这个属性的__dict__字典:

In [7]: class Test(object):
   ...:     def __init__(self):
   ...:         self.a = 1
   ...:         self.b = 2
   ...:

# 定义了一个Test类的对象t
In [8]: t = Test()

# 虽然t没有显示定义__dict__属性,但是python会自动生成,它是一个字典
In [9]: t.__dict__
Out[9]: {'a': 1, 'b': 2}

In [10]: t.a
Out[10]: 1

# t.a的访问方式等价于t.__dict__['a']的访问方式
In [11]: t.__dict__['a']
Out[11]: 1

__getattr__

如果一个类定义了此方法,当访问一个类不存在的属性的时候,会访问此方法并且返回对应的值,如果不存在对应的访问,应该抛出AttributeError

In [10]: class Test(object):
    ...:     def __init__(self):
    ...:         self.a = 1
    ...:
    ...:     def __getattr__(self, name): # name参数就是访问的属性
    ...:         print name
    ...:         return 2
    ...:
    ...: t = Test()
    ...:

In [11]: t.a
Out[11]: 1

In [12]: t.b
b
Out[12]: 2

In [13]: t.c
c
Out[13]: 2

t对象有a属性,所以获取到了对应的值,但是bc均不是对象t的属性,故访问了__getattr__方法,参数name获取到了对应的属性名,并且都返回2.

注意下面的代码

class Test(object):
    def __init__(self):
        self.a = 1
        
    def __getattr__(self, name):
        return self.name
        
t = Test()
t.b

当我们在访问t.b的时候,t对象没有b属性,会访问__getattr__,此方法再次通过self.name的方式尝试访问b属性,还是不存在,同样走到了__getattr__,这样会造成无限循环,直到最后抛出RuntimeError: maximum recursion depth exceeded异常,我们可以通过下面的方式来避免出现这种情况:

class Test(object):
    def __init__(self):
        self.a = 1
        
    def __getattr__(self, name):
        # 有对应的属性,我们才访问它的属性
        if hasattr(self, name):
            # getattr访问属性的方式和t.b的方式是一样的
            return getattr(self, name)
        else:
            # 否则直接抛出异常
            raise AttributeError()
        
t = Test()
t.b

__getattribute__

只要定义了此函数,任何属性访问,会无条件的调用此方法,也就是屏蔽了__dict____getattr__

In [10]: class Test(object):
    ...:     def __init__(self):
    ...:         self.a = 1
    ...:
    ...:     def __getattr__(self, name):
    ...:         print '__getattr__'
    ...:
    ...:     def __getattribute__(self, name):
    ...:         print '__getattribute__'
    ...:
    ...: t = Test()
    ...: t.b
    ...:
__getattribute__

# 同样t.__dict__也是在访问t的属性,也访问到了__getattribute__方法
In [11]: t.__dict__
__getattribute__
  1. 它和__getattr__一样,如果不想有对应的属性,应该抛出AttributeError,而且也需要注意递归访问的情况出现
  2. 此方法只针对新式类有效,老式类此方法是不会生效的,除非主动调用

__getitem__

这个方法最简单,定义此方法的类一般是模拟容器的行为,比如模拟字典,列表的访问

In [12]: class Test(object):
    ...:     def __init__(self):
    ...:         self.a = 1
    ...:
    ...:     def __getitem__(self, key):
    ...:         print key
    ...:
    ...: t = Test()
    ...: t['a']
    ...: t[1]
    ...:
a
1
  1. 其中key在列表里面是整数,在字典里面可以是字符串
  2. 如果key的类型不正确,应该抛出TypeError
  3. 如果key索引错误抛出IndexError
  4. 如果key在字典不存在则抛出KeyError

__get__
此方法涉及到描述符的概念,由于篇幅较长,会单独写一篇文章记录。

总结

  1. 新式类只要定义了__getattribute__,则会无条件访问,但老式类不生效
  2. 定义了__getattr__,如果访问的属性不存在的时候,才会访问此方法
  3. __getitem__最简单,用于模拟容器的访问方式
  4. __getattribute____getattr__都应避免进入递归调用,并且如果访问的属性不应该存在的情况下,需要抛出AttributeError异常
  5. getattr(obj, attr)的方式访问属性和obj.attr的方式是一样的,都等同于obj.__dict__[attr]

参考

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