如何在Protocol类中处理Optional[int]及解决类型兼容问题

定义的Protocol类 #

from __future__ import annotations

from dataclasses import dataclass
from typing import Dict, Optional, Protocol, runtime_checkable

@runtime_checkable
class PipelineProcess(Protocol):

    def update(self):
        ...

    def set_inputs(self, inputs: Dict[str, int]):
        ...

    def get_outputs(self) -> Dict[str, int] | None:
        ...

实现的处理类 #

@dataclass
class ExampleProcess:
    in_value: Optional[int | None] = None
    out_value: Optional[int | None] = None

    def update(self):
        assert(self.in_value is not None)
        self.out_value = self.in_value * 2

    def set_inputs(self, values: Dict[str, int]):
        assert "value" in values.keys()
        self.in_value = values["value"]

    def get_outputs(self) -> Dict[str, int]:
        return {"value": self.out_value}

mypy类型检查错误 #

error: Dict entry 0 has incompatible type "str": "Optional[int]"; expected "str": "int"

问题与解答 #

1. 类型检查错误的解决 #

报错核心是ExampleProcess.get_outputs返回的self.out_value类型为Optional[int]（数据类定义的类型等价于该类型），但方法声明返回Dict[str, int]，两者类型不匹配。有两种合理的解决方式：

• 确保调用时序，添加非空断言：
  因为update方法中已经通过断言保证in_value非空，并且赋值out_value = in_value * 2，只要get_outputs在update之后调用，out_value必然是int类型。可以在get_outputs中添加断言，让mypy识别这一点：

  def get_outputs(self) -> Dict[str, int]:
      assert self.out_value is not None, "必须先调用update()再调用get_outputs()"
      return {"value": self.out_value}
  

• 匹配实际场景调整返回类型：
  如果存在get_outputs在update之前被调用的场景，此时out_value可能为None，那么将返回类型改为Dict[str, Optional[int]]是合理的。同时要同步修改Protocol中get_outputs的返回类型为Dict[str, Optional[int]] | None，保证协议与实现的一致性。

2. Optional[int | None]的冗余问题 #

Optional[int | None]完全冗余：

• Optional[T]是Union[T, None]的官方别名，因此Optional[int]等价于int | None。
• Optional[int | None]相当于Union[int, None, None]，重复的None会被类型检查器忽略，最终等价于Optional[int]。

使用建议：

• 直接用Optional[int]替代冗余写法，代码更简洁规范。
• 不要滥用Optional：只有当变量确实可能为None时才使用，比如ExampleProcess中in_value和out_value初始为None、后续会被赋值的场景；如果变量永远不会是None，则不需要添加Optional，避免类型模糊。

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