使用 Mypy 输入 dict mixin class

Question

我正在尝试编写一个小的 mixin class 来在某种程度上桥接 Set 和 MutableMapping 类型：我希望映射类型能够接收一些对象（字节）、散列它们并存储它们，因此可以通过该哈希访问它们。

这是将 class 与标准 dict 混合的工作版本：

from hashlib import blake2b

class HashingMixin:
    def add(self, content):
        digest = blake2b(content).hexdigest()
        self[digest] = content

class HashingDict(dict, HashingMixin):
    pass

但是我不知道如何添加类型注释。

从 https://github.com/python/mypy/issues/1996 看来，mixin 必须子 class abc.ABC 和 abc.abstractmethod - 定义它期望调用的所有方法，所以这是我的镜头：

import abc
from hashlib import blake2b
from typing import Dict

class HashingMixin(abc.ABC):
    def add(self, content: bytes) -> None:
        digest = blake2b(content).hexdigest()
        self[digest] = content

    @abc.abstractmethod
    def __getitem__(self, key: str) -> bytes:
        raise NotImplementedError

    @abc.abstractmethod
    def __setitem__(self, key: str, content: bytes) -> None:
        raise NotImplementedError


class HashingDict(Dict[str, bytes], HashingMixin):
    pass

然后 Mypy 抱怨 HashingDict 定义：

error: Definition of "__getitem__" in base class "dict" is incompatible with definition in base class "HashingMixin"
error: Definition of "__setitem__" in base class "dict" is incompatible with definition in base class "HashingMixin"
error: Definition of "__setitem__" in base class "MutableMapping" is incompatible with definition in base class "HashingMixin"
error: Definition of "__getitem__" in base class "Mapping" is incompatible with definition in base class "HashingMixin"

显示类型：

reveal_type(HashingMixin.__getitem__)
reveal_type(HashingDict.__getitem__)

产量：

error: Revealed type is 'def (coup.content.HashingMixin, builtins.str) -> builtins.bytes'
error: Revealed type is 'def (builtins.dict[_KT`1, _VT`2], _KT`1) -> _VT`2'

我不知道怎么了:(

Answer 1

这似乎是 mypy 中的一个错误——请参阅代码中的 this TODO，mypy 使用多重继承来分析类的 MRO。简而言之，mypy 错误地完成了忽略您已使用具体值参数化 Dict 的操作，而是像使用 Dict.

一样分析代码

我相信 https://github.com/python/mypy/issues/5973 可能是问题跟踪器中最相关的问题：根本原因是一样的。

在修复该错误之前，您可以通过向任何有错误的行添加 # type: ignore 来抑制 mypy 在该行上生成的错误。因此，对于您的情况，您可以执行以下操作：

import abc
from hashlib import blake2b
from typing import Dict

class HashingMixin(abc.ABC):
    def add(self, content: bytes) -> None:
        digest = blake2b(content).hexdigest()
        self[digest] = content

    @abc.abstractmethod
    def __getitem__(self, key: str) -> bytes:
        raise NotImplementedError

    @abc.abstractmethod
    def __setitem__(self, key: str, content: bytes) -> None:
        raise NotImplementedError


class HashingDict(Dict[str, bytes], HashingMixin):  # type: ignore
    pass

如果您决定采用这种方法，我建议您还留下一条额外的评论，说明您为什么要抑制这些错误和运行带有 --warn-unused-ignores 标志的 mypy。

前者是为了以后阅读您的代码的读者受益；后者将使 mypy 在遇到 # type: ignore 时报告警告，该 # type: ignore 实际上并未抑制任何错误，因此可以安全地删除。

（当然，您始终可以尝试自己贡献修复！）

使用 Mypy 输入 dict mixin class

Typing dict mixin class with Mypy

python

dictionary

multiple-inheritance

mixins

mypy