diff --git a/sqlmodel/main.py b/sqlmodel/main.py index 84478f24cf..388c45a388 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,11 @@ ] OnDeleteType = Literal["CASCADE", "SET NULL", "RESTRICT"] +CONST_DEPRECATION_MSG = "`const` is deprecated and doesn't work, use `Literal` instead" +UNIQUE_ITEMS_DEPRECATION_MSG = ( + "`unique_items` is deprecated and doesn't work, use `set` type instead" +) + def __dataclass_transform__( *, @@ -213,7 +220,10 @@ def Field( 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, - const: Optional[bool] = None, + const: Annotated[ + Optional[bool], + deprecated(CONST_DEPRECATION_MSG), + ] = None, gt: Optional[float] = None, ge: Optional[float] = None, lt: Optional[float] = None, @@ -223,7 +233,10 @@ def Field( decimal_places: Optional[int] = None, min_items: Optional[int] = None, max_items: Optional[int] = None, - unique_items: Optional[bool] = None, + unique_items: Annotated[ + Optional[bool], + deprecated(UNIQUE_ITEMS_DEPRECATION_MSG), + ] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, allow_mutation: bool = True, @@ -256,7 +269,10 @@ def Field( 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, - const: Optional[bool] = None, + const: Annotated[ + Optional[bool], + deprecated(CONST_DEPRECATION_MSG), + ] = None, gt: Optional[float] = None, ge: Optional[float] = None, lt: Optional[float] = None, @@ -266,7 +282,10 @@ def Field( decimal_places: Optional[int] = None, min_items: Optional[int] = None, max_items: Optional[int] = None, - unique_items: Optional[bool] = None, + unique_items: Annotated[ + Optional[bool], + deprecated(UNIQUE_ITEMS_DEPRECATION_MSG), + ] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, allow_mutation: bool = True, @@ -308,7 +327,10 @@ def Field( 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, - const: Optional[bool] = None, + const: Annotated[ + Optional[bool], + deprecated(CONST_DEPRECATION_MSG), + ] = None, gt: Optional[float] = None, ge: Optional[float] = None, lt: Optional[float] = None, @@ -318,7 +340,10 @@ def Field( decimal_places: Optional[int] = None, min_items: Optional[int] = None, max_items: Optional[int] = None, - unique_items: Optional[bool] = None, + unique_items: Annotated[ + Optional[bool], + deprecated(UNIQUE_ITEMS_DEPRECATION_MSG), + ] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, allow_mutation: bool = True, @@ -341,7 +366,10 @@ def Field( 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, - const: Optional[bool] = None, + const: Annotated[ + Optional[bool], + deprecated(CONST_DEPRECATION_MSG), + ] = None, gt: Optional[float] = None, ge: Optional[float] = None, lt: Optional[float] = None, @@ -351,7 +379,10 @@ def Field( decimal_places: Optional[int] = None, min_items: Optional[int] = None, max_items: Optional[int] = None, - unique_items: Optional[bool] = None, + unique_items: Annotated[ + Optional[bool], + deprecated(UNIQUE_ITEMS_DEPRECATION_MSG), + ] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, allow_mutation: bool = True, @@ -371,6 +402,12 @@ def Field( schema_extra: Optional[dict[str, Any]] = None, ) -> Any: current_schema_extra = schema_extra or {} + + if const is not None: + warnings.warn(CONST_DEPRECATION_MSG, DeprecationWarning, stacklevel=2) + if unique_items is not None: + warnings.warn(UNIQUE_ITEMS_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) @@ -380,7 +417,6 @@ def Field( "description": description, "exclude": exclude, "include": include, - "const": const, "gt": gt, "ge": ge, "lt": lt, @@ -390,7 +426,6 @@ def Field( "decimal_places": decimal_places, "min_items": min_items, "max_items": max_items, - "unique_items": unique_items, "min_length": min_length, "max_length": max_length, "allow_mutation": allow_mutation, diff --git a/tests/test_pydantic/test_field.py b/tests/test_pydantic/test_field.py index 140b02fd9b..0608abe660 100644 --- a/tests/test_pydantic/test_field.py +++ b/tests/test_pydantic/test_field.py @@ -54,3 +54,23 @@ class Model(SQLModel): instance = Model(id=123, foo="bar") assert "foo=" not in repr(instance) + + +def test_const_is_deprecated(): + with pytest.warns( + DeprecationWarning, + match="`const` is deprecated and doesn't work, use `Literal` instead", + ): + + class Model(SQLModel): + int_value: int = Field(default=10, const=True) + + +def test_unique_items_is_deprecated(): + with pytest.warns( + DeprecationWarning, + match="`unique_items` is deprecated and doesn't work, use `set` type instead", + ): + + class Model(SQLModel): + values: list[int] = Field(unique_items=True)