如何注释多个返回值的类型？

Question

如何使用类型提示来注释一个返回 Iterable 的函数，该函数总是产生两个值：bool 和 str？提示 Tuple[bool, str] 很接近，除了它将返回值类型限制为元组，而不是生成器或其他类型的可迭代对象。

我很好奇，因为我想注释一个用于返回多个值的函数foo()，如下所示：

always_a_bool, always_a_str = foo()

通常像 foo() 这样的函数会执行类似 return a, b 的操作（它返回一个元组），但我希望类型提示足够灵活，可以用生成器或列表或其他东西替换返回的元组。

Answer 1

你总是返回一个对象；使用 return one, two 只返回一个元组。

所以是的，-> Tuple[bool, str] 完全正确。

仅Tuple 类型允许您指定固定数量的元素，每个元素都有不同的类型。如果你的函数产生固定个返回值，你真的应该返回一个元组，尤其是当这些值是特定的、不同的类型时。

其他序列类型预计会有 one 类型规范用于可变数量的元素，因此typing.Sequence 不适合这里。另见What's the difference between lists and tuples?

元组是异构数据结构（即它们的条目具有不同的含义），而列表是同构序列。 元组有结构，列表有顺序。

Python 的类型提示系统遵循这一理念，目前没有语法来指定固定长度的迭代并在特定位置包含特定类型。

如果您必须指定任何可迭代对象都可以，那么您可以做的最好的事情是：

-> Iterable[Union[bool, str]]

此时调用者可以期待布尔值和字符串以任意顺序，并且长度未知（0 到无穷大之间的任意位置）。

最后但同样重要的是，从 Python 3.9 开始，您可以使用

-> tuple[bool, str]

而不是-> Tuple[bool, str]；支持类型提示符号has been added to most standard-library container types（完整列表参见PEP 585）。事实上，你也可以从 Python 3.7 开始使用它，前提是你为你的模块使用 from __future__ import annotations 编译器开关和支持语法的类型检查器。