python - 我可以在 Pydantic 中创建一个自动转换为日期时间的 Unix 时间类型吗？

Question

我收到一个带有 unix 时间戳的 JSON 响应，例如:

{"protocol": "http", "isPublic": false, "startTime": 1607586354631}

使用 Pydantic 读取这些数据的最简单方法是注释 startTime如 int .我想将其注释为 UnixMicrotime或类似的，以便 Pydantic 也将其解析为日期时间(并在序列化时将日期时间转换回 UnixMicrotime)。那可能吗？
最小的例子

import json
from pydantic import BaseModel


class Data(BaseModel):
    protocol: str
    isPublic: bool
    startTime: int


json_str = """{"protocol": "http", "isPublic": false, "startTime": 1607586354631}"""
data_dict = json.loads(json_str)
data = Data.parse_obj(data_dict)
print(data)

给

protocol='http' isPublic=False startTime=1607586354631

但我希望它是:

protocol='http' isPublic=False startTime=2020-12-10T08:45:54

Answer 1

您可以将其注释为 datetime解析它，并添加 custom json_encoder 用于序列化 datetime作为unix时间。样本:

import json
from datetime import datetime

from pydantic import BaseModel

json_str = """{"protocol": "http", "isPublic": false, "startTime": 1607586354631}"""
data_dict = json.loads(json_str)


class Data(BaseModel):
    protocol: str
    isPublic: bool
    startTime: datetime


data = Data.parse_obj(data_dict)
print(data.json())


class DataWithUnixTime(BaseModel):
    protocol: str
    isPublic: bool
    startTime: datetime

    class Config:
        json_encoders = {
            datetime: lambda v: v.timestamp(),
        }


data = DataWithUnixTime.parse_obj(data_dict)
print(data.json())

{"protocol": "http", "isPublic": false, "startTime": "2020-12-10T07:45:54.631000+00:00"}
{"protocol": "http", "isPublic": false, "startTime": 1607586354.631}