本文介绍如何利用 Python 描述符协议中的 __set_name__ 方法，在类属性赋值时自动捕获变量名（如 name、zodiac），从而避免硬编码或解析源码等不可靠方式，实现 ORM 风格的字段声明。
本文介绍如何利用 python 描述符协议中的 `__set_name__` 方法，在类属性赋值时自动捕获变量名（如 `name`、`zodiac`），从而避免硬编码或解析源码等不可靠方式，实现 orm 风格的字段声明。
在构建 ORM、数据验证框架或声明式模型（如 Django Models、SQLAlchemy 或 Pydantic v2 的字段系统）时，一个常见需求是：当用户以 field_name = CharField() 形式在类中定义字段时，CharField 实例需自动获知自己被赋值给哪个属性名。这看似“魔法”，实则基于 Python 的描述符协议——尤其是 __set_name__ 钩子。
Python 在类体执行完毕、属性被绑定到类对象时，会自动调用描述符的 __set_name__(self, owner, name) 方法，其中 name 即为该描述符在所属类中声明的属性名。这是官方支持、稳定可靠、无需 AST 解析或栈帧分析的标准机制。
以下是一个完整可运行的示例：
class CharField:
def __set_name__(self, owner, name):
self.field_name = name
self.private_name = '_' + name # 避免与描述符自身冲突
def __get__(self, obj, objtype=None):
if obj is None:
return self
value = getattr(obj, self.private_name, None)
print(f'Accessing field {self.field_name!r} → {value!r}')
return value
def __set__(self, obj, value):
print(f'Setting field {self.field_name!r} to {value!r}')
setattr(obj, self.private_name, value)
class Person:
name = CharField()
zodiac = CharField()
# 使用示例
p = Person()
p.name = "Alice" # 输出：Setting field 'name' to 'Alice'
p.zodiac = "Libra" # 输出：Setting field 'zodiac' to 'Libra'
print(p.name) # 输出：Accessing field 'name' → 'Alice' \n Alice
✅ 关键要点说明：
- __set_name__ 仅在类定义完成、描述符被赋值给类属性时调用一次，不会在实例化时触发；
- owner 是拥有该描述符的类（如 Person），name 是字符串形式的属性名（如 "name"）；
- 必须同时实现 __get__ 和 __set__（或至少其中之一）才能构成有效描述符；若仅需存储元信息，__get__ 可返回 self（用于类级访问）；
- 使用 private_name（如 _name）隔离底层存储，防止描述符实例属性与用户访问的属性名冲突；
- 此机制完全兼容继承：子类中重定义同名字段会触发其自身的 __set_name__，父类字段不受影响。
⚠️ 注意事项：
- 描述符必须定义在类层级（即作为类属性），不能在 __init__ 或函数内动态创建，否则 __set_name__ 不会被调用；
- 若字段需支持默认值、类型校验或数据库映射，可在 __set_name__ 中初始化元数据，并在 __set__/__get__ 中扩展逻辑；
- 不要尝试通过 inspect.stack() 解析赋值语句——它依赖源码存在、受优化影响、不可靠且性能差，而 __set_name__ 是语言层面保证的稳定接口。
这一模式正是 SQLAlchemy、Django ORM 等成熟框架实现“声明即配置”的核心基础。掌握描述符，你就能构建出简洁、健壮、符合 Python 惯例的领域建模工具。
Python免费学习笔记（深入）：立即使用
在学习笔记中，你将探索 Python 的核心概念和高级技巧！
