如何用Pydantic简洁实现二选一可选参数并支持懒加载？

需求说明 #

实现一个Pydantic模型，要求初始化时必须传入object_id或object中的恰好一个，缺失的参数通过另一个懒加载计算得出，同时解决原代码的以下问题：

• 希望用无下划线的参数（如object_id/object）初始化，而非带下划线的内部字段
• 消除类型检查提示的返回值可能为None的警告
• 用更简洁的Pydantic原生特性实现
• 保留懒加载，避免提前执行高开销的get_object_by_id IO操作

优化后的代码 #

from pydantic import BaseModel, model_validator, PrivateAttr
from typing import Optional, cast

class Object:
    id: int

def get_object_by_id(id: int) -> Object:
    # 模拟高开销IO操作，实际场景替换为真实逻辑
    return Object(id=id)

class ObjectContent(BaseModel):
    # 对外暴露的可选初始化参数，二选一
    object_id: Optional[int] = None
    object: Optional[Object] = None
    
    # 私有属性用于缓存懒加载的结果，不对外暴露
    _cached_object: Optional[Object] = PrivateAttr(default=None)
    _cached_object_id: Optional[int] = PrivateAttr(default=None)

    @model_validator(mode="after")
    def validate_exactly_one(self) -> "ObjectContent":
        # 校验：必须且只能传入object_id或object中的一个
        has_id = self.object_id is not None
        has_obj = self.object is not None
        if has_id == has_obj:
            raise ValueError("必须传入object_id或object中的恰好一个，不能同时传或都不传")
        
        # 初始化缓存
        if has_id:
            self._cached_object_id = self.object_id
        else:
            self._cached_object = self.object
            self._cached_object_id = self.object.id
        return self

    @property
    def resolved_object_id(self) -> int:
        # 断言确保值存在，消除类型检查警告
        assert self._cached_object_id is not None, "验证逻辑已确保object_id存在"
        # 也可以用cast替代断言：return cast(int, self._cached_object_id)
        return self._cached_object_id

    @property
    def resolved_object(self) -> Object:
        if self._cached_object is None:
            # 仅当首次访问时执行懒加载IO操作
            self._cached_object = get_object_by_id(self.resolved_object_id)
        # 断言确保实例已生成，消除类型检查警告
        assert self._cached_object is not None, "懒加载已生成Object实例"
        return self._cached_object

问题解决说明 #

• 无下划线参数初始化：现在可以直接用ObjectContent(object_id=5)或ObjectContent(object=my_object)初始化，完全符合正常参数命名习惯，无需再使用带下划线的内部字段。
• 消除类型检查警告：通过模型验证器确保初始化时必有一个参数传入，结合assert断言明确告诉类型检查器缓存值不可能为None；如果不习惯用断言，也可以用typing.cast进行强制类型转换。
• 简化Pydantic实现：利用Pydantic原生的model_validator(mode="after")做参数校验，配合PrivateAttr管理内部缓存状态，去掉了原代码中繁琐的setter逻辑，结构更简洁清晰。
• 保留懒加载特性：仅当访问resolved_object属性时才会调用高开销的get_object_by_id方法，首次调用后结果会被缓存，后续访问直接返回缓存值，避免重复执行IO操作。

使用示例 #

# 用object_id初始化
content1 = ObjectContent(object_id=5)
print(content1.resolved_object_id)  # 输出：5
print(content1.resolved_object.id)  # 首次调用触发get_object_by_id，输出：5

# 用object初始化
my_obj = Object(id=10)
content2 = ObjectContent(object=my_obj)
print(content2.resolved_object_id)  # 输出：10
print(content2.resolved_object.id)  # 直接返回缓存的object，不触发IO

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