FastAPI（28）- JSON Compatible Encoder 利器之 jsonable_encoder

jsonable_encoder

• 在實際應用場景中，可能需要將數據類型（如：Pydantic 模型）轉換為與 JSON 兼容的類型（如：字典、列表）
• 比如：需要將數據存儲在數據庫中
• 為此，FastAPI 提供了一個 jsonable_encoder() 函數
• jsonable_encoder 實際上是 FastAPI 內部用來轉換數據的，但它在許多其他場景中很有用

 

實際栗子

需求

• 假設有一個僅接收兼容 JSON 數據的數據庫 fake_db
• 例如，它不接收日期時間對象，因為這些對象與 JSON 不兼容
• 因此，必須將日期時間對象轉換為包含 ISO 格式數據的 str 
• 同樣，這個數據庫不會接收 Pydantic 模型（具有屬性的對象），只會接收 dict
• 使用 jsonable_encoder 將數據轉換成 dict

 

實際代碼

#!usr/bin/env python
# -*- coding:utf-8 _*-
"""
# author: 小菠蘿測試筆記
# blog:  https://www.cnblogs.com/poloyy/
# time: 2021/9/23 1:13 下午
# file: 24_json_encoder.py
"""

from datetime import datetime
from typing import Optional

import uvicorn
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel

# 模擬數據庫
fake_db = {}


class Item(BaseModel):
    title: str
    timestamp: datetime
    age: Optional[int] = None


app = FastAPI()


@app.put("/items/{id}")
def update_item(id: str, item: Item):
    # 1、打印剛傳進來的數據和類型
    print(f"item is {item}\nitem type is {type(item)}")

    # 2、調用 jsonable_encoder 將 Pydantic Model 轉成 Dict
    json_compatible_item_data = jsonable_encoder(item)

    # 3、模擬將數據落庫操作
    fake_db[id] = json_compatible_item_data

    # 4、打印轉換后的數據和類型
    print(f"encoder_data is {json_compatible_item_data}\nencoder_data type is {type(json_compatible_item_data)}")
    return json_compatible_item_data


if __name__ == "__main__":
    uvicorn.run(app="24_json_encoder:app", host="127.0.0.1", port=8080, reload=True, debug=True)

• jsonable_encoder 將 Pydantic 模型轉換為 dict，並將日期時間轉換為 str
• 它將返回一個 Python 標准數據結構（比如：dict），其中的值和子值都可以和 JSON 兼容

 

訪問 /items/123 接口，查看控制台輸出

item is title='string' timestamp=datetime.datetime(2021, 9, 23, 5, 16, 36, 425000, tzinfo=datetime.timezone.utc) age=24
item type is <class '24_json_encoder.Item'>

encoder_data is {'title': 'string', 'timestamp': '2021-09-23T05:16:36.425000+00:00', 'age': 24}
encoder_data type is <class 'dict'>