如何更好的使用 Python 的类型提示?

使用动态语言一时爽，代码重构火葬场。相信你一定听过这句话，和单元测试一样，虽然写代码的时候花费你少量的时间，但是从长远来看，这是非常值得的。本文分享如何更好的理解和使用 Python 的类型提示。,类型提示（自 PEP 3107 开始引入）用于向变量、参数、函数参数以及它们的返回值、类属性和方法添加类型。,Python 的变量类型是动态的，可以在运行时修改，为代码添加类型提示，仅在语法层面支持，对代码的运行没有任何影响，Python 解释器在运行代码的时候会忽略类型提示。,因此类型提示一个直观的作用就是提升代码的可读性，方便调用者传入/传出恰当类型的参数，便于代码重构。,Python 内置的基本类型可以直接用于类型提示：,变量的类型提示示例：,函数的类型提示：,这里的 type_x , type_y , type_z , type_return 可以是内置的基本类型，也可以是自定义类型。,类的类型提示：,假如有这样一段代码：,用 Python 解释器执行是不会有任何错误的：,,借助于 mypy 就可以，先 pip install mypy 安装一下，然后 mypy script.py 即可：,,更多 mypy 相关可以参考前文mypy 这个工具，让Python的类型提示变得非常实用。,如果解释器没有强制执行类型提示，为什么还要编写类型提示呢？确实，类型提示不会改变代码的运行方式：Python 本质上是动态类型的，这一点不太可能会改变。但是，从开发人员经验的角度来看，类型提示有很多好处。,（1）、使用类型提示，尤其是在函数中，通过类型提示来明确参数类型和所产生结果的类型，非常便于阅读和理解。,（2）、类型提示消除了认知开销，并使代码更易于阅读和调试。考虑到输入和输出的类型，你可以轻松推断对象以及它们如何调用。,（3）、类型提示可改善代码编辑体验。IDE 可以依靠类型检测来静态分析你的代码并帮助检测潜在的错误（例如，传递错误类型的参数、调用错误的方法等）。另外，还可以根据类型提示为每个变量提供自动补全。,,IDE 的类型检查,,IDE 的类型检查,,IDE 类型检查后的自动补全,假如你需要列表 list 内部是 float 的类型提示，这样做是不行的：,标准库 typing 考虑到了这个问题，你可以这样：,假如要提示这样的类型：,借助于 Dict，你可以这样定义类型：,假如你需要提示这样的类型，那该怎么办？,借助于 TypedDict ，你可以这样：,,TypedDict,从 Python 3.10 开始，Union 被替换为 | 这意味着 Union[X, Y] 现在等价于 X | Y。,Union[X, Y]（或 X | Y）表示 X 或 Y。,假设你的函数需要从缓存目录中读取文件并加载 Torch 模型。此缓存目录位置可以是字符串值（例如 /home/cache ），也可以是 Pathlib 库的 Path 对象，在这种情况下，代码如下：,当你需要传入一个函数作为参数的时候，这个参数的类型提示可以为 Callable。,你还可以给这样的函数参数指定参数列表，真的很强大：,语法：,示例：,当你传入的参数可以为任何类型的时候，就可以使用 Any,如果你的函数使用可选参数，具有默认值，那么你可以使用类型模块中的 Optional 类型。,Sequence 类型的对象是可以被索引的任何东西：列表、元组、字符串、对象列表、元组列表的元组等。,Tuple 类型的工作方式与 List 类型略有不同，Tuple 需要指定每一个位置的类型：,如果你不关心元组中每个元素的类型，你可以继续使用内置类型 tuple。,类型提示在代码之上带来了额外的抽象层：它们有助于记录代码，澄清关于输入/输出的假设，并防止在顶部执行静态代码分析 (mypy) 时出现的隐蔽和错误。