子类NamedTuple的一种类型检查方法

小编典典

子类NamedTuple的一种类型检查方法

python

我有几个共享一些字段的namedtuple。我有一个接受这些元组的函数，并保证仅与共享字段进行交互。我想在mypy中对此类代码进行类型检查。

该代码的示例为：

from typing import NamedTuple

class Base(NamedTuple):
    x: int
    y: int


class BaseExtended(NamedTuple):
    x: int
    y: int
    z: str

def DoSomething(tuple: Base):
    return tuple.x + tuple.y

base = Base(3, 4)
base_extended = BaseExtended(5, 6, 'foo')

DoSomething(base)
DoSomething(base_extended)

当我在此代码上运行mypy时，我得到一个可预测的错误：

mypy_example.py:20：错误：“ DoSomething”的参数1具有不兼容的类型“ BaseExtended”；预期的“基础”

有没有办法构造我的代码并保持mypy类型检查？我无法从Base继承BaseExtended，因为NamedTuple继承实现中存在一个错误：

https://github.com/python/typing/issues/427

我也不想使用难看的“ Union [Base，BaseExtended]”，因为当我尝试对列表进行类型检查时这会中断，因为“ List [Union
[Base，BaseExtended]]”不等于“ List [BaseExtended] ]”，这是因为有关变体/协变类型的一些令人迷惑的魔术：

https://github.com/python/mypy/issues/3351

我应该放弃这个主意吗？

阅读 220

2020-12-20

共1个答案

小编典典

命名元组的构造方式typing.NamedTuple尚无法从类继承。您必须编写自己的元类来扩展typing.NamedTupleMeta该类，以使子类能够工作，即使如此，by生成的类collections.namedtuple()也不能构建为extend

相反，您想使用新dataclasses模块定义类并实现继承：

from dataclasses import dataclass

@dataclass(frozen=True)
class Base:
    x: int
    y: int

@dataclass(frozen=True)
class BaseExtended(Base):
    z: str

该模块是Python 3.7中的新增功能，但您可以在Python 3.6上pip install dataclasses向后移植。

上面定义了两个具有x和y属性的不可变类，BaseExtended该类又添加了一个属性。BaseExtended是的完整子类Base，因此出于键入目的，适合该DoSomething()功能的要求。

这些类不是全名的元组，因为它们没有长度或不支持索引，但是通过创建继承自的基类collections.abc.Sequence并添加两个方法来按索引访问字段，可以轻松添加这些类。如果添加order=True到@dataclass()装饰器中，则您的实例将变得完全可订购，其元组的命名方式如下：

from collections.abc import Sequence
from dataclasses import dataclass, fields

class DataclassSequence(Sequence):
    # make a dataclass tuple-like by accessing fields by index
    def __getitem__(self, i):
        return getattr(self, fields(self)[i].name)
    def __len__(self):
        return len(fields(self))

@dataclass(frozen=True, order=True)
class Base(DataclassSequence):
    x: int
    y: int

MyPy将很快dataclasses明确支持；在版本0.600中，您仍然会遇到错误，因为它无法识别dataclasses模块导入或__new__生成了方法。

在Python
3.6和更低版本中，您还可以安装attrs项目以实现相同的效果。上面的序列基类如下所示attrs：

from collections.abc import Sequence
import attr

class AttrsSequence(Sequence):
    # make a dataclass tuple-like by accessing fields by index
    def __getitem__(self, i):
        return getattr(self, attr.fields(type(self))[i].name)
    def __len__(self):
        return len(attr.fields(type(self)))

@attr.s(frozen=True, auto_attribs=True)
class Base(AttrsSequence):
    x: int
    y: int

dataclasses直接基于attrs，并attrs提供更多功能；mypy完全支持使用生成的类attrs。

2020-12-20