Backtestspydanticrun-20261007-130130#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 same 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 receives the caller's include/exclude instead of `IncludeExclude::empty()`. The `Ok((true, v))` path still clears include/exclude, since the user function is responsible for filtering. The behaviour of the two patches is the same across `to_python`, `json_key` and `serde_serialize`. The implementations differ only slightly. Patch A adds a new public `include_exclude()` accessor on `SerializationState` that clones the struct, then re-scopes the state with that clone. This is a redundant clone and re-scope that adds API surface. Patch B passes the existing `state` straight to the fallback serializer and needs no new accessor, which is simpler and more direct. Tests are where the patches differ most. Patch A's wrap test never calls `handler`, so it does not reproduce the issue's scenario of a wrap serializer that delegates. It covers neither `json-unless-none` nor field-level serializers, and its docstring is a leftover `"""<link>"""` placeholder. Patch B reproduces the issue exactly: a wrap serializer calling `handler(self)`, parametrized over both `json` and `json-unless-none`. It checks python and JSON modes, including `model_dump_json`, and adds a plain-mode test. It also adds a test for field-level Plain/WrapSerializer with nested include/exclude on lists and dicts, which exercises the same changed code path for non-model serializers. These tests would fail before the fix and pass after it, and they cover more of the affected behaviour. With correctness equal, Patch B wins on test quality and on slightly cleaner 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
7m 37s
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
113vs 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..03450b75 100644@@ -217,17 +217,20 @@ 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+ let state = &mut state.scoped_include_exclude(IncludeExclude::empty());+ self.return_serializer.to_python(v.bind(py), state)+ }+ // the function was not used (see `when_used`), so the fallback serializer+ // must still apply the caller's 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 +239,25 @@ 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+ 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 used (see `when_used`), so the fallback serializer+ // must still apply the caller's 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 +267,22 @@ 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+ let mut state = state.scoped_include_exclude(IncludeExclude::empty());+ self.return_serializer.serde_serialize(v.bind(py), serializer, &mut state)+ }+ // the function was not used (see `when_used`), so the fallback serializer+ // must still apply the caller's 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..316f8dda 100644@@ -544,6 +544,53 @@ 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):+ class Gated(BaseModel):+ a: int+ b: int++ @model_serializer(mode='wrap', when_used=when_used)+ def _serialize(self, handler: SerializerFunctionWrapHandler) -> object:+ 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}'+++def test_model_serializer_plain_when_used_json_respects_include_exclude():+ class Gated(BaseModel):+ a: int+ b: int++ @model_serializer(when_used='json')+ def _serialize(self) -> dict[str, int]:+ return {'a': self.a, 'b': self.b}++ m = Gated(a=1, b=2)+ assert m.model_dump(exclude={'b'}) == {'a': 1}+ assert m.model_dump(include={'a'}) == {'a': 1}+++@pytest.mark.parametrize('serializer_cls', [PlainSerializer, WrapSerializer])+def test_field_serializer_when_used_json_respects_nested_include_exclude(serializer_cls):+ if serializer_cls is PlainSerializer:+ ser = PlainSerializer(lambda v: v, when_used='json')+ else:+ ser = WrapSerializer(lambda v, handler: handler(v), when_used='json')++ class Model(BaseModel):+ items: Annotated[list[int], ser]+ mapping: Annotated[dict[str, int], ser]++ m = Model(items=[1, 2, 3], mapping={'x': 1, 'y': 2})+ assert m.model_dump(exclude={'items': {0}, 'mapping': {'x'}}) == {'items': [2, 3], 'mapping': {'y': 2}}+ assert m.model_dump(include={'items': {1}, 'mapping': {'y'}}) == {'items': [2], 'mapping': {'y': 2}}++ 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}