0

0

Python typing.TYPE_CHECKING 的经典用法

冷炫風刃

冷炫風刃

发布时间:2026-02-14 17:50:15

|

796人浏览过

|

来源于php中文网

原创

必须用 typing.type_checking 解决循环类型引用问题,即在 if type_checking: 块中进行仅用于类型提示的导入,避免运行时 importerror,同时确保类型检查器能识别类型。

python typing.type_checking 的经典用法

什么时候必须用 typing.TYPE_CHECKING

循环类型引用(circular type reference)时,TYPE_CHECKING 是唯一安全的解法。比如模块 A 定义了类 User,又在类型注解里用到了模块 B 的 Profile;而模块 B 同样在注解里引用了 User——直接导入会报 ImportError 或运行时报错,但类型检查器(如 mypy)又需要知道这些类型。

这时不能靠“把 import 写在函数里”硬扛,因为函数内 import 只解决运行时,对类型检查无效;也不能用字符串字面量("Profile")一劳永逸,它在泛型、方法签名、协议匹配等场景下会失效。

  • 只在 if typing.TYPE_CHECKING: 块里做 from ... import ...,运行时不执行
  • 确保所有仅用于类型提示的导入都放进去,包括 from __future__ import annotations 无法覆盖的部分(如 ProtocolTypedDict 子类)
  • 别在 TYPE_CHECKING 块里写运行逻辑,mypy 不检查它,但其他工具(如 pyright)可能误报

TYPE_CHECKINGfrom __future__ import annotations 能否共存

能,而且推荐共存——但作用完全不同,混用时容易误判效果。

from __future__ import annotations 把所有类型注解转成字符串,延迟到真正需要时再解析(比如调用 get_type_hints()),它解决的是「注解执行时机」问题;而 TYPE_CHECKING 解决的是「导入要不要发生」问题。前者不阻止导入语句执行,后者直接跳过整段代码块。

立即学习Python免费学习笔记(深入)”;

html透明表单注册模板
html透明表单注册模板

html透明表单注册模板是网站常用的经典款登录注册表单模板。其ui设计精美扁平化,符合很多风格的网站使用。

下载
  • 加了 annotations 后,仍需 TYPE_CHECKING 来避免循环导入引发的 ImportError
  • 没加 annotations 时,TYPE_CHECKING 块里的类型名在运行时不可见,但 mypy 仍能识别——这是设计使然
  • 如果用了 annotations 还在 TYPE_CHECKING 外写 def func(x: User) -> Profile:,且 User 未定义,运行时就炸(NameError),和类型检查无关

常见错误:在 TYPE_CHECKING 里写了实际依赖的代码

最典型的翻车是把数据库模型、配置加载、日志初始化塞进 if TYPE_CHECKING: 块里,以为“反正不运行”,结果上线后发现服务起不来——因为这些代码根本没执行。

这个块只对类型检查器可见,CPython 解释器在运行时完全跳过它。所以任何有副作用、有依赖、要被调用的代码,都不能放这儿。

  • if TYPE_CHECKING: db = init_db() —— db 运行时是未定义的
  • if TYPE_CHECKING: from myapp.models import User + 后面直接用 User 当值(比如 user = User())——运行时报 NameError
  • ✅ 正确姿势:所有运行时需要的对象,必须在 TYPE_CHECKING 外定义或导入;类型注解中用到的,才放进去

mypy 和 pyright 对 TYPE_CHECKING 的处理差异

两者都支持,但行为细节不同,尤其在嵌套条件和未声明变量上。

mypy 更严格:如果 TYPE_CHECKING 块里定义了一个变量(比如 SomeType = Union[str, int]),它只在该块内有效,外面用会报错;pyright 则可能把它提升为模块级符号,导致意外通过检查但运行失败。

  • myPy 默认把 TYPE_CHECKING 当作纯类型上下文,不泄露名字;pyright 默认更宽松,可用 "python.analysis.typeCheckingMode": "basic" 收紧
  • 别在 TYPE_CHECKING 里定义别名并期望运行时可用——它只是给类型检查器看的临时符号
  • 跨文件使用时,确保所有涉及循环引用的模块都一致启用 TYPE_CHECKING,否则某个文件类型检查通过,另一个却报错

真正难的不是写对 if TYPE_CHECKING:,而是判断哪一行代码是“只给类型检查器看”的、哪一行是“运行时真得存在”的——这两个边界一旦模糊,调试成本会指数上升。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

810

2023.08.22

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

810

2023.08.22

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

531

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

214

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1552

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

640

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

885

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

836

2024.04.29

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

76

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号