主页 / 问题 / 1553551
Accepted
insolor
Asked:2023-11-28 17:00:20 +0000 UTC2023-11-28 17:00:20 +0000 UTC

序列化 pydantic 模型，并将字段名称转换为驼峰命名法

  • 772

Java 中有一个服务，Python 中有一个客户端。该服务接收/返回带有驼峰风格字段名称的 json；在 Python 中相应的 pydantic 模型中，我想使用 Snake_case （Python 的惯用语）。

我正在尝试创建一个带有别名的模型：

from pydantic import BaseModel, Field


class Test(BaseModel):
    test_test: str = Field(..., alias = "testTest")

通过这段代码，在初始化模型时，需要通过别名指定字段名称（以camelCase形式），并在序列化时输出到snake_case：

test = Test(testTest="test")  # При указании test_test выдает ошибку валидации Field required [type=missing, input_value={'test_test': 'test'}, input_type=dict]
print(test.model_dump())

结论：

{'test_test': 'test'}

我需要相反的，这样它就可以用普通名称（在snake_case中）初始化，并在camelCase中序列化。理想情况下，不需要为每个字段指定别名。

python

1 个回答

  1. Best Answer

    要在初始化期间使用常规字段名称，您需要向模型添加一个设置populate_by_name=True（文档）：

    class Test(BaseModel):
    test_test: str = Field(..., alias="testTest")

    model_config = ConfigDict(populate_by_name=True)

    要使用字段别名进行序列化，您需要指定一个参数（请参阅方法文档by_alias=True中的 by_alias 参数；该方法和相应的类方法有一个类似的参数- 如果您需要序列化，例如，通过一个对象列表进行序列化，则相关）类型适配器）：model_dumpmodel_dump_jsonTypeAdapter

    test = Test(test_test="test")
print(test.model_dump(by_alias=True))

    结论：

    {'testTest': 'test'}

    alias_generator要自动生成别名，您可以在模型配置中的字段中指定将字符串从snake_case转换为camelCase的函数（ alias_generator文档，该模块pydantic.alias_generators有几个现成的转换函数，包括转换为camelCase）：

    from pydantic.alias_generators import to_camel

# Аналогичный конвертер реализованный "на коленке":
# def to_camel(string: str) -> str:
#    words = string.split("_")
#    return words[0] + ''.join(word.capitalize() for word in words[1:])


class Test(BaseModel):
    test_test: str

    model_config = ConfigDict(
        alias_generator=to_camel,
        populate_by_name=True,
    )

    如果模型配置变得很麻烦并且在所有模型中不断重复，您可以将其移动到一个单独的类中，并将该类指定为所有模型的基类，而不是BaseModel. 完整示例：

    from pydantic import BaseModel, ConfigDict, Field
from pydantic.alias_generators import to_camel


class MyBaseModel(BaseModel):
    model_config = ConfigDict(
        alias_generator=to_camel,
        populate_by_name=True,
    )


class Test(MyBaseModel):
    test_test: str


test = Test(test_test="test")
encoded = test.model_dump(by_alias=True)
print(encoded)
decoded = Test.model_validate(encoded)
print(repr(decoded))

    结论：

    {'testTest': 'test'}
Test(test_test='test')
    • 3

相关问题