Support exclude_if at field level #10961

andresliszt · 2024-11-24T17:01:41Z

Change Summary

Adds support for pydantic side exclude_if. This PR points to the pydantic-core version in the open PR added in the related issue.

Related issue number

pydantic/pydantic-core#1535

Checklist

The pull request title is a good summary of the changes - it will be used in the changelog
Unit tests for the changes exist
Tests pass on CI
Documentation reflects the changes where applicable
My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer: @sydney-runkle

andresliszt · 2024-11-24T17:03:17Z

please review

andresliszt · 2024-11-24T21:16:21Z

uv.lock

So committing (temporary) this file is necessary when building from an open PR on pydantic-core, right?

codspeed-hq · 2024-11-24T21:22:30Z

CodSpeed Performance Report

Merging #10961 will not alter performance

_{Comparing andresliszt:support/exclude-if-at-field (03c6313) with main (15f693a)}

Summary

✅ 45 untouched benchmarks

andresliszt · 2024-11-24T21:33:21Z

tests/test_fastapi.sh

@@ -11,7 +11,7 @@ git fetch --tags

 pip install -r requirements.txt
 # Install the version of pydantic from the current branch, not the released version used by fastapi
-pip uninstall -y pydantic
+pip uninstall -y pydantic pydantic-core # TODO: pydantic-core is temporal here
 cd .. && pip install . && cd fastapi


Had to add pydantic-core, I think this has to be here for installing pydantic-core from branch to work --- Do I keep it here?

This file is removed on main iirc, so should matter anymore 👍

github-actions · 2024-11-24T21:36:25Z

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
pydantic
fields.py
Project Total

_{This report was generated by python-coverage-comment-action}

emosenkis · 2025-02-10T06:15:40Z

It would be great if the callback could also receive a serialization context (my use case is excluding fields based on the context)

sydney-runkle · 2025-02-12T19:11:31Z

We'll be revisiting this before the v2.11 release 👍

joshorr · 2025-03-31T22:53:03Z

Curious what the status of this is. I am assuming it did not make it out in v2.11; do you know when it might come out? I've been looking forward to this for a while! 😃

andresliszt · 2025-04-02T23:34:42Z

Curious what the status of this is. I am assuming it did not make it out in v2.11; do you know when it might come out? I've been looking forward to this for a while! 😃

Curious too! @sydney-runkle Let me know if you guys still need this, to update the PR if necessary

lokhman · 2025-04-30T21:12:53Z

@andresliszt @sydney-runkle We (users) need it very much :) Let's push it forward!

Viicos · 2025-05-19T13:24:36Z

I'll get back on this shortly!

Viicos

Hi @andresliszt sorry for the delay. Are you willing to continue working on this? Left some comments, it is mostly in good shape (lets keep it at the field level for now, we can later improve this to be on model_dump() etc), but some relatively simple conflicts will need to be resolved.

Viicos · 2025-07-11T15:31:17Z

pydantic/fields.py

@@ -950,6 +961,7 @@ def Field(  # noqa: C901
        description: Human-readable description.
        examples: Example values for this field.
        exclude: Whether to exclude the field from the model serialization.
+        exclude_if: Callable that determines whether to exclude a field during serialization based on its value.


Suggested change

exclude_if: Callable that determines whether to exclude a field during serialization based on its value.

exclude_if: A callable that determines whether to exclude a field during serialization based on its value.

Viicos · 2025-07-11T15:34:30Z

pydantic/fields.py

@@ -784,6 +791,7 @@ def Field(
    description: str | None = _Unset,
    examples: list[Any] | None = _Unset,
    exclude: bool | None = _Unset,
+    exclude_if: Callable[[Any], bool] | None = _Unset,


For this overload (default set) and the one for default_factory set, we can reuse the type variable to get proper type checking:

exclude_if: Callable[[_T], bool] = _Unset

Viicos · 2025-07-11T15:40:58Z

tests/test_fastapi.sh

@@ -11,7 +11,7 @@ git fetch --tags

 pip install -r requirements.txt
 # Install the version of pydantic from the current branch, not the released version used by fastapi
-pip uninstall -y pydantic
+pip uninstall -y pydantic pydantic-core # TODO: pydantic-core is temporal here
 cd .. && pip install . && cd fastapi


This file is removed on main iirc, so should matter anymore 👍

Viicos · 2025-07-11T15:41:23Z

pydantic/fields.py

@@ -116,6 +117,7 @@ class FieldInfo(_repr.Representation):
        description: The description of the field.
        examples: List of examples of the field.
        exclude: Whether to exclude the field from the model serialization.
+        exclude_if: Callable that determines whether to exclude a field during serialization based on its value.


Suggested change

exclude_if: Callable that determines whether to exclude a field during serialization based on its value.

exclude_if: A callable that determines whether to exclude a field during serialization based on its value.

Viicos · 2025-07-11T15:45:17Z

pydantic/_internal/_generate_schema.py

@@ -1057,6 +1057,7 @@ def _generate_td_field_schema(
        return core_schema.typed_dict_field(
            common_field['schema'],
            required=False if not field_info.is_required() else required,
+            exclude_if=field_info.exclude_if,


Will need to be updated according to my pydantic-core PR review

andresliszt · 2025-07-14T10:58:47Z

Hi @andresliszt sorry for the delay. Are you willing to continue working on this? Left some comments, it is mostly in good shape (lets keep it at the field level for now, we can later improve this to be on model_dump() etc), but some relatively simple conflicts will need to be resolved.

Hello ! I commit to have it This week, best regards

Viicos · 2025-08-07T10:23:58Z

Hi @andresliszt, I co-authored a new PR with a couple more changes and documentation, which we'll merge soon. Thanks for the contribution!

github-actions bot added the relnotes-fix Used for bugfixes. label Nov 24, 2024

Support exclude_if at field level

537d0dd

andresliszt force-pushed the support/exclude-if-at-field branch from fd789eb to 537d0dd Compare November 24, 2024 17:03

pydantic-hooky bot added the ready for review label Nov 24, 2024

pydantic-hooky bot assigned sydney-runkle Nov 24, 2024

fmt and update uv lock

2700d6d

andresliszt commented Nov 24, 2024

View reviewed changes

update tmp fast api test installation

03c6313

andresliszt commented Nov 24, 2024

View reviewed changes

sydney-runkle mentioned this pull request Dec 30, 2024

v2.11 Roadmap 🚗 🗺️ #11194

Closed

sydney-runkle added relnotes-feature and removed relnotes-fix Used for bugfixes. labels Jan 8, 2025

joshorr mentioned this pull request Mar 31, 2025

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

Open

Viicos requested changes Jul 11, 2025

View reviewed changes

pydantic-hooky bot added awaiting author revision awaiting changes from the PR author and removed ready for review labels Jul 11, 2025

pydantic-hooky bot assigned andresliszt Jul 11, 2025

Viicos mentioned this pull request Jul 11, 2025

A new marker API #12056

Open

Viicos mentioned this pull request Aug 7, 2025

Add support for exclude_if at the field level #12141

Open

5 tasks

Viicos closed this Aug 7, 2025

	exclude_if: Callable that determines whether to exclude a field during serialization based on its value.
	exclude_if: A callable that determines whether to exclude a field during serialization based on its value.

Uh oh!

Support exclude_if at field level #10961

Support exclude_if at field level #10961

Conversation

andresliszt commented Nov 24, 2024 • edited by pydantic-hooky bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Summary

Related issue number

Checklist

Uh oh!

andresliszt commented Nov 24, 2024

Uh oh!

andresliszt Nov 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented Nov 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #10961 will not alter performance

Summary

Uh oh!

andresliszt Nov 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Viicos Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 24, 2024

Coverage report

Uh oh!

emosenkis commented Feb 10, 2025

Uh oh!

sydney-runkle commented Feb 12, 2025

Uh oh!

joshorr commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andresliszt commented Apr 2, 2025

Uh oh!

lokhman commented Apr 30, 2025

Uh oh!

Viicos commented May 19, 2025

Uh oh!

Viicos left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Viicos Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Viicos Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Viicos Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Viicos Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Viicos Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

andresliszt commented Jul 14, 2025

Uh oh!

Viicos commented Aug 7, 2025

Uh oh!

Uh oh!

andresliszt commented Nov 24, 2024 •

edited by pydantic-hooky bot

Loading

andresliszt Nov 24, 2024 •

edited

Loading

codspeed-hq bot commented Nov 24, 2024 •

edited

Loading

andresliszt Nov 24, 2024 •

edited

Loading

joshorr commented Mar 31, 2025 •

edited

Loading

Viicos left a comment •

edited

Loading