如何为含key和value属性的任意NamedTuple添加类型注解？

要处理这种「只要包含key和value字段就兼容」的场景，最靠谱的方案是使用Protocol——Python类型系统中专门用于定义结构类型的工具，它不依赖类型的名义（即类名），只看是否实现了指定的属性/方法。

具体实现步骤 #

1. 定义一个Protocol，声明所需的属性和类型
2. 用这个Protocol作为函数参数的类型注解

示例代码 #

from typing import NamedTuple, Protocol

# 定义Protocol，声明必须有str类型的key和value属性
class IdentifierProtocol(Protocol):
    key: str
    value: str

# 原有的NamedTuple定义不变
CompanyIdentifier = NamedTuple(
    "CompanyIdentifier",
    [
        ("key", str),
        ("value", str),
        ("some", str),
        ("other", str),
        ("field", str),
    ],
)

AnyIdentifier = NamedTuple(
    "AnyIdentifier",
    [
        ("key", str),
        ("value", str),
    ],
)

# 函数参数用Protocol注解
def func(identifier: IdentifierProtocol):
    print(identifier.key)
    print(identifier.value)

# 测试调用，现在不会报错
ci = CompanyIdentifier(key="K", value="V", some="S", other="O", field="F")
gi = AnyIdentifier(key="K", value="V")

func(gi)
func(ci)  # 类型检查器会认可这个调用

为什么这个方案有效？ #

你之前用AnyIdentifier这种NamedTuple作为类型注解时，类型检查器采用的是名义类型匹配——只有完全是AnyIdentifier类的实例才会被接受，哪怕其他NamedTuple包含了相同的字段也不行。

而Protocol采用的是结构类型匹配：只要某个类型拥有Protocol中声明的所有属性（且类型匹配），不管它是你定义的NamedTuple还是用户自定义的NamedTuple，甚至是普通类，类型检查器都会认为它和Protocol兼容。

兼容旧Python版本 #

如果你的代码需要支持Python 3.7及更早版本，需要先安装typing_extensions库，然后从typing_extensions导入Protocol：

pip install typing_extensions

from typing_extensions import Protocol

内容的提问来源于stack exchange，提问作者NewbiZ