如何让Pylance与Pydantic实例化BaseModel时兼容且无重复代码？

问题背景 #

使用user = User(**external_data)实例化Pydantic的BaseModel子类User时，Pylance无法识别external_data字典的类型合法性，抛出类型不兼容错误。手动创建与User结构一致的TypedDict能解决问题，但需要重复编写字段定义，现寻求无需重复代码的兼容方案。

未使用UserDict时的Pylance错误信息：

Argument of type "int | str | datetime | list[int]" cannot be assigned to parameter "id" of type "int" in function "__init__"
  Type "int | str | datetime | list[int]" cannot be assigned to type "int"
    "datetime" is incompatible with "int"PylancereportGeneralTypeIssues
Argument of type "int | str | datetime | list[int]" cannot be assigned to parameter "name" of type "str" in function "__init__"
  Type "int | str | datetime | list[int]" cannot be assigned to type "str"
    "datetime" is incompatible with "str"PylancereportGeneralTypeIssues
Argument of type "int | str | datetime | list[int]" cannot be assigned to parameter "signup_ts" of type "datetime | None" in function "__init__"PylancereportGeneralTypeIssues
Argument of type "int | str | datetime | list[int]" cannot be assigned to parameter "friends" of type "list[int]" in function "__init__"
  Type "int | str | datetime | list[int]" cannot be assigned to type "list[int]"
    "datetime" is incompatible with "list[int]"PylancereportGeneralTypeIssues
(variable) external_data: dict[str, int | str | datetime | list[int]]

解决方案 #

方案1：自动生成TypedDict（无需重复定义字段） #

利用typing.get_type_hints获取Pydantic模型的类型注解，动态生成对应的TypedDict，彻底避免重复编写字段定义：

from datetime import datetime
from pydantic import BaseModel
from typing import TypedDict, get_type_hints

# 定义Pydantic模型
class User(BaseModel):
    id: int
    name: str = "John Doe"
    signup_ts: datetime | None = None
    friends: list[int] = []

# 自动生成与User结构一致的TypedDict
UserDict = TypedDict(
    "UserDict",
    {k: v for k, v in get_type_hints(User).items()},
    total=False  # 适配模型中有默认值的可选字段
)

# 用自动生成的UserDict标注external_data
external_data: UserDict = {
    'id': 123,
    'name': 'Vlad',
    'signup_ts': datetime.now(),
    'friends': [1, 2, 3],
}

user = User(**external_data)
print(user)
print(user.id)

方案2：使用Pydantic的model_validate替代直接实例化 #

如果不想使用TypedDict，可以用model_validate方法实例化模型，Pylance能自动识别输入字典的类型合法性：

from datetime import datetime
from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str = "John Doe"
    signup_ts: datetime | None = None
    friends: list[int] = []

external_data = {
    'id': 123,
    'name': 'Vlad',
    'signup_ts': datetime.now(),
    'friends': [1, 2, 3],
}

# 用model_validate实例化，Pylance会自动校验类型提示
user = User.model_validate(external_data)
print(user)
print(user.id)

方案3：利用Pydantic v2的TypeAdapter（适用于v2版本） #

Pydantic v2的TypeAdapter可同时实现类型提示识别与运行时校验，无需额外定义类型：

from datetime import datetime
from pydantic import BaseModel, TypeAdapter

class User(BaseModel):
    id: int
    name: str = "John Doe"
    signup_ts: datetime | None = None
    friends: list[int] = []

# 创建User的TypeAdapter实例
user_adapter = TypeAdapter(User)

# 校验并获取符合类型的输入数据，同时获得Pylance类型提示
external_data = user_adapter.validate_python({
    'id': 123,
    'name': 'Vlad',
    'signup_ts': datetime.now(),
    'friends': [1, 2, 3],
})

user = User(**external_data)
# 也可直接通过adapter获取实例：user = user_adapter.validate_python(external_data)
print(user)
print(user.id)

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