Coverage for tests / test_skip_defaults.py: 100%

1from fastapi import FastAPI 4 ctx1abcd

2from fastapi.testclient import TestClient 4 ctx1abcd

3from pydantic import BaseModel 4 ctx1abcd

4 

5app = FastAPI() 4 ctx1abcd

6 

7 

8class SubModel(BaseModel): 4 ctx1abcd

9 a: str | None = "foo" 4 ctx1abcd

10 

11 

12class Model(BaseModel): 4 ctx1abcd

13 x: int | None = None 4 ctx1abcd

14 sub: SubModel 4 ctx1abcd

15 

16 

17class ModelSubclass(Model): 4 ctx1abcd

18 y: int 4 ctx1abcd

19 z: int = 0 4 ctx1abcd

20 w: int | None = None 4 ctx1abcd

21 

22 

23class ModelDefaults(BaseModel): 4 ctx1abcd

24 w: str | None = None 4 ctx1abcd

25 x: str | None = None 4 ctx1abcd

26 y: str = "y" 4 ctx1abcd

27 z: str = "z" 4 ctx1abcd

28 

29 

30@app.get("/", response_model=Model, response_model_exclude_unset=True) 4 ctx1abcd

31def get_root() -> ModelSubclass: 4 ctx1abcd

32 return ModelSubclass(sub={}, y=1, z=0) 3 ctx1efg

33 

34 

35@app.get( 4 ctx1abcd

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

37) 

38def get_exclude_unset() -> ModelDefaults: 4 ctx1abcd

39 return ModelDefaults(x=None, y="y") 3 ctx1hij

40 

41 

42@app.get( 4 ctx1abcd

43 "/exclude_defaults", 

44 response_model=ModelDefaults, 

45 response_model_exclude_defaults=True, 

46) 

47def get_exclude_defaults() -> ModelDefaults: 4 ctx1abcd

48 return ModelDefaults(x=None, y="y") 3 ctx1klm

49 

50 

51@app.get( 4 ctx1abcd

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

53) 

54def get_exclude_none() -> ModelDefaults: 4 ctx1abcd

55 return ModelDefaults(x=None, y="y") 3 ctx1nop

56 

57 

58@app.get( 4 ctx1abcd

59 "/exclude_unset_none", 

60 response_model=ModelDefaults, 

61 response_model_exclude_unset=True, 

62 response_model_exclude_none=True, 

63) 

64def get_exclude_unset_none() -> ModelDefaults: 4 ctx1abcd

65 return ModelDefaults(x=None, y="y") 3 ctx1qrs

66 

67 

68client = TestClient(app) 4 ctx1abcd

69 

70 

71def test_return_defaults(): 4 ctx1abcd

72 response = client.get("/") 3 ctx1efg

73 assert response.json() == {"sub": {}} 3 ctx1efg

74 

75 

76def test_return_exclude_unset(): 4 ctx1abcd

77 response = client.get("/exclude_unset") 3 ctx1hij

78 assert response.json() == {"x": None, "y": "y"} 3 ctx1hij

79 

80 

81def test_return_exclude_defaults(): 4 ctx1abcd

82 response = client.get("/exclude_defaults") 3 ctx1klm

83 assert response.json() == {} 3 ctx1klm

84 

85 

86def test_return_exclude_none(): 4 ctx1abcd

87 response = client.get("/exclude_none") 3 ctx1nop

88 assert response.json() == {"y": "y", "z": "z"} 3 ctx1nop

89 

90 

91def test_return_exclude_unset_none(): 4 ctx1abcd

92 response = client.get("/exclude_unset_none") 3 ctx1qrs

93 assert response.json() == {"y": "y"} 3 ctx1qrs