Descriptor 指南

Abstract

Definition and Introduction
通常来说， descriptor 是一种绑定着特殊行为属性的对象，在访问它时行为被descriptor协议定义的方法所重载。这些方法是__get__, __set__ 和__delete__。如果对象定义了任一方法，这个对象就被叫做descriptor.
访问对象的属性默认行为是get, set或delete对象字典中的属性。例如， a.x查找路径是从a.__dict__['x']开始，然后是type(a).__dict__['x'],并继续查找type(a)的祖先类（不包括metaclass).如果查找的值是定义了descriptor方法的对象，python可能会重载默认行为转而调用descriptor方法。这个行为在哪里发生取决于定义了哪些descriptor方法。注意，descriptor仅在新型对象或类中有效（新型类是继承于object或type的类）
descriptor是个功能强大，通用的协议。它是实现properties, method, static methods, class methods 和 super()功能背后的机制。它被python自己用来实现在2.2版本中引入的新型类。descriptors简化底层c代码并为python程序提供一套灵活的工具。

Descriptor Protocol
descr.__get__(self, obj, type=None) --> value

descr.__set__(self, obj, value) --> None

descr.__delete__(self, obj) --> None

所有东西就这些。定义其中任一方法的对象都被认为是descriptor并重载作为属性被查找时默认行为。
如果对象同时定义了__get__和__set__，它就被认为是一个data descriptor. 如果仅定义__get__则被称为non-data descriptor（通常用于methods，但也可做其他用途）
data和non-data descriptor不同之处在于，对于实例的字典中的实体，关心的是如何重载。如果实例字典中有一个与data decriptor同名的实体， data descriptor优先.如果是与non-data descriptor同名，字典实体优先。
如要创建只读的data descriptor，同时定义__get__和__set__, 然后在__set__里抛出一个AttributeError异常。定义会抛出异常的__set__方法就能保证它是data descriptor.

Invoking Descriptors
descriptor可以直接用它的方法名调用，例如d.__get__(obj)。
另外，更常见的调用方式是通过访问属性后自动被调用。例如， obj.d看起来是在obj的字典中查找d。如果d定义了__get__方法，则d.__get__(obj)会根据下面的优先规则被调用。
调用的细节取决于obj是对象还是类。无论怎样， descriptor只在新型类中起作用。如果一个类是object的子类，它就是新型类。
对于对象，机制在于object.__getattribute__，它转变b.x成type(b).__dict__['x'].__get__(b, type(b)).执行顺序沿着一个优先级链： data descriptor优于实例变量，实例变量优于non-datadescriptor，如有__getattr__则给予其最低的优先级。C实现可以在Object/object.c的PyObject_GeneriGetAttr()中找到。
对于类，机制在于type.__getattribute__, 它转变B.x成B.__dict__['x'].__get__(None, B)。在python中，看起来类似：
def __getattribute__(self, key):
    "Emulate type_getattro() in Objects/typeobject.c"
    v = object.__getattribute__(self, key)
    if hasattr(v, '__get__'):
       return v.__get__(None, self)
    return v

需要记住的要点是：
descriptors 是由__getattribute__调用的
重载__getattribute__会阻止了descriptor的自动调用
__getattribute__是只有新型类和对象才有的
object.__getattribute__ 和 type.__getattribute__调用__get__是不一样的
data descriptor会重载实例字典
non-data descriptor 会被实例字典重载
由super()返回的对象为调用descriptors,也有个自定义的__getattribute__。调用super(B, obj).m() 会搜索obj.__class__.__mro__，先是基类A，马上是B然后返回A.__dict__['m'].__get(obj, A)。如果m不是descriptor, 返回的m不变.如果不在字典中， m再使用object.__getattribute__重新查找。
请注意，在python2.2中，如果仅当m是data descriptor，super(B,obj).m()才会调用__get__()。而在python2.3中，是non-data descriptor也会被调用，除非涉及到旧型（经典）类。实现细节在objects/typeobject.c的super_getattro()，相等python版本可在guido的指南中找到。
上述详细展示了descriptor机制和细节都是内嵌到object, type和super（）的__getattribute__方法中。类会继承这些机制当类继承于object或他们的meta-class能提供相似功能时。同样，类可以通过重载__getattribute__关闭descriptor调用。

Descriptor Example
下面的代码创建了一个是data descriptor的类，它在每次get或set时都打印一条消息。如想更改所有属性行为，重载__getattribute__是一个另一种方法。然而，如只想监控几个选定的属性，descriptor非常有用。
class RevealAccess(object):
    """A data descriptor that sets and returns values
       normally and prints a message logging their access.
    """

    def __init__(self, initval=None, name='var'):
        self.val = initval
        self.name = name

    def __get__(self, obj, objtype):
        print 'Retrieving', self.name
        return self.val

    def __set__(self, obj, val):
        print 'Updating' , self.name
        self.val = val

>>> class MyClass(object):
x = RevealAccess(10, 'var "x"')
y = 5

>>> m = MyClass()
>>> m.x
Retrieving var "x"
10
>>> m.x = 20
Updating var "x"
>>> m.x
Retrieving var "x"
20
>>> m.y
5

descriptor 协议非常简单并且提供令人兴奋的各种可能性。几个用例是如此通用以至于他们都被打包成单独的涵数调用。properties, bound 和 unbound 方法，static方法， class方法都是基于descriptor 协议。

Properties
调用property()是构建data descriptor（存取属性会触发函数）的一个简洁方式。它的标志是：
property(fget=None, fset=None, fdel=None, doc=None) -> property attribute

下面展示了一个典型应用：
class C(object):
    def getx(self): return self.__x
    def setx(self, value): self.__x = value
    def delx(self): del self.__x
    x = property(getx, setx, delx, "I'm the 'x' property.")

property() python版实现：
class Property(object):
"Emulate PyProperty_Type() in Objects/descrobject.c"

    def __init__(self, fget=None, fset=None, fdel=None, doc=None):
        self.fget = fget
        self.fset = fset
        self.fdel = fdel
        self.__doc__ = doc

    def __get__(self, obj, objtype=None):
        if obj is None:
            return self
        if self.fget is None:
            raise AttributeError, "unreadable attribute"
        return self.fget(obj)

    def __set__(self, obj, value):
        if self.fset is None:
            raise AttributeError, "can't set attribute"
        self.fset(obj, value)

    def __delete__(self, obj):
        if self.fdel is None:
            raise AttributeError, "can't delete attribute"
        self.fdel(obj)

内建property()非常有用，当用户接口用来保证属性可用或在随后改变时需要干预。
比如，一个spreadsheet类打算通过Cel

补充：Web开发 , Python ,