如何自动生成Pydantic模型ID字段并禁止外部设置该字段？

要实现自动生成item_id且不允许调用者指定、同时序列化时能输出该字段的需求，你需要调整Field的配置，核心是用init=False替代init_var=False，具体实现如下：

代码示例（Pydantic V2） #

import uuid
from pydantic import BaseModel, Field

def id_generator() -> str:
    # 这里用UUID示例，你可以替换成自己的生成逻辑
    return str(uuid.uuid4())

class MyModel(BaseModel):
    # 关键配置：init=False 禁止初始化时传入该字段，default_factory 自动生成值
    item_id: str = Field(init=False, default_factory=id_generator)
    # 其他业务字段示例
    name: str

    # 如果需要模型不可变（禁止后续修改item_id），添加以下配置
    model_config = {"frozen": True}

代码示例（Pydantic V1） #

如果你仍在使用Pydantic V1，写法略有不同：

import uuid
from pydantic import BaseModel, Field

def id_generator() -> str:
    return str(uuid.uuid4())

class MyModel(BaseModel):
    item_id: str = Field(default_factory=id_generator, init=False, allow_mutation=False)
    name: str

为什么之前的方案不生效？ #

• 使用init_var=False时，item_id会被标记为初始化临时变量，不属于模型的核心字段集合，因此序列化（如model_dump）时不会输出它。
• 使用PrivateAttr定义的是类的私有属性，Pydantic默认不会将其纳入序列化范围，自然也不会出现在model_dump的结果中。

验证效果 #

• 初始化时传入item_id会直接报错，确保调用者无法指定该值：

  # 报错：TypeError: MyModel.__init__() got an unexpected keyword argument 'item_id'
  MyModel(name="test", item_id="custom_id")
  

• 自动生成的item_id会正常出现在序列化结果中：

  obj = MyModel(name="test")
  print(obj.model_dump())
  # 输出示例：{'item_id': 'a1b2c3d4-...', 'name': 'test'}
  

内容的提问来源于stack exchange，提问作者Brian