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

Ter*_*ris 16 mypy

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

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

你有更好的建议吗?

Mic*_*x2a 14

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

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

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

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

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

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


tl;博士:

  • 您的类型可以进行一些小的调整(例如使用Sequence而不是Iterable
  • 由于开始时很难以类型安全的方式键入任意 JSON blob,因此有些人使用更简单的类型,例如Dict[str, Any],接受 JSON 本质上是动态的,并回退到使用运行时检查。
  • 如果我们可以期望我们的 JSON blob 以特定方式构建,我们可以使用TypedDicts(当然,结合其他类型)来表示它们。


mcg*_*uip 12

出现了长时间的讨论(https://github.com/python/typing/issues/182约引入的可能性)JSONType; 然而,尚未得出明确结论。

当前的建议是JSONType = t.Union[str, int, float, bool, None, t.Dict[str, t.Any], t.List[t.Any]]在您自己的代码中定义或类似的东西。


rra*_*nza 5

截至2022年11月,github上的讨论已经提出了递归定义:

所有主要类型检查器现在默认都支持递归类型别名,因此这应该在很大程度上起作用:

JSON: TypeAlias = dict[str, "JSON"] | list["JSON"] | str | int | float | bool | None 
Run Code Online (Sandbox Code Playgroud)

请注意,由于 dict 是不变的,因此您可能会遇到一些问题,例如 dict[str, str]。对于此类用例,您可以使用强制转换,如果您不需要可变性,则类似以下内容可能会起作用:

JSON_ro: TypeAlias = Mapping[str, "JSON_ro"] | Sequence["JSON_ro"] | str | int | float | bool | None
Run Code Online (Sandbox Code Playgroud)

看起来这至少需要 Python 3.11.0 和 MyPy 0.991

但请注意,目前 pydantic 对这种递归类型并不满意。