如果变量通过某些测试，则断言变量具有某些属性

Question

使用 python 类型系统，我有时知道变量或表达式的类型，因为我安装了运行时检查来验证它。有没有办法用注释来表示？

例如，假设我有一个函数combop，如果它的参数属于Combination 类，它会返回True。进一步假设Combination 类有一个名为tds 的字段。

if combop(x):
   return f(x.tds)
else:
   return f([])

在这个例子中，我想向检查器保证，在 if 的 then 部分中，x 的类型为 Combination，而x.tds 是有意义的。

这种情况的一个例子是here python-rte 的第 172 行。 IDE 抱怨d.tds 和n.s。我假设有一种方法可以通过类型注释来解释我的意图，并且 IDE 会在可能的情况下接受或验证我的声明。

在某些函数式语言（例如 Scala）中完成此操作的方式是使用模式匹配。在模式匹配的子句中，类型推断器能够限制某些变量的类型。在其他一些语言（例如 Common Lisp）中，有一个 declare 语法允许程序员向类型推断器提供提示，这可能会或可能不会产生运行时开销，具体取决于编译器设置。

Answer 1

Python 3.10 将引入新的TypeGuard 功能，可能为您提供所需的功能。 （该功能也可以通过 Python typing_extensions 模块获得。）TypeGuard 允许您向类型检查器断言对象属于某种类型。所以，你可以写一个这样的函数：

from typing import TypeGuard, Any

def combop(obj: Any) -> TypeGuard[Combination]:
    # Some code that returns `True` if the object is of type `Combination`, else `False`.

如果您对对象的 属性（“结构类型”而不是对象的“名义类型”）更感兴趣，那么您可以使用 TypeGuard 来断言你的对象符合某个protocol。

from typing import Protocol, TypeGuard, Any

class CombinationsProto(Protocol):
    tds: list[Any]


def combops(obj: Any) -> TypeGuard[CombinationsProto]:
    # Some code here that returns `True` if the object has a `tds` attribute, else `False`.

由于这是 python 类型世界中的一项新功能，Python 的主要类型检查器仍在努力支持此功能，特别是对于一些复杂的 corner cases。

Answer 2

import typing


class Foo:
    def __init__(self) -> None:
        self.bar = "zebra"  # will be of 'str' type


def give_me_something():  # no annotation here, can't tell what gets returned
    if dict():  # an empty dict is always False, this is just an example, a real condition could be used
        return []
    else:
        return Foo()


reveal_type(give_me_something())
reveal_type(typing.cast(Foo, give_me_something()))

$ mypy so69205255.py
so69205255.py:16: note: Revealed type is "Any"
so69205255.py:17: note: Revealed type is "so69205255.Foo"

我使用 MyPy 进行可重复检查，但我的 IDE PyCharm 也能理解：当我悬停分配表达式的变量名时，它说第一个是 Union[list, Foo] 类型，而第二个是 @987654326 类型@。

更多信息：见the docs