Coverage for tests/test_additional_properties_bool.py: 100%

1from typing import Union 5 ctx1abcde

2 

3from dirty_equals import IsDict 5 ctx1abcde

4from fastapi import FastAPI 5 ctx1abcde

5from fastapi._compat import PYDANTIC_V2 5 ctx1abcde

6from fastapi.testclient import TestClient 5 ctx1abcde

7from pydantic import BaseModel, ConfigDict 5 ctx1abcde

8 

9 

10class FooBaseModel(BaseModel): 5 ctx1abcde

11 if PYDANTIC_V2: 5 ctx1abcde

12 model_config = ConfigDict(extra="forbid") 5 ctx1abcde

13 else: 

14 

15 class Config: 5 ctx1abcde

16 extra = "forbid" 5 ctx1abcde

17 

18 

19class Foo(FooBaseModel): 5 ctx1abcde

20 pass 5 ctx1abcde

21 

22 

23app = FastAPI() 5 ctx1abcde

24 

25 

26@app.post("/") 5 ctx1abcde

27async def post( 5 ctx1abcde

28 foo: Union[Foo, None] = None, 

29): 

30 return foo 5 ctx1abcde

31 

32 

33client = TestClient(app) 5 ctx1abcde

34 

35 

36def test_call_invalid(): 5 ctx1abcde

37 response = client.post("/", json={"foo": {"bar": "baz"}}) 5 ctx1abcde

38 assert response.status_code == 422 5 ctx1abcde

39 

40 

41def test_call_valid(): 5 ctx1abcde

42 response = client.post("/", json={}) 5 ctx1abcde

43 assert response.status_code == 200 5 ctx1abcde

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

45 

46 

47def test_openapi_schema(): 5 ctx1abcde

48 response = client.get("/openapi.json") 5 ctx1abcde

49 assert response.status_code == 200, response.text 5 ctx1abcde

50 assert response.json() == { 5 ctx1abcde

51 "openapi": "3.1.0", 

52 "info": {"title": "FastAPI", "version": "0.1.0"}, 

53 "paths": { 

54 "/": { 

55 "post": { 

56 "summary": "Post", 

57 "operationId": "post__post", 

58 "requestBody": { 

59 "content": { 

60 "application/json": { 

61 "schema": IsDict( 

62 { 

63 "anyOf": [ 

64 {"$ref": "#/components/schemas/Foo"}, 

65 {"type": "null"}, 

66 ], 

67 "title": "Foo", 

68 } 

69 ) 

70 | IsDict( 

71 # TODO: remove when deprecating Pydantic v1 

72 {"$ref": "#/components/schemas/Foo"} 

73 ) 

74 } 

75 } 

76 }, 

77 "responses": { 

78 "200": { 

79 "description": "Successful Response", 

80 "content": {"application/json": {"schema": {}}}, 

81 }, 

82 "422": { 

83 "description": "Validation Error", 

84 "content": { 

85 "application/json": { 

86 "schema": { 

87 "$ref": "#/components/schemas/HTTPValidationError" 

88 } 

89 } 

90 }, 

91 }, 

92 }, 

93 } 

94 } 

95 }, 

96 "components": { 

97 "schemas": { 

98 "Foo": { 

99 "properties": {}, 

100 "additionalProperties": False, 

101 "type": "object", 

102 "title": "Foo", 

103 }, 

104 "HTTPValidationError": { 

105 "properties": { 

106 "detail": { 

107 "items": {"$ref": "#/components/schemas/ValidationError"}, 

108 "type": "array", 

109 "title": "Detail", 

110 } 

111 }, 

112 "type": "object", 

113 "title": "HTTPValidationError", 

114 }, 

115 "ValidationError": { 

116 "properties": { 

117 "loc": { 

118 "items": { 

119 "anyOf": [{"type": "string"}, {"type": "integer"}] 

120 }, 

121 "type": "array", 

122 "title": "Location", 

123 }, 

124 "msg": {"type": "string", "title": "Message"}, 

125 "type": {"type": "string", "title": "Error Type"}, 

126 }, 

127 "type": "object", 

128 "required": ["loc", "msg", "type"], 

129 "title": "ValidationError", 

130 }, 

131 } 

132 }, 

133 }