Python类型注释:继承方法的返回类型

时间:2020-07-30 17:10:37

标签: python python-3.x inheritance typing mypy

我创建了一个类似于字典的自定义类,以简化跨大型数据集的评估指标的合并。此类实现__add__方法来汇总各种指标。

这是我正在处理的代码的简化版本:

from __future__ import annotations
from typing import TypeVar, Dict


T = TypeVar('T', int, float)


class AddableDict(Dict[str, T]):
    def __add__(self, other: AddableDict[T]) -> AddableDict[T]:
        if not isinstance(other, self.__class__):
            raise ValueError()
        new_dict = self.__class__()
        all_keys = set(list(self.keys()) + list(other.keys()))
        for key in all_keys:
            new_dict[key] = self.get(key, 0) + other.get(key, 0)
        return new_dict


# AddableIntDict = AddableDict[int]
# this would work just fine, however I need to add a few additional methods


class AddableIntDict(AddableDict[int]):
    def some_int_specific_method(self) -> None:
        pass


def main() -> None:
    x = AddableIntDict()
    y = AddableIntDict()
    x['a'] = 1
    y['a'] = 3

    x += y  # breaks mypy

程序的最后一行使用以下错误打破了mypy(0.782):

error: Incompatible types in assignment (expression has type "AddableDict[int]", variable has type "AddableIntDict")

这个错误对我来说很有意义。

正如我的评论中所述,当我将AddableIntDict定义为AddableDict[int]的类型别名时,代码可以正常工作,但是因为我需要根据字典值的类型添加其他方法,例如由some_int_specific_method表示,我不能简单地使用类型别名。

有人可以指出正确的方向来注释父类的__add__方法,以便它返回调用类的类型吗?

(我正在使用Python 3.8.3)

1 个答案:

答案 0 :(得分:2)

可以使用类型变量来引用“ self的类型”。这可以解析为在其上调用该方法的基类或子类的适当类型:

from typing import TypeVar, Dict


T = TypeVar('T', int, float)
AD = TypeVar('AD', bound='AddableDict')


class AddableDict(Dict[str, T]):
    def __add__(self: AD, other: AD) -> AD: ...


class AddableIntDict(AddableDict[int]):
    def some_int_specific_method(self) -> None: ...

x = AddableIntDict(a=1)
y = AddableIntDict(a=3)
x += y  # works for mypy and others