Coverage for tests/test_skip_defaults.py: 100%

1from typing import Optional 5 ctx1abcde

2 

3from fastapi import FastAPI 5 ctx1abcde

4from fastapi.testclient import TestClient 5 ctx1abcde

5from pydantic import BaseModel 5 ctx1abcde

6 

7app = FastAPI() 5 ctx1abcde

8 

9 

10class SubModel(BaseModel): 5 ctx1abcde

11 a: Optional[str] = "foo" 5 ctx1abcde

12 

13 

14class Model(BaseModel): 5 ctx1abcde

15 x: Optional[int] = None 5 ctx1abcde

16 sub: SubModel 5 ctx1abcde

17 

18 

19class ModelSubclass(Model): 5 ctx1abcde

20 y: int 5 ctx1abcde

21 z: int = 0 5 ctx1abcde

22 w: Optional[int] = None 5 ctx1abcde

23 

24 

25class ModelDefaults(BaseModel): 5 ctx1abcde

26 w: Optional[str] = None 5 ctx1abcde

27 x: Optional[str] = None 5 ctx1abcde

28 y: str = "y" 5 ctx1abcde

29 z: str = "z" 5 ctx1abcde

30 

31 

32@app.get("/", response_model=Model, response_model_exclude_unset=True) 5 ctx1abcde

33def get_root() -> ModelSubclass: 5 ctx1abcde

34 return ModelSubclass(sub={}, y=1, z=0) 5 ctx1abcde

35 

36 

37@app.get( 5 ctx1abcde

38 "/exclude_unset", response_model=ModelDefaults, response_model_exclude_unset=True 

39) 

40def get_exclude_unset() -> ModelDefaults: 5 ctx1abcde

41 return ModelDefaults(x=None, y="y") 5 ctx1abcde

42 

43 

44@app.get( 5 ctx1abcde

45 "/exclude_defaults", 

46 response_model=ModelDefaults, 

47 response_model_exclude_defaults=True, 

48) 

49def get_exclude_defaults() -> ModelDefaults: 5 ctx1abcde

50 return ModelDefaults(x=None, y="y") 5 ctx1abcde

51 

52 

53@app.get( 5 ctx1abcde

54 "/exclude_none", response_model=ModelDefaults, response_model_exclude_none=True 

55) 

56def get_exclude_none() -> ModelDefaults: 5 ctx1abcde

57 return ModelDefaults(x=None, y="y") 5 ctx1abcde

58 

59 

60@app.get( 5 ctx1abcde

61 "/exclude_unset_none", 

62 response_model=ModelDefaults, 

63 response_model_exclude_unset=True, 

64 response_model_exclude_none=True, 

65) 

66def get_exclude_unset_none() -> ModelDefaults: 5 ctx1abcde

67 return ModelDefaults(x=None, y="y") 5 ctx1abcde

68 

69 

70client = TestClient(app) 5 ctx1abcde

71 

72 

73def test_return_defaults(): 5 ctx1abcde

74 response = client.get("/") 5 ctx1abcde

75 assert response.json() == {"sub": {}} 5 ctx1abcde

76 

77 

78def test_return_exclude_unset(): 5 ctx1abcde

79 response = client.get("/exclude_unset") 5 ctx1abcde

80 assert response.json() == {"x": None, "y": "y"} 5 ctx1abcde

81 

82 

83def test_return_exclude_defaults(): 5 ctx1abcde

84 response = client.get("/exclude_defaults") 5 ctx1abcde

85 assert response.json() == {} 5 ctx1abcde

86 

87 

88def test_return_exclude_none(): 5 ctx1abcde

89 response = client.get("/exclude_none") 5 ctx1abcde

90 assert response.json() == {"y": "y", "z": "z"} 5 ctx1abcde

91 

92 

93def test_return_exclude_unset_none(): 5 ctx1abcde

94 response = client.get("/exclude_unset_none") 5 ctx1abcde

95 assert response.json() == {"y": "y"} 5 ctx1abcde