1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
import sys
from types import ModuleType
from typing import Any, Callable
import pytest
from msgspec import Struct
from litestar import delete, post
from litestar.openapi import ResponseSpec
from litestar.openapi.spec import OpenAPI
from litestar.status_codes import HTTP_204_NO_CONTENT
from litestar.testing import create_test_client
from tests.models import DataclassPerson, MsgSpecStructPerson, TypedDictPerson
@pytest.mark.parametrize("cls", (DataclassPerson, TypedDictPerson, MsgSpecStructPerson))
def test_spec_generation(cls: Any) -> None:
@post("/")
def handler(data: cls) -> cls:
return data
with create_test_client(handler) as client:
schema = client.app.openapi_schema
assert schema
assert schema.to_schema()["components"]["schemas"][cls.__name__] == {
"properties": {
"first_name": {"type": "string"},
"last_name": {"type": "string"},
"id": {"type": "string"},
"optional": {"oneOf": [{"type": "string"}, {"type": "null"}]},
"complex": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {"type": "object", "additionalProperties": {"type": "string"}},
},
},
"pets": {
"oneOf": [
{
"items": {"$ref": "#/components/schemas/DataclassPet"},
"type": "array",
},
{"type": "null"},
]
},
},
"type": "object",
"required": ["complex", "first_name", "id", "last_name"],
"title": f"{cls.__name__}",
}
def test_spec_generation_no_content() -> None:
@delete(
"/",
status_code=HTTP_204_NO_CONTENT,
responses={204: ResponseSpec(None, description="Custom response")},
)
def handler() -> None:
return None
with create_test_client(handler) as client:
schema: OpenAPI = client.app.openapi_schema
assert schema.to_schema()["paths"] == {
"/": {
"delete": {
"summary": "Handler",
"deprecated": False,
"operationId": "Handler",
"responses": {
"204": {
"description": "Custom response",
}
},
},
},
}
def test_msgspec_schema() -> None:
class CamelizedStruct(Struct, rename="camel"):
field_one: int
field_two: float
@post("/")
def handler(data: CamelizedStruct) -> CamelizedStruct:
return data
with create_test_client(handler) as client:
schema = client.app.openapi_schema
assert schema
assert schema.to_schema()["components"]["schemas"]["test_msgspec_schema.CamelizedStruct"] == {
"properties": {"fieldOne": {"type": "integer"}, "fieldTwo": {"type": "number"}},
"required": ["fieldOne", "fieldTwo"],
"title": "CamelizedStruct",
"type": "object",
}
@pytest.fixture()
def py_38_module_content() -> str:
return """
from __future__ import annotations
from typing import List, Optional
from msgspec import Struct
from litestar import Litestar, get
class A(Struct):
a: A
b: B
opt_a: Optional[A] = None
opt_b: Optional[B] = None
list_a: List[A] = []
list_b: List[B] = []
class B(Struct):
a: A
b: B
opt_a: Optional[A] = None
opt_b: Optional[B] = None
list_a: List[A] = []
list_b: List[B] = []
@get("/")
async def test() -> A:
return A()
"""
@pytest.fixture()
def py_310_module_content() -> str:
return """
from __future__ import annotations
from msgspec import Struct
from litestar import Litestar, get
class A(Struct):
a: A
b: B
opt_a: A | None = None
opt_b: B | None = None
list_a: list[A] = []
list_b: list[B] = []
class B(Struct):
a: A
b: B
opt_a: A | None = None
opt_b: B | None = None
list_a: list[A] = []
list_b: list[B] = []
@get("/")
async def test() -> A:
return A()
"""
@pytest.mark.parametrize(
("fixture_name",),
[
("py_38_module_content",),
pytest.param(
"py_310_module_content",
marks=pytest.mark.skipif(
sys.version_info < (3, 10),
reason="requires python 3.10",
),
),
],
)
def test_recursive_schema_generation(
fixture_name: str, create_module: Callable[[str], ModuleType], request: pytest.FixtureRequest
) -> None:
module_content = request.getfixturevalue(fixture_name)
module = create_module(module_content)
with create_test_client(module.test, debug=True) as client:
schema = client.app.openapi_schema
assert schema
assert schema.to_schema()["components"]["schemas"]["A"] == {
"required": ["a", "b"],
"properties": {
"a": {"$ref": "#/components/schemas/A"},
"b": {"$ref": "#/components/schemas/B"},
"opt_a": {"oneOf": [{"$ref": "#/components/schemas/A"}, {"type": "null"}]},
"opt_b": {"oneOf": [{"$ref": "#/components/schemas/B"}, {"type": "null"}]},
"list_a": {"items": {"$ref": "#/components/schemas/A"}, "type": "array"},
"list_b": {"items": {"$ref": "#/components/schemas/B"}, "type": "array"},
},
"type": "object",
"title": "A",
}
assert schema.to_schema()["components"]["schemas"]["B"] == {
"required": ["a", "b"],
"properties": {
"a": {"$ref": "#/components/schemas/A"},
"b": {"$ref": "#/components/schemas/B"},
"opt_a": {"oneOf": [{"$ref": "#/components/schemas/A"}, {"type": "null"}]},
"opt_b": {"oneOf": [{"$ref": "#/components/schemas/B"}, {"type": "null"}]},
"list_a": {"items": {"$ref": "#/components/schemas/A"}, "type": "array"},
"list_b": {"items": {"$ref": "#/components/schemas/B"}, "type": "array"},
},
"type": "object",
"title": "B",
}
|
