Coverage for tests / test_serialize_response_model.py: 100%

1from typing import Optional 4 ctx1abcd

2 

3from fastapi import FastAPI 4 ctx1abcd

4from pydantic import BaseModel, Field 4 ctx1abcd

5from starlette.testclient import TestClient 4 ctx1abcd

6 

7app = FastAPI() 4 ctx1abcd

8 

9 

10class Item(BaseModel): 4 ctx1abcd

11 name: str = Field(alias="aliased_name") 4 ctx1abcd

12 price: Optional[float] = None 4 ctx1abcd

13 owner_ids: Optional[list[int]] = None 4 ctx1abcd

14 

15 

16@app.get("/items/valid", response_model=Item) 4 ctx1abcd

17def get_valid(): 4 ctx1abcd

18 return Item(aliased_name="valid", price=1.0) 3 ctx1efg

19 

20 

21@app.get("/items/coerce", response_model=Item) 4 ctx1abcd

22def get_coerce(): 4 ctx1abcd

23 return Item(aliased_name="coerce", price="1.0") 3 ctx1hij

24 

25 

26@app.get("/items/validlist", response_model=list[Item]) 4 ctx1abcd

27def get_validlist(): 4 ctx1abcd

28 return [ 3 ctx1klm

29 Item(aliased_name="foo"), 

30 Item(aliased_name="bar", price=1.0), 

31 Item(aliased_name="baz", price=2.0, owner_ids=[1, 2, 3]), 

32 ] 

33 

34 

35@app.get("/items/validdict", response_model=dict[str, Item]) 4 ctx1abcd

36def get_validdict(): 4 ctx1abcd

37 return { 3 ctx1nop

38 "k1": Item(aliased_name="foo"), 

39 "k2": Item(aliased_name="bar", price=1.0), 

40 "k3": Item(aliased_name="baz", price=2.0, owner_ids=[1, 2, 3]), 

41 } 

42 

43 

44@app.get( 4 ctx1abcd

45 "/items/valid-exclude-unset", response_model=Item, response_model_exclude_unset=True 

46) 

47def get_valid_exclude_unset(): 4 ctx1abcd

48 return Item(aliased_name="valid", price=1.0) 3 ctx1qrs

49 

50 

51@app.get( 4 ctx1abcd

52 "/items/coerce-exclude-unset", 

53 response_model=Item, 

54 response_model_exclude_unset=True, 

55) 

56def get_coerce_exclude_unset(): 4 ctx1abcd

57 return Item(aliased_name="coerce", price="1.0") 3 ctx1tuv

58 

59 

60@app.get( 4 ctx1abcd

61 "/items/validlist-exclude-unset", 

62 response_model=list[Item], 

63 response_model_exclude_unset=True, 

64) 

65def get_validlist_exclude_unset(): 4 ctx1abcd

66 return [ 3 ctx1wxy

67 Item(aliased_name="foo"), 

68 Item(aliased_name="bar", price=1.0), 

69 Item(aliased_name="baz", price=2.0, owner_ids=[1, 2, 3]), 

70 ] 

71 

72 

73@app.get( 4 ctx1abcd

74 "/items/validdict-exclude-unset", 

75 response_model=dict[str, Item], 

76 response_model_exclude_unset=True, 

77) 

78def get_validdict_exclude_unset(): 4 ctx1abcd

79 return { 3 ctx1zAB

80 "k1": Item(aliased_name="foo"), 

81 "k2": Item(aliased_name="bar", price=1.0), 

82 "k3": Item(aliased_name="baz", price=2.0, owner_ids=[1, 2, 3]), 

83 } 

84 

85 

86client = TestClient(app) 4 ctx1abcd

87 

88 

89def test_valid(): 4 ctx1abcd

90 response = client.get("/items/valid") 3 ctx1efg

91 response.raise_for_status() 3 ctx1efg

92 assert response.json() == {"aliased_name": "valid", "price": 1.0, "owner_ids": None} 3 ctx1efg

93 

94 

95def test_coerce(): 4 ctx1abcd

96 response = client.get("/items/coerce") 3 ctx1hij

97 response.raise_for_status() 3 ctx1hij

98 assert response.json() == { 3 ctx1hij

99 "aliased_name": "coerce", 

100 "price": 1.0, 

101 "owner_ids": None, 

102 } 

103 

104 

105def test_validlist(): 4 ctx1abcd

106 response = client.get("/items/validlist") 3 ctx1klm

107 response.raise_for_status() 3 ctx1klm

108 assert response.json() == [ 3 ctx1klm

109 {"aliased_name": "foo", "price": None, "owner_ids": None}, 

110 {"aliased_name": "bar", "price": 1.0, "owner_ids": None}, 

111 {"aliased_name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}, 

112 ] 

113 

114 

115def test_validdict(): 4 ctx1abcd

116 response = client.get("/items/validdict") 3 ctx1nop

117 response.raise_for_status() 3 ctx1nop

118 assert response.json() == { 3 ctx1nop

119 "k1": {"aliased_name": "foo", "price": None, "owner_ids": None}, 

120 "k2": {"aliased_name": "bar", "price": 1.0, "owner_ids": None}, 

121 "k3": {"aliased_name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}, 

122 } 

123 

124 

125def test_valid_exclude_unset(): 4 ctx1abcd

126 response = client.get("/items/valid-exclude-unset") 3 ctx1qrs

127 response.raise_for_status() 3 ctx1qrs

128 assert response.json() == {"aliased_name": "valid", "price": 1.0} 3 ctx1qrs

129 

130 

131def test_coerce_exclude_unset(): 4 ctx1abcd

132 response = client.get("/items/coerce-exclude-unset") 3 ctx1tuv

133 response.raise_for_status() 3 ctx1tuv

134 assert response.json() == {"aliased_name": "coerce", "price": 1.0} 3 ctx1tuv

135 

136 

137def test_validlist_exclude_unset(): 4 ctx1abcd

138 response = client.get("/items/validlist-exclude-unset") 3 ctx1wxy

139 response.raise_for_status() 3 ctx1wxy

140 assert response.json() == [ 3 ctx1wxy

141 {"aliased_name": "foo"}, 

142 {"aliased_name": "bar", "price": 1.0}, 

143 {"aliased_name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}, 

144 ] 

145 

146 

147def test_validdict_exclude_unset(): 4 ctx1abcd

148 response = client.get("/items/validdict-exclude-unset") 3 ctx1zAB

149 response.raise_for_status() 3 ctx1zAB

150 assert response.json() == { 3 ctx1zAB

151 "k1": {"aliased_name": "foo"}, 

152 "k2": {"aliased_name": "bar", "price": 1.0}, 

153 "k3": {"aliased_name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}, 

154 }