Pydantic模型可选字段定义最佳实践及语法适配咨询

问题本质 #

你遇到的报错核心原因：在Pydantic 2.x里，仅声明int | None或Optional[int]类型，字段仍然是必填项——这只是允许字段值可以为null，但并没有允许请求体里完全不提供这个字段。只有给字段设置默认值None，才会让它变成可选字段（请求体可缺省）。

正确的可选字段定义方式 #

1. 直接设置默认值None（最常用）

支持Python 3.10+的int | None联合类型语法，也兼容传统的Optional[int]写法：

from pydantic import BaseModel
from typing import Optional  # 用Optional语法时需要导入

class MyModel(BaseModel):
    # 写法1：Python 3.10+联合类型
    author_id: int | None = None
    # 写法2：传统Optional语法
    author_id: Optional[int] = None

2. 用Field显式配置（适合需要额外字段规则的场景）

如果需要给字段加描述、验证规则等，可以用Field来标记默认值：

from pydantic import BaseModel, Field

class MyModel(BaseModel):
    author_id: int | None = Field(default=None, description="作者ID，可选字段")

关于int | None语法的版本说明 #

int | None是Python 3.10及以上版本支持的原生语法，Pydantic 2.x全版本都兼容这个写法——你之前的问题不是语法不支持，而是没给字段设置默认值导致的必填校验失败。

关键注意点 #

要让字段成为请求体可缺省的可选字段，必须同时满足两个条件：

• 类型声明允许None（int | None或Optional[int]）
• 给字段设置默认值为None（直接赋值=None或通过Field设置）

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