如何使用Python的typing模块对类进行类型标注?

冬静吖_8091

冬静吖_8091

2026-08-06

430人浏览

原创

类属性和方法参数必须显式标注类型,否则类型检查器(如mypy)将其视为any;实例属性需在类体顶部声明或在__init__中用self.name: str = name标注;__init__不应有返回类型注解,而__new__必须标注为-> self;泛型类需实际使用类型变量,如items: list[t],且实例化时应指定具体类型如stack[int]()。

如何使用python的typing模块对类进行类型标注?

类属性和方法参数必须显式标注,否则类型检查器会忽略

Python 的 typing 模块不会自动推断类中变量或方法的类型。哪怕你写了 def __init__(self, name): self.name = name,name 仍被视为 Any。类型检查器(如 mypy)只信任显式标注。

实操建议:

  • 所有实例属性在 __init__ 中赋值前,需在类体顶部用 name: str 这类语句声明(PEP 526 风格),或在 __init__ 中用 self.name: str = name
  • 方法参数、返回值必须标注,包括 self(它应标为 Self 或当前类名,而非 Any)
  • 避免只给参数标注而漏掉返回值——def get_id(self) -> int: 比 def get_id(self): 更可靠

使用 Self 替代硬编码类名,避免继承时类型失效

写 def clone(self) -> User: 看似合理,但子类调用时返回类型仍是 User,不是子类本身。这会导致类型检查误报或丢失多态性。

正确做法是导入并使用 Self(Python 3.11+)或 from typing import TypeVar; Self = TypeVar('Self', bound='User')(旧版本):

from typing import Self

class User:
    def __init__(self, name: str) -> None:
        self.name: str = name

    def clone(self) -> Self:
        new = self.__class__.__new__(self.__class__)
        new.name = self.name
        return new

这样 Admin().clone() 的返回类型就是 Admin,不是 User。

A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.
A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.

调用 Cutout.Pro 视觉处理 API 进行背景移除、人像抠图和照片增强,支持文件上传与图片 URL 输入。

下载

__init__ 不应有返回类型注解,但 __new__ 必须标注

__init__ 的作用是初始化已创建的对象,它总是返回 None,即使你写了 -> None 也属冗余;而 __new__ 负责构造实例,必须标注返回类型,否则类型检查器无法确认返回对象是否属于当前类。

常见错误现象:

  • 给 __init__ 加 -> User:mypy 会警告“__init__ should return None”
  • 漏标 __new__:类型检查器可能将返回值视为 Any,后续调用方法时报错
  • 标注 __new__ 时用了 -> object:应写 -> Self 或 -> 'ClassName'

泛型类需用 Generic[T] 声明,且 T 必须在类定义中实际使用

仅写 class Stack(Generic[T]): 不够,如果类里没出现 T(比如没声明 items: list[T]),mypy 会报错“Generic[T] used without parameters”。

实操要点:

  • 泛型参数必须出现在类属性、方法签名或父类继承列表中(如 class ConfigurableDict(dict[str, T]):)
  • 若需多个泛型参数,用逗号分隔:class Pair(Generic[K, V]):
  • 避免在类内部用 typing.Any 替代泛型——它会绕过类型约束,失去泛型意义

泛型类的真正难点不在写法,而在实例化时是否传入具体类型参数。不写 Stack[int]() 而直接用 Stack(),很多检查器会退化为宽松模式,容易掩盖问题。

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

相关专题

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

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

2023.07.20

1571

4

python能做什么
python能做什么

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

2023.07.25

3764

7

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

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

2023.07.31

1589

3

python教程
python教程

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

2023.08.03

21557

23

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

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

2023.08.04

2667

5

python eval
python eval

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

2023.08.04

2707

5

scratch和python区别
scratch和python区别

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

2023.08.11

1103

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2103

5

热门下载

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

精品课程

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