python __set__ __get__ 等解释

转载 2012年04月21日 16:43:32

如果你和我一样,曾经对method和function以及对它们的各种访问方式包括self参数的隐含传递迷惑不解,建议你耐心的看下去。这里还提到了Python属性查找策略,使你清楚的知道Python处理obj.attr和obj.attr=val时,到底做了哪些工作。

Python中,对象的方法也是也可以认为是属性,所以下面所说的属性包含方法在内。

先定义下面这个类,还定义了它的一个实例,留着后面用。

Python代码  收藏代码
  1. class T(object):  
  2.     name = 'name'  
  3.     def hello(self):  
  4.         print 'hello'  
  5. t = T()   

使用dir(t)列出t的所有有效属性:

Python代码  收藏代码
  1. >>> dir(t)  
  2. ['__class__''__delattr__''__dict__''__doc__''__getattribute__',  
  3.  '__hash__''__init__''__module__''__new__''__reduce__''__reduce_ex__',  
  4.  '__repr__''__setattr__''__str__''__weakref__''hello''name']  

 

属性可以分为两类,一类是Python自动产生的,如__class__,__hash__等,另一类是我们自定义的,如上面的hello,name。我们只关心自定义属性。
类和实例对象(实际上,Python中一切都是对象,类是type的实例)都有__dict__属性,里面存放它们的自定义属性(对与类,里面还存放了别的东西)。

Python代码  收藏代码
  1. >>> t.__dict__  
  2. {}  
  3. >>> T.__dict__  
  4. <dictproxy object at 0x00CD0FF0>  
  5. >>> dict(T.__dict__)            #由于T.__dict__并没有直接返回dict对象,这里进行转换,以方便观察其中的内容  
  6. {'__module__''__main__''name''name',  
  7.  'hello': <function hello at 0x00CC2470>,  
  8.  '__dict__': <attribute '__dict__' of 'T' objects>,  
  9.  '__weakref__': <attribute '__weakref__' of 'T' objects>, '__doc__'None}  
  10. >>>   

有些内建类型,如list和string,它们没有__dict__属性,随意没办法在它们上面附加自定义属性。

 

到现在为止t.__dict__是一个空的字典,因为我们并没有在t上自定义任何属性,它的有效属性hello和name都是从T得到的。T的__dict__中包含hello和name。当遇到t.name语句时,Python怎么找到t的name属性呢?

首先,Python判断name属性是否是个自动产生的属性,如果是自动产生的属性,就按特别的方法找到这个属性,当然,这里的name不是自动产生的属性,而是我们自己定义的,Python于是到t的__dict__中寻找。还是没找到。

接着,Python找到了t所属的类T,搜索T.__dict__,期望找到name,很幸运,直接找到了,于是返回name的值:字符串‘name’。如果在T.__dict__中还没有找到,Python会接着到T的父类(如果T有父类的话)的__dict__中继续查找。

 

这不足以解决我们的困惑,因为事情远没有这么简单,上面说的其实是个简化的步骤。

 

继续上面的例子,对于name属性T.name和T.__dict__['name']是完全一样的。

Python代码  收藏代码
  1. >>> T.name  
  2. 'name'  
  3. >>> T.__dict__['name']  
  4. 'name'  
  5. >>>   

但是对于hello,情形就有些不同了

Python代码  收藏代码
  1. >>> T.hello  
  2. <unbound method T.hello>  
  3. >>> T.__dict__['hello']  
  4. <function hello at 0x00CC2470>  
  5. >>>   

可以发现,T.hello是个unbound method。而T.__dict__['hello']是个函数(不是方法)。

推断:方法在类的__dict__中是以函数的形式存在的(方法的定义和函数的定义简直一样,除了要把第一个参数设为self)。那么T.hello得到的应该也是个函数啊,怎么成了unbound method了。

再看看从实例t中访问hello

Python代码  收藏代码
  1. >>> t.hello  
  2. <bound method T.hello of <__main__.T object at 0x00CD0E50>>  
  3. >>>   

是一个bound method。

有意思,按照上面的查找策略,既然在T的__dict__中hello是个函数,那么T.hello和t.hello应该都是同一个函数才对。到底是怎么变成方法的,而且还分为unbound method和bound method。

关于unbound和bound到还好理解,我们不妨先作如下设想:方法是要从实例调用的嘛(指实例方法,classmethod和staticmethod后面讲),如果从类中访问,如T.hello,hello没有和任何实例发生联系,也就是没绑定(unbound)到任何实例上,所以是个unbound,对t.hello的访问方式,hello和t发生了联系,因此是bound。

但从函数<function hello at 0x00CC2470>到方法<unbound method T.hello>的确让人费解。

 

一切的魔法都源自今天的主角:descriptor

 

查找属性时,如obj.attr,如果Python发现这个属性attr有个__get__方法,Python会调用attr的__get__方法,返回__get__方法的返回值,而不是返回attr(这一句话并不准确,我只是希望你能对descriptor有个初步的概念)。

Python中iterator(怎么扯到Iterator了?)是实现了iterator协议的对象,也就是说它实现了下面两个方法__iter__和next()。类似的,descriptor也是实现了某些特定方法的对象。descriptor的特定方法是__get__,__set__和__delete__,其中__set__和__delete__方法是可选的。iterator必须依附某个对象而存在(由对象的__iter__方法返回),descriptor也必须依附对象,作为对象的一个属性,它而不能单独存在。还有一点,descriptor必须存在于类的__dict__中,这句话的意思是只有在类的__dict__中找到属性,Python才会去看看它有没有__get__等方法,对一个在实例的__dict__中找到的属性,Python根本不理会它有没有__get__等方法,直接返回属性本身。descriptor到底是什么呢:简单的说,descriptor是对象的一个属性,只不过它存在于类的__dict__中并且有特殊方法__get__(可能还有__set__和__delete)而具有一点特别的功能,为了方便指代这样的属性,我们给它起了个名字叫descriptor属性。

可能你还是不明白,下面开始用例子说明。

先定义这个类:

Python代码  收藏代码
  1. class Descriptor(object):  
  2.     def __get__(self, obj, type=None):  
  3.             return 'get'self, obj, type  
  4.     def __set__(self, obj, val):  
  5.         print 'set'self, obj, val  
  6.     def __delete__(self, obj):  
  7.         print 'delete'self, obj  

这里__set__和__delete__其实可以不出现,不过为了后面的说明,暂时把它们全写上。

下面解释一下三个方法的参数:

self当然不用说,指的是当前Descriptor的实例。obj值拥有属性的对象。这应该不难理解,前面已经说了,descriptor是对象的稍微有点特殊的属性,这里的obj就是拥有它的对象,要注意的是,如果是直接用类访问descriptor(别嫌啰嗦,descriptor是个属性,直接用类访问descriptor就是直接用类访问类的属性),obj的值是None。type是obj的类型,刚才说过,如果直接通过类访问descriptor,obj是None,此时type就是类本身。

三个方法的意义,假设T是一个类,t是它的一个实例,d是T的一个descriptor属性(牛什么啊,不就是有个__get__方法吗!),value是一个有效值:

读取属性时,如T.d,返回的是d.__get__(None, T)的结果,t.d返回的是d.__get__(t, T)的结果。

设置属性时,t.d = value,实际上调用d.__set__(t, value),T.d = value,这是真正的赋值,T.d的值从此变成value。删除属性和设置属性类似。

下面用例子说明,看看Python中执行是怎么样的:

重新定义我们的类T和实例t

Python代码  收藏代码
  1. class T(object):  
  2.     d = Descriptor()  
  3. t = T()  

 d是T的类属性,作为Descriptor的实例,它有__get__等方法,显然,d满足了所有的条件,现在它就是一个descriptor!

Python代码  收藏代码
  1. >>> t.d         #t.d,返回的实际是d.__get__(t, T)  
  2. ('get', <__main__.Descriptor object at 0x00CD9450>, <__main__.T object at 0x00CD0E50>, <class '__main__.T'>)  
  3. >>> T.d        #T.d,返回的实际是d.__get__(None, T),所以obj的位置为None  
  4. ('get', <__main__.Descriptor object at 0x00CD9450>, None, <class '__main__.T'>)  
  5. >>> t.d = 'hello'   #在实例上对descriptor设置值。要注意的是,现在显示不是返回值,而是__set__方法中  
  6.                                print语句输出的。  
  7. set <__main__.Descriptor object at 0x00CD9450> <__main__.T object at 0x00CD0E50> hello  
  8. >>> t.d         #可见,调用了Python调用了__set__方法,并没有改变t.d的值  
  9. ('get', <__main__.Descriptor object at 0x00CD9450>, <__main__.T object at 0x00CD0E50>, <class '__main__.T'>)  
  10. >>> T.d = 'hello'   #没有调用__set__方法  
  11. >>> T.d                #确实改变了T.d的值  
  12. 'hello'  
  13. >>> t.d               #t.d的值也变了,这可以理解,按我们上面说的属性查找策略,t.d是从T.__dict__中得到的  
  14.                               T.__dict__['d']的值是'hello',t.d当然也是'hello'  
  15. 'hello'  

data descriptor和non-data descriptor

象上面的d,同时具有__get__和__set__方法,这样的descriptor叫做data descriptor,如果只有__get__方法,则叫做non-data descriptor。容易想到,由于non-data descriptor没有__set__方法,所以在通过实例对属性赋值时,例如上面的t.d = 'hello',不会再调用__set__方法,会直接把t.d的值变成'hello'吗?口说无凭,实例为证:

Python代码  收藏代码
  1. class Descriptor(object):  
  2.     def __get__(self, obj, type=None):  
  3.             return 'get'self, obj, type  
  4. class T(object):  
  5.        d = Descriptor()  
  6. t = T()  
 
Python代码  收藏代码
  1. >>> t.d  
  2. ('get', <__main__.Descriptor object at 0x00CD9550>, <__main__.T object at 0x00CD9510>, <class '__main__.T'>)  
  3. >>> t.d = 'hello'  
  4. >>> t.d  
  5. 'hello'  
  6. >>>   

在实例上对non-data descriptor赋值隐藏了实例上的non-data descriptor!

 

是时候坦白真正详细的属性查找策略 了,对于obj.attr(注意:obj可以是一个类):

1.如果attr是一个Python自动产生的属性,找到!(优先级非常高!)

2.查找obj.__class__.__dict__,如果attr存在并且是data descriptor,返回data descriptor的__get__方法的结果,如果没有继续在obj.__class__的父类以及祖先类中寻找data descriptor

3.在obj.__dict__中查找,这一步分两种情况,第一种情况是obj是一个普通实例,找到就直接返回,找不到进行下一步。第二种情况是obj是一个类,依次在obj和它的父类、祖先类的__dict__中查找,如果找到一个descriptor就返回descriptor的__get__方法的结果,否则直接返回attr。如果没有找到,进行下一步。

4.在obj.__class__.__dict__中查找,如果找到了一个descriptor(插一句:这里的descriptor一定是non-data descriptor,如果它是data descriptor,第二步就找到它了)descriptor的__get__方法的结果。如果找到一个普通属性,直接返回属性值。如果没找到,进行下一步。

5.很不幸,Python终于受不了。在这一步,它raise AttributeError

 

利用这个,我们简单分析一下上面为什么要强调descriptor要在类中才行。我们感兴趣的查找步骤是2,3,4。第2步和第4步都是在类中查找。对于第3步,如果在普通实例中找到了,直接返回,没有判断它有没有__get__()方法。

 

对属性赋值时的查找策略 ,对于obj.attr = value

1.查找obj.__class__.__dict__,如果attr存在并且是一个data descriptor,调用attr的__set__方法,结束。如果不存在,会继续到obj.__class__的父类和祖先类中查找,找到 data descriptor则调用其__set__方法。没找到则进入下一步。

2.直接在obj.__dict__中加入obj.__dict__['attr'] = value

 

顺便分析下为什么在实例上对non-data descriptor赋值隐藏了实例上的non-data descriptor。

接上面的non-data descriptor例子

Python代码  收藏代码
  1. >>> t.__dict__  
  2. {'d''hello'}  

 在t的__dict__里出现了d这个属性。根据对属性赋值的查找策略,第1步,确实在t.__class__.__dict__也就是T.__dict__中找到了属性d,但它是一个non-data descriptor,不满足data descriptor的要求,进入第2步,直接在t的__dict__属性中加入了属性和属性值。当获取t.d时,执行查找策略,第2步在T.__dict__中找到了d,但它是non-data descriptor,步满足要求,进行第3步,在t的__dict__中找到了d,直接返回了它的值'hello'。

 

说了这么半天,还没到函数和方法!

算了,明天在说吧

简单提一下,所有的函数(方法)都有__get__方法,当它们在类的__dict__中是,它们就是non-data descriptor。

Python语言学习讲解十六:python之描述符__set__和__get__ 等解释

注:每周一到周五都会进行相关Python基础知识更新,欢迎大家提宝贵的意见 一、方法: 首先说下python中存在的几种方法:对象方法、静态方法、类方法等,归属权分别为obj、cls、cls 其实...

python中__get__, __getattr__和__getattribute__区别说明

__get__,__getattr__和__getattribute都是访问属性的方法,但不太相同。 object.__getattr__(self, name) 当一般位置找不到attribute的...

python __set__ __get__ 等解释

如果你和我一样,曾经对method和function以及对它们的各种访问方式包括self参数的隐含传递迷惑不解,建议你耐心的看下去。这里还提到了Python属性查找策略,使你清楚的知道Python处理...

python总结(五):__get__、__getattr__、__getitem__、__getattribute__之间的差异与联系

python的一切数据都是对象,包括函数、基本数据类型、自定义数据类型等等,这其中最复杂的就是对象内部存储的数据结构(引用),包括类属性、数据描述符、实例属性及非数据描述符,不仅它们的优先级不一样,而...
  • yiifaa
  • yiifaa
  • 2017年09月23日 10:00
  • 153

Python中字典get方法的使用

说起来,这个功能是否需要学习还真是有待于讨论。其实,知道了字典这种数据结构以后,通过最基本的Python功能也能够实现一个类似的功能。不过,既然内置了这个功能那么我们就没有必要重复造车轮。     ...

每天学点Python之set

每天学点Python之set集合中包含一系列的元素,在Python中这些元素不需要是相同的类型,且这些元素在集合中是没有存储顺序的。集合的赋值集合的表示方法是花括号,这与字典是一样的,可以通过括号或构...

面向对象之魔术方法__get()和__set()

__get()方法:这个方法用来获取私有成员和保护成员属性值的,有一个参数,参数传入你要获取的成员属性的名称,返回获取的属性值,这个方法不用我们手工的去调用,因为我们也可以把这个方法做成私有的方法,是...

Python Class 的实例方法/类方法/静态方法

1. 定义实例方法、类方法、静态方法class MyClass(object): class_name = "MyClass" # 类属性, 三种方法都能调用 def __init__(...

Python语言学习讲解十四:python之用纯属性取代get和set方法

注:每周一到周五都会进行相关Python基础知识更新,欢迎大家提宝贵的意见 一、从其他语言转入python的开发者,一般可能在设计类的时候,在其中填写get和set方法,用来获取和设置类的成员属性。 ...

python property 与get/set方法详解

1.java里get/set方法大部分的同学开始写java代码的时候,最初始的代码肯定是字段的get/set方法。大家对于java特别冗长的诟病,很大一部分来自于无处不在的get/set方法。甚至国内...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:python __set__ __get__ 等解释
举报原因:
原因补充:

(最多只允许输入30个字)