🗑️ Deprecate min_items and max_items parameters of Field (#1731)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

Author: YuriiMotov

sqlmodel/main.py

@@ -3,6 +3,7 @@
 import builtins
 import ipaddress
 import uuid
+import warnings
 from collections.abc import Callable, Mapping, Sequence, Set
 from dataclasses import dataclass
 from datetime import date, datetime, time, timedelta
@@ -11,6 +12,7 @@
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
+    Annotated,
     Any,
     ClassVar,
     Literal,
@@ -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__(
     *,
@@ -253,8 +262,14 @@ def Field(
     multiple_of: float | None = None,
     max_digits: int | None = None,
     decimal_places: int | None = None,
-    min_items: int | None = None,
-    max_items: int | None = None,
+    min_items: Annotated[
+        int | None,
+        deprecated(MIN_ITEMS_DEPRECATION_MSG),
+    ] = None,
+    max_items: Annotated[
+        int | None,
+        deprecated(MAX_ITEMS_DEPRECATION_MSG),
+    ] = None,
     unique_items: bool | None = None,
     min_length: int | None = None,
     max_length: int | None = None,
@@ -296,8 +311,14 @@ def Field(
     multiple_of: float | None = None,
     max_digits: int | None = None,
     decimal_places: int | None = None,
-    min_items: int | None = None,
-    max_items: int | None = None,
+    min_items: Annotated[
+        int | None,
+        deprecated(MIN_ITEMS_DEPRECATION_MSG),
+    ] = None,
+    max_items: Annotated[
+        int | None,
+        deprecated(MAX_ITEMS_DEPRECATION_MSG),
+    ] = None,
     unique_items: bool | None = None,
     min_length: int | None = None,
     max_length: int | None = None,
@@ -348,8 +369,14 @@ def Field(
     multiple_of: float | None = None,
     max_digits: int | None = None,
     decimal_places: int | None = None,
-    min_items: int | None = None,
-    max_items: int | None = None,
+    min_items: Annotated[
+        int | None,
+        deprecated(MIN_ITEMS_DEPRECATION_MSG),
+    ] = None,
+    max_items: Annotated[
+        int | None,
+        deprecated(MAX_ITEMS_DEPRECATION_MSG),
+    ] = None,
     unique_items: bool | None = None,
     min_length: int | None = None,
     max_length: int | None = None,
@@ -381,8 +408,14 @@ def Field(
     multiple_of: float | None = None,
     max_digits: int | None = None,
     decimal_places: int | None = None,
-    min_items: int | None = None,
-    max_items: int | None = None,
+    min_items: Annotated[
+        int | None,
+        deprecated(MIN_ITEMS_DEPRECATION_MSG),
+    ] = None,
+    max_items: Annotated[
+        int | None,
+        deprecated(MAX_ITEMS_DEPRECATION_MSG),
+    ] = None,
     unique_items: bool | None = None,
     min_length: int | None = None,
     max_length: int | None = None,
@@ -403,6 +436,16 @@ def Field(
     schema_extra: dict[str, Any] | None = 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)
@@ -420,8 +463,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,

tests/test_pydantic/test_field.py

@@ -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"