Mypy不对dataclass返回类型做类型检查问题咨询

问题根源 #

你写的代码里存在两个明确的类型错误，但Mypy未检测出来：

1. 函数标注返回HttpMessageModel实例，但实际返回的是字典，类型完全不匹配
2. 字典内的code是字符串"200"，不符合dataclass中code: int的定义

Mypy默认配置不会严格校验这类返回类型不兼容的场景，也不会自动将字典结构与dataclass的类型定义做绑定检查，这是未报错的核心原因。

解决方法 #

方法1：直接返回dataclass实例（最推荐） #

不要返回字典，直接创建HttpMessageModel的实例返回，Mypy会立刻校验参数类型：

from dataclasses import dataclass

@dataclass
class HttpMessageModel:
    message: str
    code: int

def http_message(message: str) -> HttpMessageModel:
    # 传入字符串"200"会触发Mypy报错
    return HttpMessageModel(message=message, code="200")

运行python -m pipenv run mypy .后，Mypy会给出清晰错误提示：

error: Argument "code" to "HttpMessageModel" has incompatible type "str"; expected "int"  [arg-type]

方法2：用TypedDict绑定字典结构（必须返回字典时使用） #

如果业务上必须返回字典，可定义一个与dataclass字段完全一致的TypedDict，让函数返回该类型，同时开启Mypy严格检查：

from dataclasses import dataclass
from typing import TypedDict

@dataclass
class HttpMessageModel:
    message: str
    code: int

# 定义与dataclass匹配的字典类型
class HttpMessageDict(TypedDict):
    message: str
    code: int

def http_message(message: str) -> HttpMessageDict:
    return {
        "message": message,
        "code": "200",  # Mypy会检测到此处类型错误
    }

在项目的pyproject.toml或mypy.ini中开启严格模式：

[tool.mypy]
strict = true

再次运行检查命令，Mypy会报错：

error: Dict entry 2 has incompatible type "str": "str"; expected "str": "int"  [dict-item]

方法3：单独开启关键检查选项（不想全量严格时使用） #

若不想开启全量严格模式，可单独启用几个关键的Mypy选项，在配置文件中添加：

[tool.mypy]
disallow_incompatible_return_types = true
disallow_untyped_defs = true

这样Mypy会先检查返回类型是否匹配，强制你要么返回正确的dataclass实例，要么修正返回类型标注，间接避免字段类型错误。

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