返回专栏
专栏 ·

10.2 描述符(Descriptor)协议:揭秘 @property 和 ORM 字段映射的底层实现原理

作者: 九路 共 12 章 · 48 小节

欢迎回到 HelloWorld 技术社区(www.helloworld.net) 《Python 现代开发实战》专栏。

只要一个类实现了 __get__、__set__ 或 __delete__ 中的任意一个方法,它就是一个描述符(Descriptor)。当它被挂载为另一个类的类属性时,就能完全接管该属性的读取与赋值行为——@property、@classmethod 以及 Django/SQLAlchemy ORM 的字段类型校验全是基于描述符实现的。

class PositiveIntField:
    """可复用的正整数字段描述符(可用于任意业务模型)"""

    def __set_name__(self, owner: type, name: str) -> None:
        self.private_name = f"_{name}"

    def __get__(self, obj: object, objtype: type | None = None) -> int:
        if obj is None:
            return 0
        return getattr(obj, self.private_name, 0)

    def __set__(self, obj: object, value: int) -> None:
        if not isinstance(value, int) or value <= 0:
            raise ValueError(f"字段 {self.private_name[1:]} 必须是正整数,收到: {value}")
        setattr(obj, self.private_name, value)


class BountyTask:
    points = PositiveIntField()
    max_participants = PositiveIntField()

    def __init__(self, points: int, max_participants: int) -> None:
        self.points = points
        self.max_participants = max_participants

💬 HelloWorld 社区实战打卡

对比 @property 和自定义描述符:为什么当一个模型里有 10 个字段都需要同样的“非空字符串校验”时,描述符比写 10 遍 @property 优雅得多?带 #Python专栏打卡 留言!