diff --git a/sqlmodel/main.py b/sqlmodel/main.py index 84478f24cf..1fec1ac129 100644 --- a/sqlmodel/main.py +++ b/sqlmodel/main.py @@ -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 @@ -11,6 +12,7 @@ from pathlib import Path from typing import ( TYPE_CHECKING, + Annotated, Any, Callable, ClassVar, @@ -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__( *, @@ -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, @@ -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, @@ -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, @@ -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, @@ -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) diff --git a/tests/test_pydantic/test_field.py b/tests/test_pydantic/test_field.py index 140b02fd9b..14dceb190b 100644 --- a/tests/test_pydantic/test_field.py +++ b/tests/test_pydantic/test_field.py @@ -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)