This PR aims to add support for excluding field from serialization based on condition. As@davidhewitt suggested I added a newexclude_if argument at field level, which is callable that checks if the field value meets a condition. However, in this pydanticissue David suggested to useskip_serializing_if from Rust's serde, I could't find a way to use it due that serialization is being doing a loop for each field usingserialize_map.

Related issue number

pydantic/pydantic#10728

Checklist

Unit tests for the changes exist
Documentation reflects the changes where applicable
Pydantic tests pass with thispydantic-core (except for expected changes)
My PR is ready to review,please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer:@sydney-runkle

Copy link

codecovbot commentedNov 8, 2024•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report?Let us know!

Copy link

Author

andresliszt commentedNov 8, 2024

please review

pydantic-hookybot added the ready for review label

Nov 8, 2024

pydantic-hookybot assignedsydney-runkle

Nov 8, 2024

Copy link

codspeed-hqbot commentedNov 8, 2024•
edited
Loading

CodSpeed Performance Report

Merging#1535 willnot alter performance

_{Comparingandresliszt:support/exclude-if-at-field-level (a836948) withmain (83ff1cf)}

Summary

✅ 155 untouched benchmarks

andresliszt commented

Nov 8, 2024

View reviewed changes

src/serializers/fields.rs Outdated

		serializer: &CombinedSerializer,
		) -> PyResult<bool> {
		let py = value.py();

Copy link

Author

andreslisztNov 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

think this should be called only if any condition is met, right? inside theif

Copy link

Contributor

sydney-runkleNov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think we should probably handle this outside of theexclude_default function as to decouple them for readability. We don't coupleexclude_default withexclude_none orexclude_unset, so I think we should retain separation here as well!

Copy link

Contributor

sydney-runkle commentedNov 12, 2024

Super exciting! Will give this a thorough review soon. Working on getting v2.10 out, and this will be included in v2.11 :)

sydney-runkle reviewed

Nov 19, 2024

View reviewed changes

Copy link

Contributor

sydney-runkle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Would love to see an implementation on thepydantic side as well - you can point to this branch.

Looks like a great start. I'm impressed with how simple this is going to be!

src/serializers/fields.rs Outdated

		serializer: &CombinedSerializer,
		) -> PyResult<bool> {
		let py = value.py();

Copy link

Contributor

sydney-runkleNov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Copy link

Contributor

sydney-runkle commentedNov 19, 2024

I would anticipate that folks might want to set this at themodel_dump level as well, and I think we should probably support that too, given that's where the otherexclude_X specs live.

Copy link

Author

andresliszt commentedNov 19, 2024

Would love to see an implementation on thepydantic side as well - you can point to this branch.
Looks like a great start. I'm impressed with how simple this is going to be!

Hello@sydney-runkle ! How do you do the implementation inpydantic when you need apydantic-core feature? First create a release ofpydantic-core and then use it inpydantic? In this case are you requesting to create a PR inpydantic pointing to this branch to see what it looks like, right?

Copy link

Author

andresliszt commentedNov 19, 2024

I would anticipate that folks might want to set this at themodel_dump level as well, and I think we should probably support that too, given that's where the otherexclude_X specs live.

I'm curious how the callable should work in themodel_dump, are you thinking in a callable with one argumentCallable[[Any], bool] to be applied in all fields, for example:

classModel(BaseModel):foo:strbar:list[str]foobaz:int>>>Model(foo="",bar= [],foobaz=1).model_dump(exclude_if=lambdafield:notfield){"foobaz":1}

Copy link

Contributor

sydney-runkle commentedNov 22, 2024

? In this case are you requesting to create a PR in pydantic pointing to this branch to see what it looks like, right?

Yes, exactly this! Once we merge, we'll include in a minorpydantic-core release, then we can bump thepydantic-core version officially on yourpydantic PR and merge that one.

It's just helpful to see the implementation on both sides before we merge thepydantic-core one.

Copy link

Contributor

sydney-runkle commentedNov 22, 2024

I'm curious how the callable should work in the model_dump, are you thinking in a callable with one argument Callable[[Any], bool] to be applied in all fields

Yes, exactly this. That being said, I chatted with the team, and we decided that introducing this at the field level first makes sense, and we can follow with other config / runtime specs later.

andresliszt added3 commits

November 24, 2024 11:47

Support exclude_if callable at field level

66da277

separate exclude functions

68955e6

fmt

b225197

andresliszt force-pushed thesupport/exclude-if-at-field-level branch fromd7d7d0e tob225197Compare

November 24, 2024 14:52

andresliszt added3 commits

November 24, 2024 11:56

remove unused

a7d272b

Update tests

2ac82ca

update test

a836948

andresliszt mentioned this pull request

Nov 24, 2024

Support exclude_if at field levelpydantic/pydantic#10961

Open

5 tasks

Copy link

Author

andresliszt commentedNov 24, 2024

Alright,@sydney-runkle I created a PR pointing to this branch!

joshorr mentioned this pull request

Nov 28, 2024

computed_field with MissingType in return type: PydanticSerializationError: Unable to serialize unknown type: <MissingType>joshorr/pydantic-partials#28

Open

Copy link

Kevin-Mc-Callister commentedMar 3, 2025

Any news on this?

Copy link

joshorr commentedMar 31, 2025•
edited
Loading

Super exciting! Will give this a thorough review soon. Working on getting v2.10 out, and this will be included in v2.11 :)

@sydney-runkle It sounds like this feature did not get out in v2.11? Any news on when it might come out?

Viicos requested changes

Jul 11, 2025

View reviewed changes

python/pydantic_core/core_schema.py

		@@ -2817,7 +2817,8 @@ class TypedDictField(TypedDict, total=False):
		validation_alias: Union[str, List[Union[str, int]], List[List[Union[str, int]]]]
		serialization_alias: str
		serialization_exclude: bool # default: False
		metadata: Dict[str, Any]
		exclude_if: Callable[[Any], bool] # default None

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if:Callable[[Any],bool]# default None
	serialization_exclude_if:Callable[[Any],bool]# default None

python/pydantic_core/core_schema.py

		@@ -2827,7 +2828,8 @@ def typed_dict_field(
		validation_alias: str \| list[str \| int] \| list[list[str \| int]] \| None = None,
		serialization_alias: str \| None = None,
		serialization_exclude: bool \| None = None,
		metadata: Dict[str, Any] \| None = None,
		exclude_if: Callable[[Any], bool] \| None = None,

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if:Callable[[Any],bool]\|None=None,
	serialization_exclude_if:Callable[[Any],bool]\|None=None,

python/pydantic_core/core_schema.py

		@@ -2844,6 +2846,7 @@ def typed_dict_field(
		validation_alias: The alias(es) to use to find the field in the validation data
		serialization_alias: The alias to use as a key when serializing
		serialization_exclude: Whether to exclude the field when serializing
		exclude_if: Callable that determines whether to exclude a field during serialization based on its value.

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if:Callablethatdetermineswhethertoexcludeafieldduringserializationbasedonitsvalue.
	serialization_exclude_if:Acallablethatdetermineswhethertoexcludethefieldwhenserializingbasedonitsvalue.

python/pydantic_core/core_schema.py

		@@ -2853,6 +2856,7 @@ def typed_dict_field(
		validation_alias=validation_alias,
		serialization_alias=serialization_alias,
		serialization_exclude=serialization_exclude,
		exclude_if=exclude_if,

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if=exclude_if,
	serialization_exclude_if=serialization_exclude_if,

python/pydantic_core/core_schema.py

		@@ -2943,6 +2947,7 @@ class ModelField(TypedDict, total=False):
		validation_alias: Union[str, List[Union[str, int]], List[List[Union[str, int]]]]
		serialization_alias: str
		serialization_exclude: bool # default: False
		exclude_if: Callable[[Any], bool] # default: None

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if:Callable[[Any],bool]# default: None
	serialization_exclude_if:Callable[[Any],bool]# default: None

python/pydantic_core/core_schema.py

		@@ -3171,7 +3179,8 @@ class DataclassField(TypedDict, total=False):
		validation_alias: Union[str, List[Union[str, int]], List[List[Union[str, int]]]]
		serialization_alias: str
		serialization_exclude: bool # default: False
		metadata: Dict[str, Any]
		exclude_if: Callable[[Any], bool] # default: None

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if:Callable[[Any],bool]# default: None
	serialization_exclude_if:Callable[[Any],bool]# default: None

python/pydantic_core/core_schema.py

		@@ -3184,7 +3193,8 @@ def dataclass_field(
		validation_alias: str \| list[str \| int] \| list[list[str \| int]] \| None = None,
		serialization_alias: str \| None = None,
		serialization_exclude: bool \| None = None,
		metadata: Dict[str, Any] \| None = None,
		exclude_if: Callable[[Any], bool] \| None = None,

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if:Callable[[Any],bool]\|None=None,
	serialization_exclude_if:Callable[[Any],bool]\|None=None,

python/pydantic_core/core_schema.py

		@@ -3210,6 +3220,7 @@ def dataclass_field(
		validation_alias: The alias(es) to use to find the field in the validation data
		serialization_alias: The alias to use as a key when serializing
		serialization_exclude: Whether to exclude the field when serializing
		exclude_if: Callable that determines whether to exclude a field during serialization based on its value.

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if:Callablethatdetermineswhethertoexcludeafieldduringserializationbasedonitsvalue.
	serialization_exclude_if:Acallablethatdetermineswhethertoexcludethefieldwhenserializingbasedonitsvalue.

python/pydantic_core/core_schema.py

		@@ -3223,6 +3234,7 @@ def dataclass_field(
		validation_alias=validation_alias,
		serialization_alias=serialization_alias,
		serialization_exclude=serialization_exclude,
		exclude_if=exclude_if,

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	exclude_if=exclude_if,
	serialization_exclude_if=serialization_exclude_if,

src/serializers/fields.rs

		@@ -80,6 +95,7 @@ fn exclude_default(value: &Bound<'_, PyAny>, extra: &Extra, serializer: &Combine
		}
		}
		}
		// If neither condition is met, do not exclude the field

Copy link

Member

ViicosJul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Lets avoid diff noise:

Suggested change

// If neither condition is met, do not exclude the field

Viicos changed the title~~Support exclude_if callable at field level~~Add option to exclude a field using a callable level

Jul 11, 2025

Viicos changed the title~~Add option to exclude a field using a callable level~~Add option to exclude a field using a callable

Jul 11, 2025

Labels

ready for review

5 participants

		@@ -2827,7 +2828,8 @@ def typed_dict_field(
		validation_alias: str \| list[str \| int] \| list[list[str \| int]] \| None = None,
		serialization_alias: str \| None = None,
		serialization_exclude: bool \| None = None,
		metadata: Dict[str, Any] \| None = None,
		exclude_if: Callable[[Any], bool] \| None = None,

		@@ -3184,7 +3193,8 @@ def dataclass_field(
		validation_alias: str \| list[str \| int] \| list[list[str \| int]] \| None = None,
		serialization_alias: str \| None = None,
		serialization_exclude: bool \| None = None,
		metadata: Dict[str, Any] \| None = None,
		exclude_if: Callable[[Any], bool] \| None = None,

Movatterモバイル変換

Add option to exclude a field using a callable#1535

Are you sure you want to change the base?

Add option to exclude a field using a callable#1535

Uh oh!

Conversation

andresliszt commentedNov 8, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Change Summary

Related issue number

Checklist

Uh oh!

codecovbot commentedNov 8, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

andresliszt commentedNov 8, 2024

Uh oh!

codspeed-hqbot commentedNov 8, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Merging#1535 willnot alter performance

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sydney-runkle commentedNov 12, 2024

Uh oh!

sydney-runkle left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sydney-runkle commentedNov 19, 2024

Uh oh!

andresliszt commentedNov 19, 2024

Uh oh!

andresliszt commentedNov 19, 2024

Uh oh!

sydney-runkle commentedNov 22, 2024

Uh oh!

sydney-runkle commentedNov 22, 2024

Uh oh!

andresliszt commentedNov 24, 2024

Uh oh!

Kevin-Mc-Callister commentedMar 3, 2025

Uh oh!

joshorr commentedMar 31, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andresliszt commentedNov 8, 2024•
edited
Loading

codecovbot commentedNov 8, 2024•
edited
Loading

codspeed-hqbot commentedNov 8, 2024•
edited
Loading

joshorr commentedMar 31, 2025•
edited
Loading