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 allow_population_by_field_name。如果您在创建对象时只使用 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')

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

Pydantic: How to parse JSON with custom property name

python

pydantic

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

Pydantic: How to parse JSON with custom property name

python

pydantic

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