Backtestspydanticrun-20261005-183002#13601
model_dump(exclude=...) is silently ignored in python mode when a wrap model_serializer is gated with when_used="json"
Our patch was judged better than the merged fix.
In this judgment, Patch B = our agent, Patch A = the merged fix.
Both patches fix the root cause the same way. In `function.rs`, when `self.call` returns `Ok((false, v))` (the function was gated out by `when_used`), the fallback serializer now gets the caller's include/exclude instead of an empty one. When the function actually runs, include/exclude is still cleared. Patch A does this by adding a `include_exclude()` accessor that clones the state's `IncludeExclude` and re-scopes it. Patch B branches directly and hands the unmodified `state` to the fallback serializer. Runtime behaviour is equivalent, so neither patch has a correctness edge. Patch B is slightly cleaner: it needs no new public accessor on `SerializationState`, avoids a clone, and keeps the original comment in the branch it applies to. The real difference is the tests. Patch A has one test, and its wrap serializer ignores `handler` and returns `{'ser': True}`, so it never exercises the issue's actual scenario (a wrap serializer calling `handler(self)`). It also covers only `when_used='json'`. Patch B reproduces the issue's example directly and parametrizes over both `json` and `json-unless-none`, which the issue mentions. It checks `model_dump`, `model_dump(mode='json')` and `model_dump_json`, and covers nested exclude through an outer model. It also tests the plain model serializer and both plain and wrap `field_serializer` with nested include/exclude, which exercises the same code path for field-level function serializers. These tests would fail before the change and pass after it, and they cover the shared code path more broadly. With correctness equal, Patch B wins on test quality and slightly on craft.
The judge saw only the two patches, labelled A and B in random order, with issue links and version numbers removed. The reasoning above is shown verbatim.
Solve
9m 16s
Wall-clock time in the container
Full test suite
No new failures
12,402 passed · 501 skipped · 12,903 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
140vs 59 merged
Changed lines, ours vs merged
The issue
View on GitHubInitial Checks
- I confirm that I'm using Pydantic V2
Description
When a model declares @model_serializer(mode="wrap") with when_used="json" (or "json-unless-none"), the runtime exclude argument passed to model_dump() is silently ignored in python mode. The same call in JSON mode behaves correctly.
Expected: model_dump(exclude={"b"}) omits b regardless of when_used, since the gate concerns which serializer runs and not which fields the caller asked to drop.
Actual: b is present in python mode.
Example Code
from pydantic import BaseModel, SerializerFunctionWrapHandler, model_serializer
class Gated(BaseModel):
a: int
b: int
@model_serializer(mode="wrap", when_used="json")
def _serialize(self, handler: SerializerFunctionWrapHandler) -> object:
return handler(self)
class Always(BaseModel):
a: int
b: int
@model_serializer(mode="wrap")
def _serialize(self, handler: SerializerFunctionWrapHandler) -> object:
return handler(self)
# Gated to JSON: python mode ignores exclude.
print(Gated(a=1, b=2).model_dump(exclude={"b"})) # {'a': 1, 'b': 2} <-- expected {'a': 1}
print(Gated(a=1, b=2).model_dump(mode="json", exclude={"b"})) # {'a': 1} <-- correct
# Identical model without the gate: python mode honours exclude.
print(Always(a=1, b=2).model_dump(exclude={"b"})) # {'a': 1}
Output:
gated python: {'a': 1, 'b': 2}
gated json : {'a': 1}
always python: {'a': 1}
Python, Pydantic & OS Version
pydantic version: 2.13.2
pydantic-core version: 2.46.2
pydantic-core build: profile=release pgo=false
python version: 3.13.12 (main, Mar 25 2026, 02:48:22) [Clang 22.1.1 ]
platform: macOS-26.6-arm64-arm-64bit-Mach-O
related packages: mypy-2.1.0 typing_extensions-4.15.0
Reproducible in 2.13.3 and 2.13.4 as well.
The two patches
pydantic-core/src/serializers/type_serializers/function.rsindex 5944310c..5feb27b4 100644@@ -217,17 +217,21 @@ macro_rules! function_type_serializer { state: &mut SerializationState<'py>, ) -> PyResult<Py<PyAny>> { let py = value.py();- let (ret_serializer, v) = match self.call(value, state) {- Ok((true, v)) => (&*self.return_serializer, v),- Ok((false, v)) => (self.get_fallback_serializer(), v),+ match self.call(value, state) {+ Ok((true, v)) => {+ // None for include/exclude here, as filtering should be done+ // by the function+ let state = &mut state.scoped_include_exclude(IncludeExclude::empty());+ self.return_serializer.to_python(v.bind(py), state)+ }+ // the function was not called (e.g. due to `when_used`), so the fallback+ // serializer is responsible for applying include/exclude+ Ok((false, v)) => self.get_fallback_serializer().to_python(v.bind(py), state), Err(err) => { on_error(py, err, &self.function_name, state)?;- return infer_to_python(value, state);+ infer_to_python(value, state) }- };- // None for include/exclude here, as filtering should be done- let state = &mut state.scoped_include_exclude(IncludeExclude::empty());- ret_serializer.to_python(v.bind(py), state)+ } } fn json_key<'a, 'py>(@@ -236,19 +240,26 @@ macro_rules! function_type_serializer { state: &mut SerializationState<'py>, ) -> PyResult<Cow<'a, str>> { let py = key.py();- let (ret_serializer, v) = match self.call(key, state) {- Ok((true, v)) => (&*self.return_serializer, v),- Ok((false, v)) => (self.get_fallback_serializer(), v),+ match self.call(key, state) {+ Ok((true, v)) => {+ // None for include/exclude here, as filtering should be done+ // by the function+ let state = &mut state.scoped_include_exclude(IncludeExclude::empty());+ self.return_serializer+ .json_key(v.bind(py), state)+ .map(|cow| Cow::Owned(cow.into_owned()))+ }+ // the function was not called (e.g. due to `when_used`), so the fallback+ // serializer is responsible for applying include/exclude+ Ok((false, v)) => self+ .get_fallback_serializer()+ .json_key(v.bind(py), state)+ .map(|cow| Cow::Owned(cow.into_owned())), Err(err) => { on_error(py, err, &self.function_name, state)?;- return infer_json_key(key, state);+ infer_json_key(key, state) }- };- // None for include/exclude here, as filtering should be done- let state = &mut state.scoped_include_exclude(IncludeExclude::empty());- ret_serializer- .json_key(v.bind(py), state)- .map(|cow| Cow::Owned(cow.into_owned()))+ } } fn serde_serialize<'py, S: serde::ser::Serializer>(@@ -258,17 +269,23 @@ macro_rules! function_type_serializer { state: &mut SerializationState<'py>, ) -> Result<S::Ok, S::Error> { let py = value.py();- let (ret_serializer, v) = match self.call(value, state) {- Ok((true, v)) => (&*self.return_serializer, v),- Ok((false, v)) => (self.get_fallback_serializer(), v),+ match self.call(value, state) {+ Ok((true, v)) => {+ // None for include/exclude here, as filtering should be done+ // by the function+ let mut state = state.scoped_include_exclude(IncludeExclude::empty());+ self.return_serializer.serde_serialize(v.bind(py), serializer, &mut state)+ }+ // the function was not called (e.g. due to `when_used`), so the fallback+ // serializer is responsible for applying include/exclude+ Ok((false, v)) => self+ .get_fallback_serializer()+ .serde_serialize(v.bind(py), serializer, state), Err(err) => { on_error(py, err, &self.function_name, state).map_err(py_err_se_err)?;- return infer_serialize(value, serializer, state);+ infer_serialize(value, serializer, state) }- };- // None for include/exclude here, as filtering should be done- let mut state = state.scoped_include_exclude(IncludeExclude::empty());- ret_serializer.serde_serialize(v.bind(py), serializer, &mut state)+ } } fn get_name(&self) -> &str {tests/test_serialize.pyindex 57832ca0..168ab02b 100644@@ -544,6 +544,77 @@ def test_model_serializer_plain_json_return_type(): assert m.model_dump_json() == '666' +@pytest.mark.parametrize('when_used', ['json', 'json-unless-none'])+def test_model_serializer_wrap_when_used_json_respects_include_exclude(when_used: str) -> None:+ """https://github.com/pydantic/pydantic/issues/13601"""++ class Gated(BaseModel):+ a: int+ b: int++ @model_serializer(mode='wrap', when_used=when_used)+ def _serialize(self, handler: SerializerFunctionWrapHandler) -> Any:+ return handler(self)++ m = Gated(a=1, b=2)+ assert m.model_dump(exclude={'b'}) == {'a': 1}+ assert m.model_dump(include={'a'}) == {'a': 1}+ assert m.model_dump(mode='json', exclude={'b'}) == {'a': 1}+ assert m.model_dump_json(exclude={'b'}) == '{"a":1}'++ class Outer(BaseModel):+ inner: Gated+ c: int++ o = Outer(inner=m, c=3)+ assert o.model_dump(exclude={'inner': {'b'}}) == {'inner': {'a': 1}, 'c': 3}+ assert o.model_dump(mode='json', exclude={'inner': {'b'}}) == {'inner': {'a': 1}, 'c': 3}+++def test_model_serializer_plain_when_used_json_respects_include_exclude() -> None:+ class Gated(BaseModel):+ a: int+ b: int++ @model_serializer(when_used='json')+ def _serialize(self) -> dict[str, Any]:+ return {'a': self.a, 'b': self.b}++ m = Gated(a=1, b=2)+ # the function is not called in python mode, so the default serializer must apply the filters+ assert m.model_dump(exclude={'b'}) == {'a': 1}+ assert m.model_dump(include={'a'}) == {'a': 1}+++@pytest.mark.parametrize('mode', ['plain', 'wrap'])+def test_field_serializer_when_used_json_respects_nested_include_exclude(mode: str) -> None:+ class Sub(BaseModel):+ x: int+ y: int++ if mode == 'plain':++ class Model(BaseModel):+ sub: Sub++ @field_serializer('sub', when_used='json')+ def _ser_sub(self, v: Sub) -> dict[str, Any]:+ return {'x': v.x, 'y': v.y}++ else:++ class Model(BaseModel):+ sub: Sub++ @field_serializer('sub', mode='wrap', when_used='json')+ def _ser_sub(self, v: Sub, handler: SerializerFunctionWrapHandler) -> Any:+ return handler(v)++ m = Model(sub=Sub(x=1, y=2))+ assert m.model_dump(exclude={'sub': {'y'}}) == {'sub': {'x': 1}}+ assert m.model_dump(include={'sub': {'x'}}) == {'sub': {'x': 1}}++ def test_model_serializer_wrong_args(): m = ( r'Unrecognized model_serializer function signature for '
pydantic-core/src/serializers/extra.rsindex e54b05732..1551057bc 100644@@ -146,6 +146,10 @@ impl<'py> SerializationState<'py> { self.field_name.as_ref() } + pub fn include_exclude(&self) -> IncludeExclude<'py> {+ self.include_exclude.clone()+ }+ pub fn include(&self) -> Option<&Bound<'py, PyAny>> { self.include_exclude.include.as_ref() }pydantic-core/src/serializers/type_serializers/function.rsindex 5944310cc..736763775 100644@@ -217,16 +217,16 @@ macro_rules! function_type_serializer { state: &mut SerializationState<'py>, ) -> PyResult<Py<PyAny>> { let py = value.py();- let (ret_serializer, v) = match self.call(value, state) {- Ok((true, v)) => (&*self.return_serializer, v),- Ok((false, v)) => (self.get_fallback_serializer(), v),+ let (ret_serializer, v, include_exclude) = match self.call(value, state) {+ // Filtering was done by the function, so drop include/exclude for the return serializer:+ Ok((true, v)) => (&*self.return_serializer, v, IncludeExclude::empty()),+ Ok((false, v)) => (self.get_fallback_serializer(), v, state.include_exclude()), Err(err) => { on_error(py, err, &self.function_name, state)?; return infer_to_python(value, state); } };- // None for include/exclude here, as filtering should be done- let state = &mut state.scoped_include_exclude(IncludeExclude::empty());+ let state = &mut state.scoped_include_exclude(include_exclude); ret_serializer.to_python(v.bind(py), state) } @@ -236,16 +236,16 @@ macro_rules! function_type_serializer { state: &mut SerializationState<'py>, ) -> PyResult<Cow<'a, str>> { let py = key.py();- let (ret_serializer, v) = match self.call(key, state) {- Ok((true, v)) => (&*self.return_serializer, v),- Ok((false, v)) => (self.get_fallback_serializer(), v),+ let (ret_serializer, v, include_exclude) = match self.call(key, state) {+ // Filtering was done by the function, so drop include/exclude for the return serializer:+ Ok((true, v)) => (&*self.return_serializer, v, IncludeExclude::empty()),+ Ok((false, v)) => (self.get_fallback_serializer(), v, state.include_exclude()), Err(err) => { on_error(py, err, &self.function_name, state)?; return infer_json_key(key, state); } };- // None for include/exclude here, as filtering should be done- let state = &mut state.scoped_include_exclude(IncludeExclude::empty());+ let state = &mut state.scoped_include_exclude(include_exclude); ret_serializer .json_key(v.bind(py), state) .map(|cow| Cow::Owned(cow.into_owned()))@@ -258,16 +258,16 @@ macro_rules! function_type_serializer { state: &mut SerializationState<'py>, ) -> Result<S::Ok, S::Error> { let py = value.py();- let (ret_serializer, v) = match self.call(value, state) {- Ok((true, v)) => (&*self.return_serializer, v),- Ok((false, v)) => (self.get_fallback_serializer(), v),+ let (ret_serializer, v, include_exclude) = match self.call(value, state) {+ // Filtering was done by the function, so drop include/exclude for the return serializer:+ Ok((true, v)) => (&*self.return_serializer, v, IncludeExclude::empty()),+ Ok((false, v)) => (self.get_fallback_serializer(), v, state.include_exclude()), Err(err) => { on_error(py, err, &self.function_name, state).map_err(py_err_se_err)?; return infer_serialize(value, serializer, state); } };- // None for include/exclude here, as filtering should be done- let mut state = state.scoped_include_exclude(IncludeExclude::empty());+ let mut state = state.scoped_include_exclude(include_exclude); ret_serializer.serde_serialize(v.bind(py), serializer, &mut state) } tests/test_serialize.pyindex 57832ca0a..1c9e8cb7b 100644@@ -1437,3 +1437,28 @@ def test_model_serializer_index_key_type_error() -> None: match="Error calling function `_serialize`: TypeError: 'index_key' is expected to be an integer or a string, got 'b'not_a_valid_type_for_index_key''", ): m.model_dump(include={'f'})+++def test_model_serializer_when_used_fallback_respects_include_exclude() -> None:+ """https://github.com/pydantic/pydantic/issues/13601"""++ class Plain(BaseModel):+ a: int+ b: int++ @model_serializer(mode='plain', when_used='json')+ def _serialize(self) -> Any:+ return {'ser': True}++ class Wrap(BaseModel):+ a: int+ b: int++ @model_serializer(mode='wrap', when_used='json')+ def _serialize(self, handler: SerializerFunctionWrapHandler) -> Any:+ return {'ser': True}++ for m in (Plain(a=1, b=2), Wrap(a=1, b=2)):+ assert m.model_dump(exclude={'b'}) == {'a': 1}+ assert m.model_dump(include={'a'}) == {'a': 1}+ assert m.model_dump(mode='json', exclude={'b'}) == {'ser': True}