mypy - 使用 mypy/PEP-526 定义一个 jsonable 类型

Question

可以通过 json.dumps 转换为 JSON 字符串的值是:
- 标量:数字和字符串
- 容器:映射和可迭代

Union[str, int, float, Mapping, Iterable]

你有更好的建议吗？

Answer 1

不幸的是，使用 PEP 484 类型正确键入 JSON blob 很尴尬。这部分是因为 mypy(目前)缺乏递归类型:这意味着我们能做的最好的事情就是使用类似于您构造的类型。

(但是，我们可以对您的类型进行一些改进。特别是， json.Dumps(...) 实际上不接受任意迭代。例如，生成器是 Iterable 的子类型，但 json.dumps(...) 将拒绝序列化生成器。你可能想使用类似 Sequence 的东西。)

另一个原因是，即使我们确实有递归类型，让函数返回联合通常最终会给调用者带来很多尴尬，他们经常需要诉诸断言或强制转换来获得他们期望的类型。 (同样，让函数接受联合作为参数也会使实现复杂化——尽管在许多情况下，复杂化是您无论如何都需要做的事情，而不是您编写的代码只是为了满足类型检查器)。

出于这个原因，很多人最终只使用 Dict[str, Any]表示一个 JSON 字典。它显然没有你的签名那么精确，但像那些简单的类型在实践中通常最终更符合人体工程学。

或者，如果你想使用更安全的类型，你可以尝试使用 TypedDicts反而。基本上，您构建一个类型，明确指定特定 JSON blob 的外观并使用它。这是更多的工作要做，但可以让您获得更多的类型安全。

也就是说，如果您可以预期您正在操作的 JSON blob 中的某些结构，则此路线通常是最好的。 (例如，如果您正在调用某个 API 并且您知道它将以特定格式返回一些 JSON)。如果您的程序需要处理真正任意的 JSON blob，恐怕您将不得不忍受一种或另一种形式的不精确/动态类型。

tl;博士:

您的类型需要一些小的调整(例如使用 Sequence 而不是 Iterable )

由于很难以类型安全的方式开始输入任意 JSON blob，因此有些人使用更简单的类型，例如 Dict[str, Any] ，接受 JSON 本质上是动态的，并回退到使用运行时检查。

如果我们可以期望我们的 JSON blob 以特定方式构建，我们可以使用 TypedDicts 来表示它们。 (当然，结合其他类型)。