Skip to content

🏷️ Fix typing for exclude parameter of Field, deprecate include parameter #1724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YuriiMotov wants to merge 6 commits into
base: main
Choose a base branch
from
+51 −8
Open

🏷️ Fix typing for exclude parameter of Field, deprecate include parameter #1724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2863b52
Update type annotation of `exclude` parameter to `Field`
YuriiMotov Jan 28, 2026
b2c1f53
Add test for Field `exclude` parameter
YuriiMotov Jan 28, 2026
f46fc69
Remove outdated `include` parameter from `Field`
YuriiMotov Jan 28, 2026
8467dff
Revert "Remove outdated `include` parameter from `Field`"
YuriiMotov Feb 3, 2026
b1f6ff1
Deprecate `include`parameter of `Field`
YuriiMotov Feb 3, 2026
bd8e3b8
🎨 Auto format
github-actions[bot] Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 28 additions & 8 deletions sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import builtins
import ipaddress
import uuid
import warnings
import weakref
from collections.abc import Mapping, Sequence, Set
from datetime import date, datetime, time, timedelta
Expand All @@ -11,6 +12,7 @@
from pathlib import Path
from typing import (
TYPE_CHECKING,
Annotated,
Any,
Callable,
ClassVar,
Expand Down Expand Up @@ -89,6 +91,8 @@
]
OnDeleteType = Literal["CASCADE", "SET NULL", "RESTRICT"]

INCLUDE_DEPRECATION_MSG = "`include` is deprecated and does nothing. It will be removed, use `exclude` instead"


def __dataclass_transform__(
*,
Expand Down Expand Up @@ -211,8 +215,11 @@ def Field(
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
exclude: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
include: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
exclude: Union[bool, None] = None,
include: Annotated[
Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any],
deprecated(INCLUDE_DEPRECATION_MSG),
] = None,
const: Optional[bool] = None,
gt: Optional[float] = None,
ge: Optional[float] = None,
Expand Down Expand Up @@ -254,8 +261,11 @@ def Field(
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
exclude: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
include: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
exclude: Union[bool, None] = None,
include: Annotated[
Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any],
deprecated(INCLUDE_DEPRECATION_MSG),
] = None,
const: Optional[bool] = None,
gt: Optional[float] = None,
ge: Optional[float] = None,
Expand Down Expand Up @@ -306,8 +316,11 @@ def Field(
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
exclude: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
include: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
exclude: Union[bool, None] = None,
include: Annotated[
Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any],
deprecated(INCLUDE_DEPRECATION_MSG),
] = None,
const: Optional[bool] = None,
gt: Optional[float] = None,
ge: Optional[float] = None,
Expand Down Expand Up @@ -339,8 +352,11 @@ def Field(
serialization_alias: Optional[str] = None,
title: Optional[str] = None,
description: Optional[str] = None,
exclude: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
include: Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any] = None,
exclude: Union[bool, None] = None,
include: Annotated[
Union[Set[Union[int, str]], Mapping[Union[int, str], Any], Any],
deprecated(INCLUDE_DEPRECATION_MSG),
] = None,
const: Optional[bool] = None,
gt: Optional[float] = None,
ge: Optional[float] = None,
Expand Down Expand Up @@ -371,6 +387,10 @@ def Field(
schema_extra: Optional[dict[str, Any]] = None,
) -> Any:
current_schema_extra = schema_extra or {}

if include is not None:
warnings.warn(INCLUDE_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)

# Extract possible alias settings from schema_extra so we can control precedence
schema_validation_alias = current_schema_extra.pop("validation_alias", None)
schema_serialization_alias = current_schema_extra.pop("serialization_alias", None)
Expand Down
23 changes: 23 additions & 0 deletions tests/test_pydantic/test_field.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,26 @@ class Model(SQLModel):

instance = Model(id=123, foo="bar")
assert "foo=" not in repr(instance)


def test_exclude():
class Model(SQLModel):
id: int
name: str
value: int = Field(exclude=True)

instance = Model(id=1, name="test", value=42)
dict_representation = instance.model_dump()
assert "id" in dict_representation
assert "name" in dict_representation
assert "value" not in dict_representation


def test_include_is_deprecated():
with pytest.warns(
DeprecationWarning,
match="`include` is deprecated and does nothing. It will be removed, use `exclude` instead",
):

class Model(SQLModel):
values: list[int] = Field(include=True)