Python中的类型提示（下）

会员服务 ·

Python中的类型提示（下）

2018 年 7 月 4 日 Python程序员

当你碰壁时

总而言之，要小心了，类型提示有时会产生奇怪的警告，这会让人产生不好的感觉，就如这篇推特所总结的一样：

记住，在你的手头就有一些工具可以帮助你发现、理解和处理这些边缘情况;

· 使用reveal_type来看推理的类型：

· 使用cast来强制一个给定的类型：

· 使用类型忽略标记来禁用行中的错误：

· 在论坛中提问；在python/typing的Gittter chat下提供一个可以暴露出问题的最简洁的可复现版本。

工具

这里有一份关于类型提示系统的不是很详尽的工具列表。

类型检查器

使用这些工具在你的库或者应用中检查类型是否正确：

1、mypy – Python（之前提到的类型linter工具）

2、pyre – Facebook –仅针对python3，但是比mypy的运行速度快。一个有趣的用例是使用这个工具来进行污染/安全代码的分析。参见Pieter Hooimeijer - Types, Deeper Static Analysis, and you.

3、pytype - Google.

类型标注生成器

当你想要对一个已存的代码库添加类型标注，使用这些来自动进行这个枯燥的部分：

1、mypy stubgen命令行

2、pyannotate – Dropbox –使用你的运行结果来生成类型信息。

3、monkeytype – Instagram。有趣的是，instagram实际上使用这个工具在自己的产品系统中运行：每一百万次调用就触发一次（这个工具使得代码运行速度变慢了5倍，但一百万次才触发一次就不那么明显了）。

运行态的代码鉴别器

使用这些工具来在运行时检测输入到你的函数或方法的参数的格式是否正确：

1、pydantic

2、enforce

3、pytypes

文档增强-合并文档字符串和类型提示

在这篇长文的第一部分，我们提到了以前人们就是将类型信息存储在文档字符串中。之所以这么做的原因是类型数据也是你工作的一部分，你确实希望将库的类型信息放入文档中去。那么问题来了，你没有选择使用文档字符串作为类型信息的主要存储系统，如何将这些信息保存在文档字符串中呢？

这个答案取决于你用来生成文档的工具。在这里我将展示一种可选的方法，使用的工具是在python中最流行的工具和格式：Sphinx和HTML。

在类型提示和文档字符串中都声明类型信息最终一定会导致二者的冲突。你可以想象的到一个人同一时刻只能在一个地方更新信息。因此，让我们从文档字符串中删除所有的类型数据，仅从类型提示中获取。现在我们需要做的是在创建文档是时从类型提示中获取类型信息并加入到文档中去。

在Sphinx中，你可以通过一个插件来实现这样的操作。目前最流行的版本是agronholm/sphinx-autodoc-typehints。这个工具可以做两件事：

· 首先，针对要记录的每个函数或变量，它获取类型提示信息；

· 然后，将这些信息用文档字符串表示（这涉及到递归地展开所以嵌套的类型类，并用相应的字符串表示进行替换）；

· 最后，将正确的参数附加进文档字符串中去。

举个例子，Any映射的类型是py:data:`~typing.Any`。对于组合类型来说会变得更加复杂，比如Mapping[str, bool]需要被翻译成形如:class:`~typing.Mapping`\[:class:`str`, :class:`bool`]的字符串。正确的翻译（例如类或者数据的名称）对于intersphinx插件能够正确的工作是至关重要的（一个能够将类型直接链接到他们各自的python标准库文档的插件）。

为了使用这个工具，我们需要通过pip install sphinx-autodoc-type>=2.1.1来安装，然后在conf.py文件中启用：