Skip to content

🗑️ Deprecate const and unique_items in Field #1732

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 8 commits into
base: main
Choose a base branch
from
+60 −10
Open

🗑️ Deprecate const and unique_items in Field #1732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e87feed
Deprecate `const` parameter of `Field`
YuriiMotov Jan 29, 2026
81403a5
Deprecate `unique_items` parameter of `Field`
YuriiMotov Jan 29, 2026
5c0bba8
Merge branch 'main' into deprecate-const-and-unique_items-in-field
YuriiMotov Feb 20, 2026
2be6aee
Merge branch 'main' into deprecate-const-and-unique_items-in-field
YuriiMotov Apr 3, 2026
b3b44fe
Raise error instead of warning
YuriiMotov Aug 28, 2026
7d94001
Merge remote-tracking branch 'upstream/main' into deprecate-const-and…
YuriiMotov Aug 28, 2026
cd385bb
Merge remote-tracking branch 'upstream/main' into deprecate-const-and…
YuriiMotov Aug 28, 2026
065c3ba
🎨 Auto format
pr-push[bot] Aug 28, 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
50 changes: 40 additions & 10 deletions sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@
)
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"
)
MIN_ITEMS_DEPRECATION_MSG = (
"`min_items` is deprecated and will be removed, use `min_length` instead"
)
Expand Down Expand Up @@ -254,7 +258,10 @@ def Field(
description: str | None = None,
exclude: Set[int | str] | Mapping[int | str, Any] | Any = None,
include: Set[int | str] | Mapping[int | str, Any] | Any = None,
const: bool | None = None,
const: Annotated[
bool | None,
deprecated(CONST_DEPRECATION_MSG),
] = None,
gt: float | None = None,
ge: float | None = None,
lt: float | None = None,
Expand All @@ -270,7 +277,10 @@ def Field(
int | None,
deprecated(MAX_ITEMS_DEPRECATION_MSG),
] = None,
unique_items: bool | None = None,
unique_items: Annotated[
bool | None,
deprecated(UNIQUE_ITEMS_DEPRECATION_MSG),
] = None,
min_length: int | None = None,
max_length: int | None = None,
allow_mutation: bool = True,
Expand Down Expand Up @@ -303,7 +313,10 @@ def Field(
description: str | None = None,
exclude: Set[int | str] | Mapping[int | str, Any] | Any = None,
include: Set[int | str] | Mapping[int | str, Any] | Any = None,
const: bool | None = None,
const: Annotated[
bool | None,
deprecated(CONST_DEPRECATION_MSG),
] = None,
gt: float | None = None,
ge: float | None = None,
lt: float | None = None,
Expand All @@ -319,7 +332,10 @@ def Field(
int | None,
deprecated(MAX_ITEMS_DEPRECATION_MSG),
] = None,
unique_items: bool | None = None,
unique_items: Annotated[
bool | None,
deprecated(UNIQUE_ITEMS_DEPRECATION_MSG),
] = None,
min_length: int | None = None,
max_length: int | None = None,
allow_mutation: bool = True,
Expand Down Expand Up @@ -361,7 +377,10 @@ def Field(
description: str | None = None,
exclude: Set[int | str] | Mapping[int | str, Any] | Any = None,
include: Set[int | str] | Mapping[int | str, Any] | Any = None,
const: bool | None = None,
const: Annotated[
bool | None,
deprecated(CONST_DEPRECATION_MSG),
] = None,
gt: float | None = None,
ge: float | None = None,
lt: float | None = None,
Expand All @@ -377,7 +396,10 @@ def Field(
int | None,
deprecated(MAX_ITEMS_DEPRECATION_MSG),
] = None,
unique_items: bool | None = None,
unique_items: Annotated[
bool | None,
deprecated(UNIQUE_ITEMS_DEPRECATION_MSG),
] = None,
min_length: int | None = None,
max_length: int | None = None,
allow_mutation: bool = True,
Expand All @@ -400,7 +422,10 @@ def Field(
description: str | None = None,
exclude: Set[int | str] | Mapping[int | str, Any] | Any = None,
include: Set[int | str] | Mapping[int | str, Any] | Any = None,
const: bool | None = None,
const: Annotated[
bool | None,
deprecated(CONST_DEPRECATION_MSG),
] = None,
gt: float | None = None,
ge: float | None = None,
lt: float | None = None,
Expand All @@ -416,7 +441,10 @@ def Field(
int | None,
deprecated(MAX_ITEMS_DEPRECATION_MSG),
] = None,
unique_items: bool | None = None,
unique_items: Annotated[
bool | None,
deprecated(UNIQUE_ITEMS_DEPRECATION_MSG),
] = None,
min_length: int | None = None,
max_length: int | None = None,
allow_mutation: bool = True,
Expand All @@ -437,6 +465,10 @@ def Field(
) -> Any:
current_schema_extra = schema_extra or {}

if const is not None:
raise RuntimeError(CONST_DEPRECATION_MSG)
if unique_items is not None:
raise RuntimeError(UNIQUE_ITEMS_DEPRECATION_MSG)
if min_items is not None:
warnings.warn(MIN_ITEMS_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
if min_length is None:
Expand All @@ -455,15 +487,13 @@ def Field(
"description": description,
"exclude": exclude,
"include": include,
"const": const,
"gt": gt,
"ge": ge,
"lt": lt,
"le": le,
"multiple_of": multiple_of,
"max_digits": max_digits,
"decimal_places": decimal_places,
"unique_items": unique_items,
"min_length": min_length,
"max_length": max_length,
"allow_mutation": allow_mutation,
Expand Down
20 changes: 20 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 @@ -88,6 +88,26 @@ class Model(SQLModel):
assert "foo=" not in repr(instance)


def test_const_is_deprecated():
with pytest.raises(
RuntimeError,
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.raises(
RuntimeError,
match="`unique_items` is deprecated and doesn't work, use `set` type instead",
):

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


def test_min_items():
with pytest.warns(
DeprecationWarning,
Expand Down