如何解决 pydantic 模型不是 JSON 可序列化的

Question

我有以下 pydantic 模型。

class SubModel(BaseModel):
    columns: Mapping
    key: List[str]
    required: Optional[List[str]]

    class Config:
        anystr_strip_whitespace: True
        extra: Extra.allow
        allow_population_by_field_name: True


class MyModel(BaseModel):
    name: str
    config1: Optional[SubModel]
    config2: Optional[Mapping]
    class Config:
        anystr_strip_whitespace: True
        extra: Extra.allow
        allow_population_by_field_name: True

当我试图对此进行dumps时，我得到model is not JSON serializable

from io import BytesIO
from orjson import dumps
    
bucket = s3.Bucket(bucket_name)
bucket.upload(BytesIO(dumps(data)), key, ExtraArgs={'ContentType': 'application/json'})

错误 -

TypeError: Type is not JSON serializable: MyModel

data是一个普通的 python 字典，其中一项是MyModel类型的项目。 尝试使用.json()但获取dict has no attribute json 。

我被困在这里。 有人能帮我吗。

Answer 1

对FastAPI响应有类似的问题，通过以下方式解决：

return JSONResponse(content=jsonable_encoder(item), status_code=200)

或者可以是这样的：

return jsonable_encoder(item)

其中jsonable_encoder是：

from fastapi.encoders import jsonable_encoder

更多细节在这里： https ://fastapi.tiangolo.com/tutorial/encoder/

Answer 2

这里的问题是 pydantic 模型默认情况下不是 json 可序列化的，在您的情况下，您可以调用 data.dict() 来序列化模型的 dict 版本。

from io import BytesIO
from orjson import dumps

bucket = s3.Bucket(bucket_name)
bucket.upload(BytesIO(dumps(data.dict())), key, ExtraArgs={'ContentType': 'application/json'})

Answer 3

仅设置一个默认编码器（如果其他所有方法都失败，则使用该编码器）怎么样？

orjson.dumps(
    MyModel(name="asd"),
    default=lambda x: x.dict()
)
# Output: b'{"name":"asd","config1":null,"config2":null}'

或者更多嵌套：

orjson.dumps(
    {"a_key": MyModel(name="asd")}, 
    default=lambda x: x.dict()
)
# Output: b'{"a_key":{"name":"asd","config1":null,"config2":null}}'

如果您有 Pydantic 以外的其他类型，只需创建一个函数并分别处理您拥有的所有类型。

它也适用于标准库中的json库（对于那些不使用 orjson 的库）。