Skip to content

🏷️ Allow values that support SupportsGt (and others) protocol for gt, ge, lt and le in Field #1730

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

🏷️ Allow values that support SupportsGt (and others) protocol for gt, ge, lt and le in Field #1730

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
33 changes: 17 additions & 16 deletions sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
overload,
)

import annotated_types
from pydantic import BaseModel, EmailStr
from pydantic.fields import FieldInfo as PydanticFieldInfo
from sqlalchemy import (
Expand Down Expand Up @@ -214,10 +215,10 @@ def Field(
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,
gt: Optional[float] = None,
ge: Optional[float] = None,
lt: Optional[float] = None,
le: Optional[float] = None,
gt: Optional[annotated_types.SupportsGt] = None,
ge: Optional[annotated_types.SupportsGe] = None,
lt: Optional[annotated_types.SupportsLt] = None,
le: Optional[annotated_types.SupportsLe] = None,
multiple_of: Optional[float] = None,
max_digits: Optional[int] = None,
decimal_places: Optional[int] = None,
Expand Down Expand Up @@ -257,10 +258,10 @@ def Field(
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,
gt: Optional[float] = None,
ge: Optional[float] = None,
lt: Optional[float] = None,
le: Optional[float] = None,
gt: Optional[annotated_types.SupportsGt] = None,
ge: Optional[annotated_types.SupportsGe] = None,
lt: Optional[annotated_types.SupportsLt] = None,
le: Optional[annotated_types.SupportsLe] = None,
multiple_of: Optional[float] = None,
max_digits: Optional[int] = None,
decimal_places: Optional[int] = None,
Expand Down Expand Up @@ -309,10 +310,10 @@ def Field(
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,
gt: Optional[float] = None,
ge: Optional[float] = None,
lt: Optional[float] = None,
le: Optional[float] = None,
gt: Optional[annotated_types.SupportsGt] = None,
ge: Optional[annotated_types.SupportsGe] = None,
lt: Optional[annotated_types.SupportsLt] = None,
le: Optional[annotated_types.SupportsLe] = None,
multiple_of: Optional[float] = None,
max_digits: Optional[int] = None,
decimal_places: Optional[int] = None,
Expand Down Expand Up @@ -342,10 +343,10 @@ def Field(
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,
gt: Optional[float] = None,
ge: Optional[float] = None,
lt: Optional[float] = None,
le: Optional[float] = None,
gt: Optional[annotated_types.SupportsGt] = None,
ge: Optional[annotated_types.SupportsGe] = None,
lt: Optional[annotated_types.SupportsLt] = None,
le: Optional[annotated_types.SupportsLe] = None,
multiple_of: Optional[float] = None,
max_digits: Optional[int] = None,
decimal_places: Optional[int] = None,
Expand Down
80 changes: 80 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,83 @@ class Model(SQLModel):

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


def test_gt():
class Model(SQLModel):
int_value: int = Field(gt=10)
tuple_value: tuple[int, int] = Field(gt=(1, 2))

Model(int_value=11, tuple_value=(1, 3))

with pytest.raises(ValidationError) as exc_info:
Model(int_value=10, tuple_value=(1, 3))
assert len(exc_info.value.errors()) == 1
assert exc_info.value.errors()[0]["type"] == "greater_than"
assert exc_info.value.errors()[0]["loc"] == ("int_value",)

with pytest.raises(ValidationError) as exc_info_2:
Model(int_value=11, tuple_value=(1, 2))
assert len(exc_info_2.value.errors()) == 1
assert exc_info_2.value.errors()[0]["type"] == "greater_than"
assert exc_info_2.value.errors()[0]["loc"] == ("tuple_value",)


def test_ge():
class Model(SQLModel):
int_value: int = Field(ge=10)
tuple_value: tuple[int, int] = Field(ge=(1, 2))

Model(int_value=10, tuple_value=(1, 2))

with pytest.raises(ValidationError) as exc_info:
Model(int_value=9, tuple_value=(1, 2))
assert len(exc_info.value.errors()) == 1
assert exc_info.value.errors()[0]["type"] == "greater_than_equal"
assert exc_info.value.errors()[0]["loc"] == ("int_value",)

with pytest.raises(ValidationError) as exc_info_2:
Model(int_value=10, tuple_value=(1, 1))
assert len(exc_info_2.value.errors()) == 1
assert exc_info_2.value.errors()[0]["type"] == "greater_than_equal"
assert exc_info_2.value.errors()[0]["loc"] == ("tuple_value",)


def test_lt():
class Model(SQLModel):
int_value: int = Field(lt=10)
tuple_value: tuple[int, int] = Field(lt=(1, 2))

Model(int_value=9, tuple_value=(1, 1))

with pytest.raises(ValidationError) as exc_info:
Model(int_value=10, tuple_value=(1, 1))
assert len(exc_info.value.errors()) == 1
assert exc_info.value.errors()[0]["type"] == "less_than"
assert exc_info.value.errors()[0]["loc"] == ("int_value",)

with pytest.raises(ValidationError) as exc_info_2:
Model(int_value=9, tuple_value=(1, 2))
assert len(exc_info_2.value.errors()) == 1
assert exc_info_2.value.errors()[0]["type"] == "less_than"
assert exc_info_2.value.errors()[0]["loc"] == ("tuple_value",)


def test_le():
class Model(SQLModel):
int_value: int = Field(le=10)
tuple_value: tuple[int, int] = Field(le=(1, 2))

Model(int_value=10, tuple_value=(1, 2))

with pytest.raises(ValidationError) as exc_info:
Model(int_value=11, tuple_value=(1, 2))
assert len(exc_info.value.errors()) == 1
assert exc_info.value.errors()[0]["type"] == "less_than_equal"
assert exc_info.value.errors()[0]["loc"] == ("int_value",)

with pytest.raises(ValidationError) as exc_info_2:
Model(int_value=10, tuple_value=(1, 3))
assert len(exc_info_2.value.errors()) == 1
assert exc_info_2.value.errors()[0]["type"] == "less_than_equal"
assert exc_info_2.value.errors()[0]["loc"] == ("tuple_value",)