Python 派生自抽象基础 class 的 class 实例的类型注释

Question

假设已经创建了一个抽象基classMembershipClass。多个 class 派生自抽象基础 class，例如 FirstClass、SecondClass 等

我希望在函数中使用类型注释，该函数接受从 MembershipClass 派生的任何 class 作为参数。如果有少量派生的 classes（比如 2），这应该有效：

from typing import Union
def MyFunc(membership_obj: Union[FirstClass, SecondClass]) -> None:
   ...

有没有办法为 membership_obj 创建一个类型提示，它本质上说它的类型是从 MembershipClass 派生的任何 class 而不必指定每个可能的派生 class 在类型注释中？

我看到了两种可能的解决方案：

:

from typing import TypeVar
BaseType = TypeVar('BaseType', bound=MembershipClass)
def MyFunc(membership_obj: BaseType) -> None:
   ...

def MyFunc(membership_obj: MembershipClass) -> None:
   ...

两种方法都可以接受吗？

Answer 1

看起来这两种解决方案都可以，尽管 mypy 消息略有不同。考虑以下示例（我已经内联添加了 mypy 错误）：

from abc import ABC
from typing import TypeVar


class Base(ABC):
    pass


class Sub(Base):
    pass


BaseType = TypeVar("BaseType", bound=Base)


def MyFunc(c: Base) -> None:
    pass


def MyFunc2(c: BaseType) -> None:
    pass


if __name__ == "__main__":
    b = Base()
    s = Sub()

    MyFunc(b)
    MyFunc(s)
    MyFunc(3)  # main.py:30: error: Argument 1 to "MyFunc" has incompatible type "int"; expected "Base"

    MyFunc2(b)
    MyFunc2(s)
    MyFunc2(3) # main.py:34: error: Value of type variable "BaseType" of "MyFunc2" cannot be "int"

话虽如此，我认为第二种方法更具可读性和直观性。我认为 TypeVar 更适合 generics（这并不是说如果你愿意就不要使用它）。

Python 派生自抽象基础 class 的 class 实例的类型注释

Python type annotations for instance of class derived from abstract base class

python

abstract-base-class

python-typing