Pydantic：如何使用自定义属性名解析JSON

Question

如何定义json属性到属性名称不同的pydantic模型之间的映射？。即：

# I want to parse thumbnailUrl into thumbnail
class ChatMessageAttachment(BaseModel):
    id: str
    thumbnail: Optional["str"] = None

external_data = {"id": "123", "thumbnailUrl": "www.google.es"}
chat_message = ChatMessageAttachment(**external_data)
print(chat_message) # >>>id='123' thumbnail=None

Answer 1

在Pydantic中，您可以使用别名进行此操作。在下面的代码中，如果您还希望使用原始thumbnail实例化对象，则只需要Config{}。如果在创建对象时仅使用thumbnailUrl，则不需要它：

from pydantic import BaseModel, Field
from typing import Optional

class ChatMessageAttachment(BaseModel):
    id: str
    thumbnail: Optional["str"] = Field(None, alias="thumbnailUrl")
    class Config:
        allow_population_by_field_name = True


external_data = {"id": "123", "thumbnailUrl": "www.google.es"}
chat_message = ChatMessageAttachment(**external_data)

print(chat_message) 
#  id='123' thumbnail='www.google.es

使用allow_population_by_field_name，您还可以执行以下操作：

external_data = {"id": "123", "thumbnail": "www.google.es"}
ChatMessageAttachment(**external_data)
# ChatMessageAttachment(id='123', thumbnail='www.google.es')