如何为含Protocol字段的类定义协议并使用dataclass实现？

初始代码实现 #

我尝试编写如下代码：

import typing
import dataclasses

class ConfigProtocol(typing.Protocol):
    a: str

@dataclasses.dataclass
class Config:
    a: str

class HasConfigProtocol(typing.Protocol):
    config: ConfigProtocol


@dataclasses.dataclass
class HasConfig:
    config: Config

def accepts_hasconfig(h: HasConfigProtocol):
    pass

accepts_hasconfig(HasConfig(config=Config(a="")))

Pylance报错信息 #

但Pylance给出如下报错：

Argument of type "Position" cannot be assigned to parameter "template_position" of type "PositionProtocol" in function "init"
"Position" is incompatible with protocol "PositionProtocol"
"config" is invariant because it is mutable
"config" is an incompatible type
"Configuration" is incompatible with protocol "ConfigurationProtocol"

疑问：是否需要冻结数据类并使用只读协议？ #

我是否需要通过冻结dataclass并在协议中定义只读属性（如下代码）来解决这个问题？

class ConfigProtocol(typing.Protocol):
    @property
    def a(self) -> str:
        ...

@dataclasses.dataclass(frozen=True)
class Config:
    a: str

class HasConfigProtocol(typing.Protocol):
    @property
    def config(self) -> ConfigProtocol:
        ...


@dataclasses.dataclass(frozen=True)
class HasConfig:
    config: Config

def accepts_hasconfig(h: HasConfigProtocol):
    pass

accepts_hasconfig(HasConfig(config=Config(a="")))

跨模块复用的后续疑问 #

从长期来看，上述代码位于独立模块module_a中，另有独立模块module_b存在类似实现。我希望在module_b中使用module_a的HasConfig实例。由于模块间互不依赖，我原本在两个模块中都定义了相同的协议。

请问：若要实现跨模块复用协议并让实例在两个模块中都能被类型检查认可，是否必须保证协议定义完全一致且只能通过@property定义只读属性？

回答 #

1. 关于初始报错的解决
   是的，你需要通过冻结dataclass并在协议中使用只读属性的方式解决类型不兼容问题，原因如下：

• 当协议定义可变属性（如a: str）时，类型检查器会将其视为不变类型（同时要求协变和逆变）。此时Config类的a属性虽为字符串类型，但因可变，检查器无法确认它完全符合ConfigProtocol的契约（外部代码可能修改a的类型）。
• 用@property定义只读协议后，协议仅要求存在只读的a属性；冻结的dataclass保证a无法被修改，此时检查器会将其视为协变类型，Config类就能兼容ConfigProtocol。同理，HasConfig的config属性作为只读协议时，也能兼容HasConfigProtocol。

2. 关于跨模块协议复用
   要让跨模块的协议互相兼容，必须满足两个核心条件：

• 协议定义完全一致：包括属性名称、类型注解、是否为只读属性等所有细节必须100%匹配。类型检查器会将不同模块中看似相同的协议视为不同类型，哪怕只有细微差异（比如一个用@property一个不用）。
• 优先复用同一协议定义：最佳实践是把协议抽离到公共模块（如common_protocols），让module_a和module_b都从该模块导入协议，而非各自重复定义。若确实无法让模块依赖公共模块，必须手动确保两个模块的协议定义完全一致，且都使用@property的只读形式（可变属性的不变性会导致跨模块类型不兼容）。

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