Python 的描述符到底是个啥?property 和 classmethod 底层都靠它,3 个例子讲透

61 阅读4分钟

结论先行:描述符(descriptor)不是什么高深魔法,它就是——一个定义了 __get__(可选 __set__/__delete__)方法的普通对象。Python 看到你"用实例去访问一个类属性"时,如果这个类属性是个描述符,就不会原样返回它,而是自动调用它的 __get__。你天天用的 property、classmethod、staticmethod,甚至"方法会自动绑定 self"这件事,底层全是描述符。


1. 先认识:啥样的对象算描述符

规则极简,一个类只要实现了下面三个方法的任意组合,它的实例就是描述符:

实现了什么叫什么典型用途
只有 __get__非数据描述符方法、classmethod、staticmethod
__get__ + __set__(或 __delete__)数据描述符property、带校验的属性
class Show:
    def __get__(self, instance, owner):
        return '描述符被触发了!'

class Demo:
    x = Show()          # 类属性是个描述符

d = Demo()
print(d.x)              # 描述符被触发了!——注意:不是返回 Show 实例

关键点:d.x 拿到的不再是 Show 实例本身,而是 __get__ 的返回值。访问被"拦截"了——这就是描述符的全部秘密。

2. 最震撼的例子:函数就是描述符

def hello(self):
    return f'hello {self.name}'

print(hasattr(hello, '__get__'))     # True!函数也有 __get__

为什么重要:这解释了一个初学者常问的问题——为什么 obj.method() 会自动传入 obj 当 self? 因为函数是非数据描述符:obj.method 访问时,函数的 __get__ 被调用,返回一个"绑定了 obj 的 bound method"。你不是在调用一个普通函数,你是在调用描述符协议制造出来的绑定方法。classmethod/staticmethod 只是内置的另外两种描述符,改的是 __get__ 的返回逻辑。

3. property 的底层:一个数据描述符

property 本质上就是个数据描述符类,可以徒手复刻:

class MyProperty:
    def __init__(self, fget):
        self.fget = fget
    def __get__(self, instance, owner):
        if instance is None:
            return self
        return self.fget(instance)

class Circle:
    def __init__(self, r):
        self._r = r
    @MyProperty
    def area(self):
        return 3.14 * self._r ** 2

print(Circle(2).area)    # 12.56

对照真 property:内置 property 无非是多带了 fset/fdel,实现了 __set__/__delete__。注意一个推论:**数据描述符优先级高于实例 dict**——这就是"为什么你没法用 c.area = 100覆盖一个 property"的原因(会进set` 被拦截或报错),而非数据描述符(普通方法)会被实例字典挡住(给实例绑一个同名方法就能"覆盖"类方法)。

4. 实战:写一个"类型强制检查"描述符

class Typed:
    def __init__(self, name, typ):
        self.name = name
        self.typ = typ
    def __get__(self, instance, owner):
        if instance is None:
            return self
        return instance.__dict__[self.name]
    def __set__(self, instance, value):
        if not isinstance(value, self.typ):
            raise TypeError(f'{self.name} 必须是 {self.typ.__name__},拿到 {type(value).__name__}')
        instance.__dict__[self.name] = value

class User:
    name = Typed('name', str)
    age = Typed('age', int)

u = User()
u.name = '张三'      # ok
u.age = '十八'       # TypeError: age 必须是 int,拿到 str

为什么好用:ORM 的字段校验、Django Model、dataclass 的类型约束,底层都是这个模式——描述符把"校验逻辑"从 __init__ 里搬到了类属性上,声明一行就行。

5. 描述符 vs property vs getattr(到底用谁)

维度描述符property__getattr__
触发时机访问类属性时访问类属性时正常查找失败后才调用
能拦截赋值能(__set__)能不能(要配 __setattr__)
性能快(C 层协议)快慢(异常路径)
适用复用校验/计算逻辑单个属性封装兜底代理、动态属性

对照结论:逻辑要在多个类/多个属性上复用 → 写描述符;只为一个属性服务 → 直接 property;想"查不到再编一个" → __getattr__。

6. 排错清单(收藏级)

  • 改了 property 却没生效? 检查是不是在实例 __dict__ 里塞了同名键——数据描述符优先级高于实例字典,但如果你写的是非数据描述符(只有 __get__),实例字典会挡住它。
  • __get__ 里 instance 是 None? 那是用类直接访问(Demo.x),记得判空返回自身或做别的处理。
  • 描述符里存状态存错了地方? 存在描述符实例自己身上 = 所有实例共享(经典 bug);必须存 instance.__dict__ 才是每个实例一份。
  • classmethod 为啥拿不到实例? 它也是描述符,__get__ 返回绑定到类的方法——协议不同,不是 bug。

下一篇:《Python 字典为什么查得快?3 个实验看懂哈希表底层》——关注不迷路。