在Marshmallow Schema中区分显式传入的None值与默认None值

我完全懂你遇到的这个痛点——当用marshmallow-dataclass配合APIFlask定义API请求Schema时，默认的None会把「用户没传这个字段」和「用户显式传了null」两种场景混为一谈，这在需要不同业务逻辑处理时确实挺棘手的。

你提到的**哨兵值（Sentinel Value）**思路是解决这个问题的标准方案，我来把这个方案补全，让它能直接在你的代码里跑起来：

步骤1：定义专属的未传入标记 #

首先创建一个单例类作为“字段未传入”的专属标记，和None做明确区分：

class _Undefined:
    pass

# 生成唯一的单例实例
Undefined = _Undefined()

步骤2：修改Schema的字段定义 #

在FooIn类里，用这个Undefined作为默认值，同时配置marshmallow字段的missing和allow_none参数，确保两种场景被正确识别：

from marshmallow_dataclass import dataclass, field
import marshmallow

class _Undefined:
    pass

Undefined = _Undefined()

@dataclass
class FooIn:
    bar: str | None | _Undefined = field(
        default=Undefined,
        metadata={
            "marshmallow_field": marshmallow.fields.String(
                allow_none=True,  # 允许用户显式传入null
                missing=Undefined  # 字段未传入时用Undefined标记
            )
        }
    )

步骤3：在业务逻辑中区分处理 #

现在你就可以在接口处理函数里精准判断三种情况了：

from apiflask import APIFlask

app = APIFlask(__name__)

@app.post("/foo")
def create_foo(body: FooIn):
    if body.bar is Undefined:
        # 用户完全没传bar字段，执行对应的业务逻辑
        print("用户未提供bar字段，使用默认值")
        processed_bar = "default_value"
    elif body.bar is None:
        # 用户显式传入了null，执行清空/特殊处理逻辑
        print("用户显式设置bar为null")
        processed_bar = None
    else:
        # 用户传入了正常的字符串值，直接使用
        print("用户传入了bar值:", body.bar)
        processed_bar = body.bar
    
    # 后续业务逻辑...
    return {"result": processed_bar}

关键说明 #

• 一定要用is来判断body.bar is Undefined，因为这是单例实例，is能保证精准匹配，避免和其他值混淆
• allow_none=True是必须的，这样marshmallow才会接受用户传入的null值，否则会把{"bar": null}判定为非法请求
• 这个方案同时保留了{}和{"bar": null}的合法性，完全符合你的需求

备注：内容来源于stack exchange，提问作者Alex vdG