實現描述器 · Python3.7.3官方文檔簡體中文

### 導航 - [索引](../genindex.xhtml "總目錄") - [模塊](../py-modindex.xhtml "Python 模塊索引") | - [下一頁](functional.xhtml "函數式編程指引") | - [上一頁](curses.xhtml "Curses Programming with Python") | - ![](https://box.kancloud.cn/a721fc7ec672275e257bbbfde49a4d4e_16x16.png) - [Python](https://www.python.org/) ? - zh\_CN 3.7.3 [文檔](../index.xhtml) ? - [Python 常用指引](index.xhtml) ? - $('.inline-search').show(0); | # [實現描述器](#id2) 作者Raymond Hettinger 聯系方式<python at rcn dot com> 目錄 - [實現描述器](#descriptor-howto-guide) - [摘要](#abstract) - [定義和簡介](#definition-and-introduction) - [描述器協議](#descriptor-protocol) - [發起調用描述符](#invoking-descriptors) - [描述符示例](#descriptor-example) - [Properties](#properties) - [函數和方法](#functions-and-methods) - [Static Methods and Class Methods](#static-methods-and-class-methods) ## [摘要](#id3) Defines descriptors, summarizes the protocol, and shows how descriptors are called. Examines a custom descriptor and several built-in Python descriptors including functions, properties, static methods, and class methods. Shows how each works by giving a pure Python equivalent and a sample application. 學習描述器不僅能提供接觸到更多工具集的方法，還能更深地理解 Python 工作的原理并更加體會到其設計的優雅性。 ## [定義和簡介](#id4) 一般地，一個描述器是一個包含 “綁定行為” 的對象，對其屬性的存取被描述器協議中定義的方法覆蓋。這些方法有：[`__get__()`](../reference/datamodel.xhtml#object.__get__ "object.__get__")，[`__set__()`](../reference/datamodel.xhtml#object.__set__ "object.__set__") 和 [`__delete__()`](../reference/datamodel.xhtml#object.__delete__ "object.__delete__")。如果某個對象中定義了這些方法中的任意一個，那么這個對象就可以被稱為一個描述器。屬性訪問的默認行為是從一個對象的字典中獲取、設置或刪除屬性。例如，`a.x` 的查找順序會從 `a.__dict__['x']` 開始，然后是 `type(a).__dict__['x']`，接下來依次查找 `type(a)` 的基類，不包括元類。如果找到的值是定義了某個描述器方法的對象，則 Python 可能會重載默認行為并轉而發起調用描述器方法。這具體發生在優先級鏈的哪個環節則要根據所定義的描述器方法及其被調用的方式來決定。 Descriptors are a powerful, general purpose protocol. They are the mechanism behind properties, methods, static methods, class methods, and [`super()`](../library/functions.xhtml#super "super"). They are used throughout Python itself to implement the new style classes introduced in version 2.2. Descriptors simplify the underlying C-code and offer a flexible set of new tools for everyday Python programs. ## [描述器協議](#id5) `descr.__get__(self, obj, type=None) -> value` `descr.__set__(self, obj, value) -> None` `descr.__delete__(self, obj) -> None` That is all there is to it. Define any of these methods and an object is considered a descriptor and can override default behavior upon being looked up as an attribute. If an object defines both [`__get__()`](../reference/datamodel.xhtml#object.__get__ "object.__get__") and [`__set__()`](../reference/datamodel.xhtml#object.__set__ "object.__set__"), it is considered a data descriptor. Descriptors that only define [`__get__()`](../reference/datamodel.xhtml#object.__get__ "object.__get__") are called non-data descriptors (they are typically used for methods but other uses are possible). Data and non-data descriptors differ in how overrides are calculated with respect to entries in an instance's dictionary. If an instance's dictionary has an entry with the same name as a data descriptor, the data descriptor takes precedence. If an instance's dictionary has an entry with the same name as a non-data descriptor, the dictionary entry takes precedence. To make a read-only data descriptor, define both [`__get__()`](../reference/datamodel.xhtml#object.__get__ "object.__get__") and [`__set__()`](../reference/datamodel.xhtml#object.__set__ "object.__set__") with the [`__set__()`](../reference/datamodel.xhtml#object.__set__ "object.__set__") raising an [`AttributeError`](../library/exceptions.xhtml#AttributeError "AttributeError") when called. Defining the [`__set__()`](../reference/datamodel.xhtml#object.__set__ "object.__set__") method with an exception raising placeholder is enough to make it a data descriptor. ## [發起調用描述符](#id6) A descriptor can be called directly by its method name. For example, `d.__get__(obj)`. Alternatively, it is more common for a descriptor to be invoked automatically upon attribute access. For example, `obj.d` looks up `d` in the dictionary of `obj`. If `d` defines the method [`__get__()`](../reference/datamodel.xhtml#object.__get__ "object.__get__"), then `d.__get__(obj)`is invoked according to the precedence rules listed below. The details of invocation depend on whether `obj` is an object or a class. For objects, the machinery is in [`object.__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__") which transforms `b.x` into `type(b).__dict__['x'].__get__(b, type(b))`. The implementation works through a precedence chain that gives data descriptors priority over instance variables, instance variables priority over non-data descriptors, and assigns lowest priority to [`__getattr__()`](../reference/datamodel.xhtml#object.__getattr__ "object.__getattr__") if provided. The full C implementation can be found in [`PyObject_GenericGetAttr()`](../c-api/object.xhtml#c.PyObject_GenericGetAttr "PyObject_GenericGetAttr") in [Objects/object.c](https://github.com/python/cpython/tree/3.7/Objects/object.c) \[https://github.com/python/cpython/tree/3.7/Objects/object.c\]. For classes, the machinery is in `type.__getattribute__()` which transforms `B.x` into `B.__dict__['x'].__get__(None, B)`. In pure Python, it looks like: ``` 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 ``` The important points to remember are: - descriptors are invoked by the [`__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__") method - overriding [`__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__") prevents automatic descriptor calls - [`object.__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__") and `type.__getattribute__()` make different calls to [`__get__()`](../reference/datamodel.xhtml#object.__get__ "object.__get__"). - data descriptors always override instance dictionaries. - non-data descriptors may be overridden by instance dictionaries. The object returned by `super()` also has a custom [`__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__")method for invoking descriptors. The call `super(B, obj).m()` searches `obj.__class__.__mro__` for the base class `A` immediately following `B`and then returns `A.__dict__['m'].__get__(obj, B)`. If not a descriptor, `m` is returned unchanged. If not in the dictionary, `m` reverts to a search using [`object.__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__"). The implementation details are in `super_getattro()` in [Objects/typeobject.c](https://github.com/python/cpython/tree/3.7/Objects/typeobject.c) \[https://github.com/python/cpython/tree/3.7/Objects/typeobject.c\]. and a pure Python equivalent can be found in [Guido's Tutorial](https://www.python.org/download/releases/2.2.3/descrintro/#cooperation) \[https://www.python.org/download/releases/2.2.3/descrintro/#cooperation\]. The details above show that the mechanism for descriptors is embedded in the [`__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__") methods for [`object`](../library/functions.xhtml#object "object"), [`type`](../library/functions.xhtml#type "type"), and [`super()`](../library/functions.xhtml#super "super"). Classes inherit this machinery when they derive from [`object`](../library/functions.xhtml#object "object") or if they have a meta-class providing similar functionality. Likewise, classes can turn-off descriptor invocation by overriding [`__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__"). ## [描述符示例](#id7) The following code creates a class whose objects are data descriptors which print a message for each get or set. Overriding [`__getattribute__()`](../reference/datamodel.xhtml#object.__getattribute__ "object.__getattribute__") is alternate approach that could do this for every attribute. However, this descriptor is useful for monitoring just a few chosen attributes: ``` 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 ``` The protocol is simple and offers exciting possibilities. Several use cases are so common that they have been packaged into individual function calls. Properties, bound methods, static methods, and class methods are all based on the descriptor protocol. ## [Properties](#id8) Calling [`property()`](../library/functions.xhtml#property "property") is a succinct way of building a data descriptor that triggers function calls upon access to an attribute. Its signature is: ``` property(fget=None, fset=None, fdel=None, doc=None) -> property attribute ``` The documentation shows a typical use to define a managed attribute `x`: ``` 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.") ``` To see how [`property()`](../library/functions.xhtml#property "property") is implemented in terms of the descriptor protocol, here is a pure Python equivalent: ``` 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 if doc is None and fget is not None: doc = fget.__doc__ 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) def getter(self, fget): return type(self)(fget, self.fset, self.fdel, self.__doc__) def setter(self, fset): return type(self)(self.fget, fset, self.fdel, self.__doc__) def deleter(self, fdel): return type(self)(self.fget, self.fset, fdel, self.__doc__) ``` The [`property()`](../library/functions.xhtml#property "property") builtin helps whenever a user interface has granted attribute access and then subsequent changes require the intervention of a method. For instance, a spreadsheet class may grant access to a cell value through `Cell('b10').value`. Subsequent improvements to the program require the cell to be recalculated on every access; however, the programmer does not want to affect existing client code accessing the attribute directly. The solution is to wrap access to the value attribute in a property data descriptor: ``` class Cell(object): . . . def getvalue(self): "Recalculate the cell before returning value" self.recalc() return self._value value = property(getvalue) ``` ## [函數和方法](#id9) Python's object oriented features are built upon a function based environment. Using non-data descriptors, the two are merged seamlessly. Class dictionaries store methods as functions. In a class definition, methods are written using [`def`](../reference/compound_stmts.xhtml#def) or [`lambda`](../reference/expressions.xhtml#lambda), the usual tools for creating functions. Methods only differ from regular functions in that the first argument is reserved for the object instance. By Python convention, the instance reference is called *self* but may be called *this* or any other variable name. To support method calls, functions include the [`__get__()`](../reference/datamodel.xhtml#object.__get__ "object.__get__") method for binding methods during attribute access. This means that all functions are non-data descriptors which return bound methods when they are invoked from an object. In pure Python, it works like this: ``` class Function(object): . . . def __get__(self, obj, objtype=None): "Simulate func_descr_get() in Objects/funcobject.c" if obj is None: return self return types.MethodType(self, obj) ``` Running the interpreter shows how the function descriptor works in practice: ``` >>> class D(object): ... def f(self, x): ... return x ... >>> d = D() # Access through the class dictionary does not invoke __get__. # It just returns the underlying function object. >>> D.__dict__['f'] <function D.f at 0x00C45070> # Dotted access from a class calls __get__() which just returns # the underlying function unchanged. >>> D.f <function D.f at 0x00C45070> # The function has a __qualname__ attribute to support introspection >>> D.f.__qualname__ 'D.f' # Dotted access from an instance calls __get__() which returns the # function wrapped in a bound method object >>> d.f <bound method D.f of <__main__.D object at 0x00B18C90>> # Internally, the bound method stores the underlying function, # the bound instance, and the class of the bound instance. >>> d.f.__func__ <function D.f at 0x1012e5ae8> >>> d.f.__self__ <__main__.D object at 0x1012e1f98> >>> d.f.__class__ <class 'method'> ``` ## [Static Methods and Class Methods](#id10) Non-data descriptors provide a simple mechanism for variations on the usual patterns of binding functions into methods. To recap, functions have a [`__get__()`](../reference/datamodel.xhtml#object.__get__ "object.__get__") method so that they can be converted to a method when accessed as attributes. The non-data descriptor transforms an `obj.f(*args)` call into `f(obj, *args)`. Calling `klass.f(*args)`becomes `f(*args)`. This chart summarizes the binding and its two most useful variants: > Transformation > > Called from an Object > > Called from a Class > > 函數 > > f(obj, \*args) > > f(\*args) > > 靜態方法 > > f(\*args) > > f(\*args) > > 類方法 > > f(type(obj), \*args) > > f(klass, \*args) Static methods return the underlying function without changes. Calling either `c.f` or `C.f` is the equivalent of a direct lookup into `object.__getattribute__(c, "f")` or `object.__getattribute__(C, "f")`. As a result, the function becomes identically accessible from either an object or a class. Good candidates for static methods are methods that do not reference the `self` variable. For instance, a statistics package may include a container class for experimental data. The class provides normal methods for computing the average, mean, median, and other descriptive statistics that depend on the data. However, there may be useful functions which are conceptually related but do not depend on the data. For instance, `erf(x)` is handy conversion routine that comes up in statistical work but does not directly depend on a particular dataset. It can be called either from an object or the class: `s.erf(1.5) --> .9332` or `Sample.erf(1.5) --> .9332`. Since staticmethods return the underlying function with no changes, the example calls are unexciting: ``` >>> class E(object): ... def f(x): ... print(x) ... f = staticmethod(f) ... >>> E.f(3) 3 >>> E().f(3) 3 ``` Using the non-data descriptor protocol, a pure Python version of [`staticmethod()`](../library/functions.xhtml#staticmethod "staticmethod") would look like this: ``` class StaticMethod(object): "Emulate PyStaticMethod_Type() in Objects/funcobject.c" def __init__(self, f): self.f = f def __get__(self, obj, objtype=None): return self.f ``` Unlike static methods, class methods prepend the class reference to the argument list before calling the function. This format is the same for whether the caller is an object or a class: ``` >>> class E(object): ... def f(klass, x): ... return klass.__name__, x ... f = classmethod(f) ... >>> print(E.f(3)) ('E', 3) >>> print(E().f(3)) ('E', 3) ``` This behavior is useful whenever the function only needs to have a class reference and does not care about any underlying data. One use for classmethods is to create alternate class constructors. In Python 2.3, the classmethod [`dict.fromkeys()`](../library/stdtypes.xhtml#dict.fromkeys "dict.fromkeys") creates a new dictionary from a list of keys. The pure Python equivalent is: ``` class Dict(object): . . . def fromkeys(klass, iterable, value=None): "Emulate dict_fromkeys() in Objects/dictobject.c" d = klass() for key in iterable: d[key] = value return d fromkeys = classmethod(fromkeys) ``` Now a new dictionary of unique keys can be constructed like this: ``` >>> Dict.fromkeys('abracadabra') {'a': None, 'r': None, 'b': None, 'c': None, 'd': None} ``` Using the non-data descriptor protocol, a pure Python version of [`classmethod()`](../library/functions.xhtml#classmethod "classmethod") would look like this: ``` class ClassMethod(object): "Emulate PyClassMethod_Type() in Objects/funcobject.c" def __init__(self, f): self.f = f def __get__(self, obj, klass=None): if klass is None: klass = type(obj) def newfunc(*args): return self.f(klass, *args) return newfunc ``` ### 導航 - [索引](../genindex.xhtml "總目錄") - [模塊](../py-modindex.xhtml "Python 模塊索引") | - [下一頁](functional.xhtml "函數式編程指引") | - [上一頁](curses.xhtml "Curses Programming with Python") | - ![](https://box.kancloud.cn/a721fc7ec672275e257bbbfde49a4d4e_16x16.png) - [Python](https://www.python.org/) ? - zh\_CN 3.7.3 [文檔](../index.xhtml) ? - [Python 常用指引](index.xhtml) ? - $('.inline-search').show(0); | ? [版權所有](../copyright.xhtml) 2001-2019, Python Software Foundation. Python 軟件基金會是一個非盈利組織。 [請捐助。](https://www.python.org/psf/donations/) 最后更新于 5月 21, 2019. [發現了問題](../bugs.xhtml)？使用[Sphinx](http://sphinx.pocoo.org/)1.8.4 創建。