Skip to content

🗑️ Deprecate min_items and max_items parameters of Field #1731

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 1 commit into
base: main
Choose a base branch
from
Open

🗑️ Deprecate min_items and max_items parameters of Field #1731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
61 changes: 51 additions & 10 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,13 @@
]
OnDeleteType = Literal["CASCADE", "SET NULL", "RESTRICT"]

MIN_ITEMS_DEPRECATION_MSG = (
"`min_items` is deprecated and will be removed, use `min_length` instead"
)
MAX_ITEMS_DEPRECATION_MSG = (
"`max_items` is deprecated and will be removed, use `max_length` instead"
)


def __dataclass_transform__(
*,
Expand Down Expand Up @@ -221,8 +230,14 @@ def Field(
multiple_of: Optional[float] = None,
max_digits: Optional[int] = None,
decimal_places: Optional[int] = None,
min_items: Optional[int] = None,
max_items: Optional[int] = None,
min_items: Annotated[
Optional[int],
deprecated(MIN_ITEMS_DEPRECATION_MSG),
] = None,
max_items: Annotated[
Optional[int],
deprecated(MAX_ITEMS_DEPRECATION_MSG),
] = None,
unique_items: Optional[bool] = None,
min_length: Optional[int] = None,
max_length: Optional[int] = None,
Expand Down Expand Up @@ -264,8 +279,14 @@ def Field(
multiple_of: Optional[float] = None,
max_digits: Optional[int] = None,
decimal_places: Optional[int] = None,
min_items: Optional[int] = None,
max_items: Optional[int] = None,
min_items: Annotated[
Optional[int],
deprecated(MIN_ITEMS_DEPRECATION_MSG),
] = None,
max_items: Annotated[
Optional[int],
deprecated(MAX_ITEMS_DEPRECATION_MSG),
] = None,
unique_items: Optional[bool] = None,
min_length: Optional[int] = None,
max_length: Optional[int] = None,
Expand Down Expand Up @@ -316,8 +337,14 @@ def Field(
multiple_of: Optional[float] = None,
max_digits: Optional[int] = None,
decimal_places: Optional[int] = None,
min_items: Optional[int] = None,
max_items: Optional[int] = None,
min_items: Annotated[
Optional[int],
deprecated(MIN_ITEMS_DEPRECATION_MSG),
] = None,
max_items: Annotated[
Optional[int],
deprecated(MAX_ITEMS_DEPRECATION_MSG),
] = None,
unique_items: Optional[bool] = None,
min_length: Optional[int] = None,
max_length: Optional[int] = None,
Expand Down Expand Up @@ -349,8 +376,14 @@ def Field(
multiple_of: Optional[float] = None,
max_digits: Optional[int] = None,
decimal_places: Optional[int] = None,
min_items: Optional[int] = None,
max_items: Optional[int] = None,
min_items: Annotated[
Optional[int],
deprecated(MIN_ITEMS_DEPRECATION_MSG),
] = None,
max_items: Annotated[
Optional[int],
deprecated(MAX_ITEMS_DEPRECATION_MSG),
] = None,
unique_items: Optional[bool] = None,
min_length: Optional[int] = None,
max_length: Optional[int] = None,
Expand All @@ -371,6 +404,16 @@ def Field(
schema_extra: Optional[dict[str, Any]] = None,
) -> Any:
current_schema_extra = schema_extra or {}

if min_items is not None:
warnings.warn(MIN_ITEMS_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
if min_length is None:
min_length = min_items
if max_items is not None:
warnings.warn(MAX_ITEMS_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
if max_length is None:
max_length = max_items

# 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 All @@ -388,8 +431,6 @@ def Field(
"multiple_of": multiple_of,
"max_digits": max_digits,
"decimal_places": decimal_places,
"min_items": min_items,
"max_items": max_items,
"unique_items": unique_items,
"min_length": min_length,
"max_length": max_length,
Expand Down
34 changes: 34 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,37 @@ class Model(SQLModel):

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


def test_min_items():
with pytest.warns(
DeprecationWarning,
match="`min_items` is deprecated and will be removed, use `min_length` instead",
):

class Model(SQLModel):
items: list[int] = Field(min_items=2)

Model(items=[1, 2])

with pytest.raises(ValidationError) as exc_info:
Model(items=[1])
assert len(exc_info.value.errors()) == 1
assert exc_info.value.errors()[0]["type"] == "too_short"


def test_max_items():
with pytest.warns(
DeprecationWarning,
match="`max_items` is deprecated and will be removed, use `max_length` instead",
):

class Model(SQLModel):
items: list[int] = Field(max_items=2)

Model(items=[1, 2])

with pytest.raises(ValidationError) as exc_info:
Model(items=[1, 2, 3])
assert len(exc_info.value.errors()) == 1
assert exc_info.value.errors()[0]["type"] == "too_long"