如何序列化在Pydantic中扩展内置类型的自定义类型？

Question

目前，我正在与Fastapi和Pydantic合作作为Serialializer。 问题是，我们在服务器端使用雪花ID，这意味着我们需要在发送到客户端之前将这些ID转换为字符串（JavaScript），因为ID大于JS的 max Safe Integer 。

因此，我尝试创建一个新类，该类别扩展了Python的INT类型，并自定义了它将如何序列化和应对序列化。这是我的代码：

class SnowflakeId(int):
    @classmethod
    def __get_validators__(cls):
        yield cls.validate

    @classmethod
    def validate(cls, v: str):
        return int(v)

    @classmethod
    def __modify_schema__(cls, field_schema: dict) -> None:
        field_schema['type'] = 'string'

这是模型：

class BaseModel(pydantic.BaseModel):
    __abstract__ = True

    id: SnowflakeId

    class Config:
        orm_mode = True
        arbitrary_types_allowed = True
        json_encoders = {
            SnowflakeId: lambda v: str(v)
        }
        alias_generator = camelize
        allow_population_by_field_name = True

当从JSON字符串到INT ID的次要化时，它可以正常工作，但是，当涉及序列化时，输出仍然是整数。 我希望它也将ID序列化为字符串，是否有可能？

Answer 1

是的！

json_encoders 是一个很好的尝试，但是在hood pydantic下调用json.dumps 。因此，对于可序列化类型（例如 snowflakeid ），它不在乎其他 json_encoders 。

您可以做的是覆盖转储方法：

def my_dumps(v, *, default):
    for key, value in v.items():
        if isinstance(value, SnowflakeId):
            v[key] = str(value)
        else:
            v[key] = value
    return json.dumps(v)

class BaseModel(pydantic.BaseModel):
    id: SnowflakeId

    class Config:
        json_dumps = my_dumps

和 validate 返回 snowflakeid ：

class SnowflakeId(int):
    ...

    @classmethod
    def validate(cls, v: str):
        return cls(v)

m = BaseModel(id="123")
print(m.json()) # {"id": "123"}