如何在使用 attrs 时兼顾 mypy 类型检查与多类型校验

陌明君_9034

陌明君_9034

2026-08-15

142人浏览

原创

如何在使用 attrs 时兼顾 mypy 类型检查与多类型校验

本文介绍在 attrs 中为联合类型(如 int | str)定义字段时,如何绕过 mypy 对 attrs.validators.or_() 的类型推断失败问题,推荐使用 instance_of((str, int)) 实现简洁、安全且兼容静态类型的校验方案。

本文介绍在 attrs 中为联合类型(如 `int | str`)定义字段时,如何绕过 mypy 对 `attrs.validators.or_()` 的类型推断失败问题,推荐使用 `instance_of((str, int))` 实现简洁、安全且兼容静态类型的校验方案。

在使用 attrs 构建数据类时,若需对某个字段支持多种类型(例如 int | str),直觉上会选用 attrs.validators.or_() 组合多个 instance_of 校验器。然而,当前版本的 mypy(尤其是 1.10+)无法为 or_[T] 正确推断泛型参数,导致报错:

error: Cannot infer type argument 1 of "or_"  [misc]

尽管该代码运行时完全正常,但破坏了类型检查的完整性,不利于团队协作和 CI 流程中的静态分析。

✅ 推荐解决方案:使用元组形式的 instance_of

attrs.validators.instance_of 支持传入类型元组(如 (str, int)),语义等价于“是其中任一类型”,且 mypy 能准确识别其类型契约:

import attrs

@attrs.define
class C:
    val: int | str = attrs.field(
        validator=attrs.validators.instance_of((str, int))
    )

该写法:

  • ✅ 完全通过 mypy 检查(无 misc 或 arg-type 报错);
  • ✅ 运行时行为与 or_(instance_of(int), instance_of(str)) 一致;
  • ✅ 更简洁,减少嵌套,提升可读性;
  • ✅ 兼容 Python 3.10+ 的联合类型语法(int | str)及旧式 Union[int, str]。

⚠️ 注意事项:

  • 不要误写为 instance_of([str, int])(列表),必须使用元组 (...),否则会触发运行时 TypeError;
  • 若需更复杂的逻辑(如自定义错误消息、条件校验或组合其他验证器),仍可保留 or_,但需显式添加类型注解(较繁琐,不推荐):
    from typing import TYPE_CHECKING
    if TYPE_CHECKING:
        from attrs.validators import _OrValidator
        # 需手动构造类型,维护成本高,非必要不采用

? 总结:对于“字段接受多个具体类型”的常见场景,优先使用 instance_of((TypeA, TypeB)) 替代 or_(instance_of(TypeA), instance_of(TypeB)) —— 它是 mypy 友好、语义清晰、零运行时开销的最佳实践。

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1671

4

python能做什么
python能做什么

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

2023.07.25

4204

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24337

23

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

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

2023.08.04

2987

5

python eval
python eval

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

2023.08.04

3007

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2323

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习