Python中的descriptor描述器简明使用指南

当定义迭代器的时候，描述是实现迭代协议的对象，即实现__iter__方法的对象。同理，所谓描述器，即实现了描述符协议，即__get__, __set__, 和 __delete__方法的对象。

单看定义，还是比较抽象的。talk is cheap。看代码吧：

class WebFramework(object):
  def __init__(self, name='Flask'):
    self.name = name

  def __get__(self, instance, owner):
    return self.name

  def __set__(self, instance, value):
    self.name = value

class PythonSite(object):

  webframework = WebFramework()

In [1]: PythonSite.webframework
Out[1]: 'Flask'

In [2]: PythonSite.webframework = 'Tornado'

In [3]: PythonSite.webframework
Out[3]: 'Tornado'

定义了一个类WebFramework，它实现了描述符协议__get__和__set__，该对象（类也是对象，一切都是对象）即成为了一个描述器。同时实现__get__和__set__的称之为资料描述器（data descriptor）。仅仅实现__get__的则为非描述器。两者的差别是相对于实例的字典的优先级。

如果实例字典中有与描述器同名的属性，如果描述器是资料描述器，优先使用资料描述器，如果是非资料描述器，优先使用字典中的属性。

描述器的调用
对于这类魔法，其调用方法往往不是直接使用的。例如装饰器需要用 @ 符号调用。迭代器通常在迭代过程，或者使用 next 方法调用。描述器则比较简单，对象属性的时候会调用。

In [15]: webframework = WebFramework()

In [16]: webframework.__get__(webframework, WebFramework)
Out[16]: 'Flask'

描述器的应用
描述器的作用主要在方法和属性的定义上。既然我们可以重新描述类的属性，那么这个魔法就可以改变类的一些行为。最简单的应用则是可以配合装饰器，写一个类属性的缓存。Flask的作者写了一个werkzeug网络工具库，里面就使用描述器的特性，实现了一个缓存器。

class _Missing(object):
  def __repr__(self):
    return 'no value'

  def __reduce__(self):
    return '_missing'

_missing = _Missing()

class cached_property(object):
  def __init__(self, func, name=None, doc=None):
    self.__name__ = name or func.__name__
    self.__module__ = func.__module__
    self.__doc__ = doc or func.__doc__
    self.func = func

  def __get__(self, obj, type=None):
    if obj is None:
      return self
    value = obj.__dict__.get(self.__name__, _missing)
    if value is _missing:
      value = self.func(obj)
      obj.__dict__[self.__name__] = value
    return value

class Foo(object):
  @cached_property
  def foo(self):
    print 'first calculate'
    result = 'this is result'
    return result

f = Foo()

print f.foo  # first calculate this is result
print f.foo  # this is result

运行结果可见，first calculate只在第一次调用时候被计算之后就把结果缓存起来了。这样的好处是在网络编程中，对HTTP协议的解析，通常会把HTTP的header解析成python的一个字典，而在视图函数的时候，可能不知一次的访问这个header，因此把这个header使用描述器缓存起来，可以减少多余的解析。

描述器在python的应用十分广泛，通常是配合装饰器一起使用。强大的魔法来自强大的责任。描述器还可以用来实现ORM中对sql语句的"预编译"。恰当的使用描述器，可以让自己的Python代码更优雅。

赞 (0)

相关推荐

  • Python中用Descriptor实现类级属性(Property)详解

    上篇文章简单介绍了python中描述器(Descriptor)的概念和使用,有心的同学估计已经Get√了该技能.本篇文章通过一个Descriptor的使用场景再次给出一个案例,让不了解情况的同学可以更容易理解. 先说说decorator 这两个单词确实是有些相似,同时在使用中也是形影不离.这也给人造成了理解上的困难,说装饰器和描述器到底是怎么回事,为什么非得用一个@符号再加上描述器才行. 很多文章也都把这俩结合着讲,我自己看完之后都会觉得很绕.其实学习一个知识点,和做项目开发一个功能是一样的.在

  • 解密Python中的描述符（descriptor）

    Python中包含了许多内建的语言特性,它们使得代码简洁且易于理解.这些特性包括列表/集合/字典推导式,属性(property).以及装饰器(decorator).对于大部分特性来说,这些"中级"的语言特性有着完善的文档,并且易于学习. 但是这里有个例外,那就是描述符.至少对于我来说,描述符是Python语言核心中困扰我时间最长的一个特性.这里有几点原因如下: 1.有关描述符的官方文档相当难懂,而且没有包含优秀的示例告诉你为什么需要编写描述符(我得为Raymond Hettinger辩

  • 详解Python中的Descriptor描述符类

    描述符是调和属性访问的一个类.描述符类可用来获取.设置或删除属性值.描述符对象是在类定义的时候构建在一个类中的. 一般来说,描述符是一个具有绑定行为的对象属性,其属性的访问被描述符协议方法覆写.这些方法是__get__(). __set__()和__delete__(),一个对象中只要包含了这三个方法(译者注:包含至少一个),就称它为描述符. 属性访问的默认行为是从一个对象的字典中获取 (get).设置 (set).删除 (delete) 属性.例如:a.x 的查找链始于 a.__dict__[

  • 轻松理解Python 中的 descriptor

    定义 通常,一个 descriptor 是具有"绑定行为"的对象属性.所绑定行为可通过 descriptor 协议被自定义的 __get__() , __set__() 和 __delete__() 方法重写.如果一个对象的上述三个方法任意一个被重写,则就可被称为 descriptor. 属性的默认操作是从对象字典中获取.设置和删除一个属性.例如,a.x 有一个查找链,先 a.__dict__['x'] ,若没有则 type(a).__dict__['x'] ,若没有增往上查找父类直到

  • python的描述符(descriptor)、装饰器（property）造成的一个无限递归问题分享

    分享一下刚遇到的一个小问题,我有一段类似于这样的python代码: 复制代码 代码如下: # coding: utf-8 class A(object): @property     def _value(self): #        raise AttributeError("test")         return {"v": "This is a test."} def __getattr__(self, key):         p

  • Python描述器descriptor详解

    前面说了descriptor,这个东西其实和Java的setter,getter有点像.但这个descriptor和上文中我们开始提到的函数方法这些东西有什么关系呢? 所有的函数都可以是descriptor,因为它有__get__方法. 复制代码 代码如下: >>> def hello():      pass  >>> dir(hello)  ['__call__', '__class__', '__delattr__', '__dict__', '__doc__',

  • Python中的descriptor描述器简明使用指南

    当定义迭代器的时候,描述是实现迭代协议的对象,即实现__iter__方法的对象.同理,所谓描述器,即实现了描述符协议,即__get__, __set__, 和 __delete__方法的对象. 单看定义,还是比较抽象的.talk is cheap.看代码吧: class WebFramework(object): def __init__(self, name='Flask'): self.name = name def __get__(self, instance, owner): retur

  • 深入解析Python中的descriptor描述器的作用及用法

    一般来说,一个描述器是一个有"绑定行为"的对象属性(object attribute),它的访问控制被描述器协议方法重写.这些方法是 __get__(), __set__(), 和 __delete__() .有这些方法的对象叫做描述器. 默认对属性的访问控制是从对象的字典里面(__dict__)中获取(get), 设置(set)和删除(delete)它.举例来说, a.x 的查找顺序是, a.__dict__['x'] , 然后 type(a).__dict__['x'] , 然后找

  • Python中的Descriptor描述符学习教程

    Descriptor是什么?简而言之,Descriptor是用来定制访问类或实例的成员的一种协议.额..好吧,一句话是说不清楚的.下面先介绍一下Python中成员变量的定义和使用. 我们知道,在Python中定义类成员和C/C++相比得到的结果具有很大的差别.如下面的定义: class Cclass { int I; void func(); }; Cclass c; 在上面的定义中,C++定义了一个类型,所有该类型的对象都包含有一个成员整数i和函数func:而Python则创建了一个名为Pcl

  • Python中反射和描述器总结

    反射 在Python中,能够通过一个对象,找出type.class.attribute或者method的能力,成为反射. 函数与方法 内建函数: getattr(object,name[,degault])  通过name返回object的属性值,当属性不存在,将使用default返回,如果没有default,则抛出AttributeError.Name必须为字符串. setattr(object,name,value)  object的属性存在,则覆盖,不存在,新增. hasattr(obje

  • Python 中的函数装饰器和闭包详解

    Python 中的函数装饰器和闭包详解

    函数装饰器可以被用于增强方法的某些行为,如果想自己实现装饰器,则必须了解闭包的概念. 装饰器的基本概念 装饰器是一个可调用对象,它的参数是另一个函数,称为被装饰函数.装饰器可以修改这个函数再将其返回,也可以将其替换为另一个函数或者可调用对象. 例如:有个名为 decorate 的装饰器: @decorate def target(): print('running target()') 上述代码的写法和以下写法的效果是一样的: def target(): print('running targe

  • Python 中闭包与装饰器案例详解

    Python 中闭包与装饰器案例详解

    项目github地址:bitcarmanlee easy-algorithm-interview-and-practice 1.Python中一切皆对象 这恐怕是学习Python最有用的一句话.想必你已经知道Python中的list, tuple, dict等内置数据结构,当你执行: alist = [1, 2, 3] 时,你就创建了一个列表对象,并且用alist这个变量引用它: 当然你也可以自己定义一个类: class House(object): def __init__(self, are

  • Python中属性和描述符的正确使用

    关于@property装饰器 在Python中我们使用@property装饰器来把对函数的调用伪装成对属性的访问. 那么为什么要这样做呢?因为@property让我们将自定义的代码同变量的访问/设定联系在了一起,同时为你的类保持一个简单的访问属性的接口. 举个栗子,假如我们有一个需要表示电影的类: class Movie(object): def __init__(self, title, description, score, ticket): self.title = title self.

  • 12步入门Python中的decorator装饰器使用方法

    装饰器(decorator)是一种高级Python语法.装饰器可以对一个函数.方法或者类进行加工.在Python中,我们有多种方法对函数和类进行加工,比如在Python闭包中,我们见到函数对象作为某一个函数的返回结果.相对于其它方式,装饰器语法简单,代码可读性高.因此,装饰器在Python项目中有广泛的应用. 装饰器最早在Python 2.5中出现,它最初被用于加工函数和方法这样的可调用对象(callable object,这样的对象定义有call方法).在Python 2.6以及之后的Pyth

随机推荐