如何用Pydantic处理遗留API的字段别名与已有键冲突问题？

对接遗留API时，API返回结构同时包含嵌套的logo对象和直接的logo_url字符串，需要让Pydantic模型的logo字段存储字符串值而非嵌套对象。原有的字段别名映射方案因响应中同时存在logo键而失效，且不想用遍历删除键的繁琐方式，以下是几种优雅的Pydantic实现方案：

方法一：字段验证器（Field Validator） #

通过字段验证器预处理logo字段的输入值，优先使用logo_url， fallback到logo.url的值，自动兼容两种字段存在的场景：

Pydantic v2 实现 #

from pydantic import BaseModel, field_validator, Field
from uuid import UUID

class UUIDIdentifiable(BaseModel):
    uuid: UUID

class Survey(UUIDIdentifiable):
    logo: str | None = Field(None)

    @field_validator('logo', mode='before')
    def extract_logo_url(cls, v, values):
        # 优先取响应中的logo_url值
        if 'logo_url' in values.data:
            return values.data['logo_url']
        # 若logo是嵌套对象，提取其url字段
        elif isinstance(v, dict) and 'url' in v:
            return v['url']
        return v

    class Config:
        populate_by_name = True

Pydantic v1 实现 #

from pydantic import BaseModel, validator, Field
from uuid import UUID

class UUIDIdentifiable(BaseModel):
    uuid: UUID

class Survey(UUIDIdentifiable):
    logo: str | None = Field(None)

    @validator('logo', pre=True)
    def extract_logo_url(cls, v, values):
        if 'logo_url' in values:
            return values['logo_url']
        elif isinstance(v, dict) and 'url' in v:
            return v['url']
        return v

    class Config:
        allow_population_by_field_name = True

方法二：模型级验证器（Model Validator） #

如果需要全局预处理整个输入数据，可使用模型级验证器在解析前直接修改数据结构：

Pydantic v2 实现 #

from pydantic import BaseModel, model_validator
from uuid import UUID

class UUIDIdentifiable(BaseModel):
    uuid: UUID

class Survey(UUIDIdentifiable):
    logo: str | None = None

    @model_validator(mode='before')
    def preprocess_logo(cls, data):
        if isinstance(data, dict):
            # 给logo字段赋值：优先用logo_url，没有则取logo.url
            data['logo'] = data.get('logo_url') or (data.get('logo', {}).get('url') if isinstance(data.get('logo'), dict) else None)
            # 可选：若不需要保留logo_url，可删除该字段
            # del data['logo_url']
        return data

这种方式无需额外配置别名，直接在模型解析前完成字段映射，代码简洁且无需手动处理原始字段。

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