如何在Python中使用描述符Descriptor实现类型校验

小辰大大_2100

小辰大大_2100

2026-10-07

847人浏览

原创

__set__ 是类型校验的核心入口,必须在赋值时拦截并校验;需用 __set_name__ 绑定属性名以支持复用;不兼容 __slots__ 类时应改用 weakkeydictionary;复合校验应拆分为独立描述符以保持单一职责。

如何在python中使用描述符descriptor实现类型校验

描述符的 __set__ 方法是类型校验的核心入口

类型校验必须发生在赋值时,而描述符正是通过拦截 __set__ 来实现这一点的。它不像属性装饰器(如 @property)只控制单个属性,而是可复用、可组合的通用机制。

关键点在于:__set__ 接收三个参数:self(描述符实例)、instance(宿主对象)、value(待赋的值)。校验逻辑就写在这里,不通过就直接抛出 TypeError。

常见错误是把校验逻辑放在 __init__ 或 __get__ 里——前者只在描述符创建时运行一次,后者在读取时才触发,完全无法阻止非法赋值。

示例:

class Typed:
    def __init__(self, expected_type):
        self.expected_type = expected_type

    def __set__(self, instance, value):
        if not isinstance(value, self.expected_type):
            raise TypeError(f"Expected {self.expected_type.__name__}, got {type(value).__name__}")
        instance.__dict__[self.name] = value

    def __set_name__(self, owner, name):
        self.name = name

必须用 __set_name__ 绑定属性名,否则无法存取实例数据

描述符本身是类级别的对象,多个实例共享同一个描述符对象。如果不记录宿主类中该属性的真实名称,就无法在 __set__ 和 __get__ 中正确操作对应实例的属性值。

手动硬编码属性名(比如写死 instance._age)会破坏复用性;用 __dict__ 存到实例上又必须知道键名——这个键名只能由 __set_name__ 提供。

容易被忽略的是:Python 3.6+ 才支持 __set_name__,旧版本需退化为在宿主类中显式传入名称(例如 age = Typed(int, "age")),但那样易错且冗余。

使用场景:所有需要将描述符绑定到具体字段名的地方,包括自定义验证、懒加载、缓存代理等。

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载

描述符不能直接用于 __slots__ 类,除非改用 __set__ 写入类变量或外部映射

如果宿主类定义了 __slots__,实例就没有 __dict__,而上面示例中 instance.__dict__[self.name] = value 就会报 AttributeError。

解决方式有两种:

  • 改用 setattr(instance, self.name, value) ——但前提是 self.name 在 __slots__ 中已声明,否则仍失败
  • 用弱引用字典(weakref.WeakKeyDictionary)在描述符内部维护值映射,绕过实例存储限制

性能影响:弱引用字典方案多一层哈希查找,但避免了动态属性开销;对高频访问字段需实测权衡。兼容性上,它能同时适配有无 __slots__ 的类。

复合校验(如非空 + 类型)应封装成独立描述符,而非在 __set__ 里堆逻辑

一个描述符只做一件事。把“必须是字符串”和“不能为空”塞进同一个 __set__,会导致复用困难、测试膨胀、错误信息模糊。

更合理的方式是组合:

  • String 描述符负责类型
  • NotNull 描述符负责空值检查(可配合 __set__ 前置调用)
  • 或者用装饰器风格的工厂函数:NonEmpty(String())

参数差异明显:String 关注 expected_type,NonEmpty 关注 allow_empty 或 strip 行为。混在一起会让构造签名混乱,比如 Typed(str, non_empty=True, strip=True) 已经偏离“类型校验”本意。

真正复杂的业务规则(如邮箱格式、范围限制)建议另起专用描述符,不要试图让 Typed 变成万能校验器。

描述符的威力在于解耦,不是把所有校验逻辑都塞进一个类里。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1671

4

python能做什么
python能做什么

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

2023.07.25

4164

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24057

23

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

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

2023.08.04

2947

5

python eval
python eval

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

2023.08.04

2967

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2303

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程