Coverage for tests / test_pydantic / test_field.py: 99%

1from decimal import Decimal 9 ctx1stuvwxyzA

2from typing import Annotated, Any, Literal 9 ctx1stuvwxyzA

3 

4import pytest 9 ctx1stuvwxyzA

5from pydantic import ValidationError 9 ctx1stuvwxyzA

6from sqlmodel import Discriminator, Field, SQLModel, Tag 9 ctx1stuvwxyzA

7 

8 

9def test_decimal(): 9 ctx1stuvwxyzA

10 class Model(SQLModel): 9 ctx1BCDEFGHIJ

11 dec: Decimal = Field(max_digits=4, decimal_places=2) 9 ctx1BCDEFGHIJ

12 

13 Model(dec=Decimal("3.14")) 9 ctx1BCDEFGHIJ

14 Model(dec=Decimal("69.42")) 9 ctx1BCDEFGHIJ

15 

16 with pytest.raises(ValidationError): 9 ctx1BCDEFGHIJ

17 Model(dec=Decimal("3.142")) 9 ctx1BCDEFGHIJ

18 with pytest.raises(ValidationError): 9 ctx1BCDEFGHIJ

19 Model(dec=Decimal("0.069")) 9 ctx1BCDEFGHIJ

20 with pytest.raises(ValidationError): 9 ctx1BCDEFGHIJ

21 Model(dec=Decimal("420")) 9 ctx1BCDEFGHIJ

22 

23 

24def test_discriminator(): 9 ctx1stuvwxyzA

25 # Example adapted from 

26 # [Pydantic docs](https://pydantic-docs.helpmanual.io/usage/types/#discriminated-unions-aka-tagged-unions): 

27 

28 class Cat(SQLModel): 9 ctx1abcdefghi

29 pet_type: Literal["cat"] 9 ctx1abcdefghi

30 meows: int 9 ctx1abcdefghi

31 

32 class Dog(SQLModel): 9 ctx1abcdefghi

33 pet_type: Literal["dog"] 9 ctx1abcdefghi

34 barks: float 9 ctx1abcdefghi

35 

36 class Lizard(SQLModel): 9 ctx1abcdefghi

37 pet_type: Literal["reptile", "lizard"] 9 ctx1abcdefghi

38 scales: bool 9 ctx1abcdefghi

39 

40 class Model(SQLModel): 9 ctx1abcdefghi

41 pet: Cat | Dog | Lizard = Field(..., discriminator="pet_type") 9 ctx1abcdefghi

42 n: int 9 ctx1abcdefghi

43 

44 Model(pet={"pet_type": "dog", "barks": 3.14}, n=1) # type: ignore[arg-type] 9 ctx1abcdefghi

45 

46 with pytest.raises(ValidationError): 9 ctx1abcdefghi

47 Model(pet={"pet_type": "dog"}, n=1) # type: ignore[arg-type] 9 ctx1abcdefghi

48 

49 

50def test_discriminator_callable(): 9 ctx1stuvwxyzA

51 # Example adapted from 

52 # [Pydantic docs](https://docs.pydantic.dev/latest/concepts/unions/#discriminated-unions-with-callable-discriminator): 

53 

54 class Pie(SQLModel): 9 ctx1jklmnopqr

55 pass 9 ctx1jklmnopqr

56 

57 class ApplePie(Pie): 9 ctx1jklmnopqr

58 fruit: Literal["apple"] = "apple" 9 ctx1jklmnopqr

59 

60 class PumpkinPie(Pie): 9 ctx1jklmnopqr

61 filling: Literal["pumpkin"] = "pumpkin" 9 ctx1jklmnopqr

62 

63 def get_discriminator_value(v: Any) -> str: 9 ctx1jklmnopqr

64 if isinstance(v, dict): 9 ctx1jklmnopqr

65 return v.get("fruit", v.get("filling")) 9 ctx1jklmnopqr

66 return getattr(v, "fruit", getattr(v, "filling", None)) 

67 

68 class ThanksgivingDinner(SQLModel): 9 ctx1jklmnopqr

69 dessert: ( 9 ctx1jklmnopqr

70 Annotated[ApplePie, Tag("apple")] | Annotated[PumpkinPie, Tag("pumpkin")] 

71 ) = Field( 

72 discriminator=Discriminator(get_discriminator_value), 

73 ) 

74 

75 apple_pie = ThanksgivingDinner.model_validate({"dessert": {"fruit": "apple"}}) 9 ctx1jklmnopqr

76 assert isinstance(apple_pie.dessert, ApplePie) 9 ctx1jklmnopqr

77 

78 pumpkin_pie = ThanksgivingDinner.model_validate({"dessert": {"filling": "pumpkin"}}) 9 ctx1jklmnopqr

79 assert isinstance(pumpkin_pie.dessert, PumpkinPie) 9 ctx1jklmnopqr

80 

81 

82def test_repr(): 9 ctx1stuvwxyzA

83 class Model(SQLModel): 9 ctx123456789!

84 id: int | None = Field(primary_key=True) 9 ctx123456789!

85 foo: str = Field(repr=False) 9 ctx123456789!

86 

87 instance = Model(id=123, foo="bar") 9 ctx123456789!

88 assert "foo=" not in repr(instance) 9 ctx123456789!

89 

90 

91def test_min_items(): 9 ctx1stuvwxyzA

92 with pytest.warns( 9 ctx1KLMNOPQRS

93 DeprecationWarning, 

94 match="`min_items` is deprecated and will be removed, use `min_length` instead", 

95 ): 

96 

97 class Model(SQLModel): 9 ctx1KLMNOPQRS

98 items: list[int] = Field(min_items=2) 9 ctx1KLMNOPQRS

99 

100 Model(items=[1, 2]) 9 ctx1KLMNOPQRS

101 

102 with pytest.raises(ValidationError) as exc_info: 9 ctx1KLMNOPQRS

103 Model(items=[1]) 9 ctx1KLMNOPQRS

104 assert len(exc_info.value.errors()) == 1 9 ctx1KLMNOPQRS

105 assert exc_info.value.errors()[0]["type"] == "too_short" 9 ctx1KLMNOPQRS

106 

107 

108def test_max_items(): 9 ctx1stuvwxyzA

109 with pytest.warns( 9 ctx1TUVWXYZ01

110 DeprecationWarning, 

111 match="`max_items` is deprecated and will be removed, use `max_length` instead", 

112 ): 

113 

114 class Model(SQLModel): 9 ctx1TUVWXYZ01

115 items: list[int] = Field(max_items=2) 9 ctx1TUVWXYZ01

116 

117 Model(items=[1, 2]) 9 ctx1TUVWXYZ01

118 

119 with pytest.raises(ValidationError) as exc_info: 9 ctx1TUVWXYZ01

120 Model(items=[1, 2, 3]) 9 ctx1TUVWXYZ01

121 assert len(exc_info.value.errors()) == 1 9 ctx1TUVWXYZ01

122 assert exc_info.value.errors()[0]["type"] == "too_long" 9 ctx1TUVWXYZ01