Coverage for tests/test_field_sa_column.py: 100%

54 statements  

« prev     ^ index     » next       coverage.py v7.17.2, created at 2026-11-16 00:02 +0000

1from typing import Annotated 1abcdefghijklm

2 

3import pytest 1abcdefghijklm

4from sqlalchemy import Column, Integer, String 1abcdefghijklm

5from sqlmodel import Field, SQLModel 1abcdefghijklm

6 

7 

8def test_sa_column_takes_precedence() -> None: 1abcdefghijklm

9 class Item(SQLModel, table=True): 1ABCDEFGHIJKLM

10 id: int | None = Field( 1ABCDEFGHIJKLM

11 default=None, 

12 sa_column=Column(String, primary_key=True, nullable=False), 

13 ) 

14 

15 # It would have been nullable with no sa_column 

16 assert Item.id.nullable is False # type: ignore 1ABCDEFGHIJKLM

17 assert isinstance(Item.id.type, String) # type: ignore 1ABCDEFGHIJKLM

18 

19 

20def test_sa_column_with_annotated_metadata() -> None: 1abcdefghijklm

21 class Item(SQLModel, table=True): 1NOPQRSTUVWXYZ

22 id: Annotated[int | None, "meta"] = Field( 1NOPQRSTUVWXYZ

23 default=None, 

24 sa_column=Column(String, primary_key=True, nullable=False), 

25 ) 

26 

27 assert Item.id.nullable is False # type: ignore 1NOPQRSTUVWXYZ

28 assert isinstance(Item.id.type, String) # type: ignore 1NOPQRSTUVWXYZ

29 

30 

31def test_sa_column_no_sa_args() -> None: 1abcdefghijklm

32 with pytest.raises(RuntimeError): 10123456789!#$

33 

34 class Item(SQLModel, table=True): 10123456789!#$

35 id: int | None = Field( 10123456789!#$

36 default=None, 

37 sa_column_args=[Integer], 

38 sa_column=Column(Integer, primary_key=True), 

39 ) 

40 

41 

42def test_sa_column_no_sa_kargs() -> None: 1abcdefghijklm

43 with pytest.raises(RuntimeError): 1%'()*+,-./:;=

44 

45 class Item(SQLModel, table=True): 1%'()*+,-./:;=

46 id: int | None = Field( 1%'()*+,-./:;=

47 default=None, 

48 sa_column_kwargs={"primary_key": True}, 

49 sa_column=Column(Integer, primary_key=True), 

50 ) 

51 

52 

53def test_sa_column_no_type() -> None: 1abcdefghijklm

54 with pytest.raises(RuntimeError): 2? @ [ ] ^ _ ` { | } ~ abbb

55 

56 class Item(SQLModel, table=True): 2? @ [ ] ^ _ ` { | } ~ abbb

57 id: int | None = Field( 2? @ [ ] ^ _ ` { | } ~ abbb

58 default=None, 

59 sa_type=Integer, 

60 sa_column=Column(Integer, primary_key=True), 

61 ) 

62 

63 

64def test_sa_column_no_primary_key() -> None: 1abcdefghijklm

65 with pytest.raises(RuntimeError): 2cbdbebfbgbhbibjbkblbmbnbob

66 

67 class Item(SQLModel, table=True): 2cbdbebfbgbhbibjbkblbmbnbob

68 id: int | None = Field( 2cbdbebfbgbhbibjbkblbmbnbob

69 default=None, 

70 primary_key=True, 

71 sa_column=Column(Integer, primary_key=True), 

72 ) 

73 

74 

75def test_sa_column_no_nullable() -> None: 1abcdefghijklm

76 with pytest.raises(RuntimeError): 2pbqbrbsbtbubvbwbxbybzbAbBb

77 

78 class Item(SQLModel, table=True): 2pbqbrbsbtbubvbwbxbybzbAbBb

79 id: int | None = Field( 2pbqbrbsbtbubvbwbxbybzbAbBb

80 default=None, 

81 nullable=True, 

82 sa_column=Column(Integer, primary_key=True), 

83 ) 

84 

85 

86def test_sa_column_no_foreign_key() -> None: 1abcdefghijklm

87 with pytest.raises(RuntimeError): 1nopqrstuvwxyz

88 

89 class Team(SQLModel, table=True): 1nopqrstuvwxyz

90 id: int | None = Field(default=None, primary_key=True) 1nopqrstuvwxyz

91 name: str 1nopqrstuvwxyz

92 

93 class Hero(SQLModel, table=True): 1nopqrstuvwxyz

94 id: int | None = Field(default=None, primary_key=True) 1nopqrstuvwxyz

95 team_id: int | None = Field( 1nopqrstuvwxyz

96 default=None, 

97 foreign_key="team.id", 

98 sa_column=Column(Integer, primary_key=True), 

99 ) 

100 

101 

102def test_sa_column_no_unique() -> None: 1abcdefghijklm

103 with pytest.raises(RuntimeError): 2CbDbEbFbGbHbIbJbKbLbMbNbOb

104 

105 class Item(SQLModel, table=True): 2CbDbEbFbGbHbIbJbKbLbMbNbOb

106 id: int | None = Field( 2CbDbEbFbGbHbIbJbKbLbMbNbOb

107 default=None, 

108 unique=True, 

109 sa_column=Column(Integer, primary_key=True), 

110 ) 

111 

112 

113def test_sa_column_no_index() -> None: 1abcdefghijklm

114 with pytest.raises(RuntimeError): 2PbQbRbSbTbUbVbWbXbYbZb0b1b

115 

116 class Item(SQLModel, table=True): 2PbQbRbSbTbUbVbWbXbYbZb0b1b

117 id: int | None = Field( 2PbQbRbSbTbUbVbWbXbYbZb0b1b

118 default=None, 

119 index=True, 

120 sa_column=Column(Integer, primary_key=True), 

121 ) 

122 

123 

124def test_sa_column_no_ondelete() -> None: 1abcdefghijklm

125 with pytest.raises(RuntimeError): 22b3b4b5b6b7b8b9b!b#b$b%b'b

126 

127 class Item(SQLModel, table=True): 22b3b4b5b6b7b8b9b!b#b$b%b'b

128 id: int | None = Field( 22b3b4b5b6b7b8b9b!b#b$b%b'b

129 default=None, 

130 sa_column=Column(Integer, primary_key=True), 

131 ondelete="CASCADE", 

132 )