如何在Python中通过描述符实现ORM字段映射

千浩姑娘_9563

千浩姑娘_9563

2026-10-16

200人浏览

原创

描述符通过__get__和__set__拦截访问,值必须存入实例__dict__(如instance.__dict__[self._attr_name])以避免共享;__set_name__是获取字段名的唯一可靠方式,用于orm映射;__get__须判instance is none返回自身,__set__需类型校验,且与__slots__冲突需规避。

如何在python中通过描述符实现orm字段映射

描述符的 __get__ 和 __set__ 怎么配合实例字典存取值

ORM 字段映射本质是把类定义里的声明(比如 name = StringField())和实例数据(比如 user.name = "Alice")桥接起来。描述符靠 __get__ 和 __set__ 拦截访问,但不能直接在描述符对象里存值——否则所有实例共享同一份数据。必须把值落到实例的 __dict__ 里。

常见错误是写成 self._value = value,结果多个实例互相覆盖。正确做法是用实例作为 key 存到描述符的私有字典中,或更稳妥地:直接操作 instance.__dict__。

  • 推荐用 instance.__dict__[self._attr_name] 存值,避免触发其他描述符或 property
  • _attr_name 需在描述符初始化时由上层传入(比如通过 __set_name__),不能硬编码
  • 读取时优先查 instance.__dict__,不存在再返回默认值(如 None 或字段定义的 default)

为什么必须实现 __set_name__ 才能知道字段名

Python 3.6+ 中,__set_name__ 是描述符自动获知自身绑定属性名的唯一可靠方式。没有它,你就无法生成数据库列名、校验提示字段、或构建查询条件——所有 ORM 行为都依赖这个名称上下文。

不实现 __set_name__ 的后果:你只能手动传字段名(如 name = StringField(db_column="user_name")),既冗余又易错;或者用 inspect 解析源码(不可靠,且不支持动态类生成)。

  • __set_name__(self, owner, name) 中的 name 就是类中写的变量名(如 "email")
  • 务必保存它(如 self.name = name),后续序列化、SQL 构建都靠它
  • 若兼容旧版本 Python,需 fallback 到手动传参,但现代项目应直接要求 3.6+

__get__ 返回值类型不一致会导致 ORM 查询失败

描述符的 __get__ 在访问类(User.name)和实例(u.name)时行为不同:类访问应返回描述符本身(用于元编程),实例访问才返回字段值。漏判 instance is None 会导致 User.name 拿到字符串而非 StringField 对象,ORM 的模型分析直接崩掉。

Forge — Python Developer
Forge — Python Developer

Python开发助手 — 自动化脚本、API封装、命令行工具、数据管道、网页爬虫。经过测试的代码,包含错误处理和文档。当你需要...

下载

另一个坑是类型污染:比如 IntegerField 的 __set__ 没做类型检查,允许存字符串,后续生成 SQL 时 WHERE id = '123' 可能被 DB 当字符串处理(尤其 SQLite)。

  • __get__ 开头必须写 if instance is None: return self
  • __set__ 中强制转换或抛异常(如 int(value) + ValueError)比静默转更安全
  • 对可空字段,None 是合法值,但得和“未赋值”区分开——后者应从 instance.__dict__ 里查不到键

描述符 + __slots__ 一起用会出问题

如果模型类用了 __slots__,instance.__dict__ 就不存在,而大多数描述符默认依赖它存值。这时 __set__ 会抛 AttributeError: 'User' object has no attribute '__dict__'。

这不是描述符写错了,而是设计冲突:ORM 描述符需要运行时动态挂字段值,__slots__ 却显式禁止新增属性。二者本质目标相反。

  • 要么放弃 __slots__(多数 ORM 如 SQLAlchemy/Django 都不启用)
  • 要么改用弱引用字典(weakref.WeakKeyDictionary)存值,但会增加 GC 压力
  • 或者在描述符中判断 hasattr(instance, '__dict__'),fallback 到其他存储策略(如线程局部存储——仅限单线程场景)

实际项目里,除非明确压内存且确认无并发问题,否则别在 ORM 模型上加 __slots__。那个省下的几 KB,往往换来调试半天的隐性 bug。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1731

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4444

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1709

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

26117

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3167

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3187

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1183

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2463

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习