Python 描述符协议的工作原理详解

1次阅读

描述符对象未被当成普通属性调用,是因为它必须定义为类变量(如attr = mydescriptor())才生效;若误设为实例变量(如self.attr = mydescriptor()),则完全绕过描述符协议,导致obj.attr直接返回描述符对象而非触发__get__。

Python 描述符协议的工作原理详解

描述符对象为什么没被当成普通属性调用

当你在类中定义了 __get____set____delete__ 方法,它就变成了描述符——但只有这个对象被赋值给「类变量」时才生效。如果误写成实例变量(比如在 __init__ 里赋值),python 根本不会触发描述符协议。

常见错误现象:obj.attr 直接返回描述符对象本身,而不是调用 __get__;或者赋值后读取仍是旧值,像没走逻辑一样。

  • 必须写成 class A: attr = MyDescriptor(),不能是 self.attr = MyDescriptor()
  • 描述符只对类层级的属性有效,实例属性会绕过整个协议
  • 如果同时定义了 __get____set__,它叫数据描述符,优先级高于实例字典;只定义 __get__ 的是非数据描述符,实例同名属性会覆盖它

为什么 __get__ 的第一个参数有时是 None

这是 Python 访问类属性(而非实例属性)时的正常行为:__get__(self, instance, owner) 中,instanceNone 表示通过类访问,比如 A.attr;非 None 才是实例访问,如 a.attr

不处理这个分支,容易在类方法或装饰器场景下抛 AttributeError 或返回错误值。

立即学习Python免费学习笔记(深入)”;

  • 典型场景:实现缓存属性(@cached_Property 风格),类访问应返回描述符自身,实例访问才计算并缓存
  • 别直接对 instance 做属性操作,先判空:if instance is None: return self
  • 很多标准库描述符(如 property)都按这个逻辑分支处理

__set__ 被跳过?检查是否意外触发了非数据描述符降级

如果你写了 __set__ 却发现赋值没进这个方法,大概率是因为你只实现了 __get__,而没写 __set____delete__——这时它被当成了非数据描述符,实例字典里的同名键会直接屏蔽它。

错误现象:obj.x = 1 成功,但后续 obj.x 读出来是 1,不是你期望的描述符逻辑结果。

  • 只要想控制赋值行为,就必须实现 __set__(哪怕只是 raise AttributeError
  • 数据描述符(有 __set__)优先级永远高于实例 __dict__,这是协议硬规则
  • 注意:__set__ 里不要用 instance.__dict__[name] = value 来“保存”,那会和描述符初衷冲突;真要存,得用私有属性或弱引用字典

用描述符模拟 @property 时,为啥不能直接返回 self

因为 property 是数据描述符,每次访问都重新调用 __get__;而如果你在 __get__ 里缓存了结果并返回 self,就等于把描述符对象暴露出去,后续再调用它的方法可能出错,或导致状态污染。

更隐蔽的问题:多个实例共享同一个描述符对象,若内部缓存没隔离,会出现跨实例数据泄露。

  • 返回值应该是计算结果(如字段值、格式化字符串),不是描述符自己
  • 需要缓存时,用 instance.__dict__ 存(前提是确保该实例没被冻结或禁用 __dict__
  • 避免在描述符里维护可变状态;真要维护,用 weakref.WeakKeyDictionary 关联实例

描述符协议本身很薄,但一旦涉及实例状态管理、继承链查找、__slots__ 共存,边界情况就容易漏掉。最常被忽略的是:它只在属性访问语法(点号、getattr)下触发,__dict__ 直接读写、setattr(obj, 'x', v) 绕过描述符都不走协议。

text=ZqhQzanResources