-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathroute_doc_models.py
More file actions
415 lines (367 loc) · 15.5 KB
/
Copy pathroute_doc_models.py
File metadata and controls
415 lines (367 loc) · 15.5 KB
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
import typing as t
from abc import ABC, abstractmethod
from enum import Enum
from pydantic import BaseModel
from pydantic.fields import ModelField, Undefined
from pydantic.schema import field_schema
from starlette.convertors import (
FloatConvertor,
IntegerConvertor,
PathConvertor,
StringConvertor,
UUIDConvertor,
)
from starlette.routing import Mount, compile_path
from starlette.status import HTTP_422_UNPROCESSABLE_ENTITY
from ellar.compatible import cached_property
from ellar.constants import GUARDS_KEY, METHODS_WITH_BODY, OPENAPI_KEY, REF_PREFIX
from ellar.core.guard import BaseAuthGuard
from ellar.core.params.params import Body, Param
from ellar.core.params.resolvers import (
BodyParameterResolver,
BulkParameterResolver,
RouteParameterModelField,
RouteParameterResolver,
)
from ellar.core.routing import ModuleMount, RouteOperation
from ellar.services.reflector import Reflector
from ellar.shortcuts import normalize_path
if t.TYPE_CHECKING: # pragma: no cover
from ellar.core.guard import GuardCanActivate
CONVERTOR_TYPES = {
StringConvertor: dict(title="title", type="string"),
PathConvertor: dict(title="title", type="string"),
IntegerConvertor: dict(title="title", type="integer"),
FloatConvertor: dict(title="title", type="number"),
UUIDConvertor: dict(title="title", type="string", format="uuid"),
}
class OpenAPIRoute(ABC):
@abstractmethod
def get_route_models(self) -> t.List[t.Union[ModelField, RouteParameterModelField]]:
pass
@abstractmethod
def get_openapi_path(
self,
model_name_map: t.Dict[t.Union[t.Type[BaseModel], t.Type[Enum]], str],
paths: t.Dict,
security_schemes: t.Dict[str, t.Any],
path_prefix: t.Optional[str] = None,
) -> None:
pass
class OpenAPIMountDocumentation(OpenAPIRoute):
def __init__(
self,
mount: t.Union[ModuleMount, Mount],
tag: t.Optional[str] = None,
description: t.Optional[str] = None,
external_doc_description: t.Optional[str] = None,
external_doc_url: t.Optional[str] = None,
global_guards: t.List[
t.Union[t.Type["GuardCanActivate"], "GuardCanActivate"]
] = None,
) -> None:
self.tag = tag
self.description = description
self.external_doc_description = external_doc_description
self.external_doc_url = external_doc_url
self.mount = mount
self.path_regex, self.path_format, self.param_convertors = compile_path(
self.mount.path
)
self.global_route_parameters = []
self.global_guards = global_guards or []
if self.param_convertors:
for name, converter in self.param_convertors.items():
schema = CONVERTOR_TYPES[converter.__class__]
schema.update(title=name)
parameter = {
"name": name,
"in": "path",
"required": True,
"schema": schema,
}
self.global_route_parameters.append(parameter)
self._routes: t.List["OpenAPIRouteDocumentation"] = self._build_routes()
def get_tag(self) -> t.Dict:
external_doc = None
if self.external_doc_url:
external_doc = dict(
url=self.external_doc_url, description=self.external_doc_description
)
if self.tag:
return dict(
name=self.tag, description=self.description, externalDocs=external_doc
)
return dict()
def _build_routes(self) -> t.List["OpenAPIRouteDocumentation"]:
reflector: Reflector = Reflector()
_routes: t.List[OpenAPIRouteDocumentation] = []
for route in self.mount.routes:
if isinstance(route, RouteOperation) and route.include_in_schema:
openapi = reflector.get(OPENAPI_KEY, route.endpoint) or dict()
guards = reflector.get(GUARDS_KEY, route.endpoint)
self._routes.append(
OpenAPIRouteDocumentation(
route=route,
global_route_parameters=self.global_route_parameters,
guards=guards or self.global_guards,
**openapi,
)
)
return _routes
@cached_property
def _openapi_models(self) -> t.List[ModelField]:
_models = []
for route in self._routes:
_models.extend(route.get_route_models())
return _models
def get_route_models(self) -> t.List[t.Union[ModelField, RouteParameterModelField]]:
"""Should return input fields and output fields"""
return self._openapi_models # type:ignore
def get_openapi_path(
self,
model_name_map: t.Dict[t.Union[t.Type[BaseModel], t.Type[Enum]], str],
paths: t.Dict,
security_schemes: t.Dict[str, t.Any],
path_prefix: t.Optional[str] = None,
) -> None:
path_prefix = (
f"{path_prefix.rstrip('/')}/{self.mount.path.lstrip('/')}"
if path_prefix
else self.path_format
)
for openapi_route in self._routes:
path, _security_schemes = openapi_route.get_child_openapi_path(
model_name_map=model_name_map
)
if path:
route_path = (
normalize_path(f"{path_prefix}/{openapi_route.route.path_format}")
if path_prefix
else openapi_route.route.path_format
)
paths.setdefault(route_path, {}).update(path)
security_schemes.update(_security_schemes)
class OpenAPIRouteDocumentation(OpenAPIRoute):
def __init__(
self,
*,
route: "RouteOperation",
operation_id: t.Optional[str] = None,
summary: t.Optional[str] = None,
description: t.Optional[str] = None,
tags: t.Optional[t.List[str]] = None,
deprecated: t.Optional[bool] = None,
global_route_parameters: t.List[t.Dict] = None,
guards: t.List[t.Union["GuardCanActivate", t.Type["GuardCanActivate"]]] = None,
) -> None:
self.operation_id = operation_id
self.summary = summary
self.description = description
self.tags = tags
self.deprecated = deprecated
self.route = route
self.global_route_parameters = global_route_parameters or []
self.guards = guards or []
if self.tags and not isinstance(self.tags, list):
self.tags = [self.tags]
@cached_property
def _openapi_models(self) -> t.List[t.Union[ModelField, RouteParameterModelField]]:
_models: t.List[ModelField] = self.input_fields + self.output_fields
if self.route.endpoint_parameter_model.body_resolver:
model_field = self.route.endpoint_parameter_model.body_resolver.model_field
_models.append(model_field)
return _models
@cached_property
def input_fields(self) -> t.List[ModelField]:
_models: t.List[ModelField] = []
for item in self.route.endpoint_parameter_model.get_all_models():
if isinstance(item, BodyParameterResolver):
continue
if isinstance(item, BulkParameterResolver):
_models.extend(item.get_model_fields())
continue
if isinstance(item, RouteParameterResolver):
_models.append(item.model_field)
return _models
@cached_property
def output_fields(self) -> t.List[ModelField]:
_models: t.List[ModelField] = []
for _, model in self.route.response_model.models.items():
if model.get_model_field():
_models.append(model.get_model_field()) # type: ignore
return _models
def get_route_models(self) -> t.List[ModelField]:
"""Should return input fields and output fields"""
return self._openapi_models # type:ignore
def _get_openapi_security_scheme(
self,
) -> t.Tuple[t.Dict[str, t.Any], t.List[t.Dict[str, t.Any]]]:
security_definitions: t.Dict = {}
operation_security: t.List = []
for item in self.guards:
if isinstance(item, type) and not issubclass(item, BaseAuthGuard):
continue
security_scheme = item.get_guard_scheme() # type: ignore
scheme_name = security_scheme["name"]
operation_security.append({scheme_name: item.openapi_scope}) # type: ignore
security_definitions[scheme_name] = security_scheme
return security_definitions, operation_security
def get_openapi_operation_metadata(self, method: str) -> t.Dict[str, t.Any]:
operation: t.Dict[str, t.Any] = {}
if self.tags:
operation["tags"] = self.tags
operation["summary"] = self.summary
if self.description:
operation["description"] = self.description
operation[
"operationId"
] = self.operation_id or self.route.get_operation_unique_id(methods=method)
if self.deprecated:
operation["deprecated"] = self.deprecated
return operation
def get_openapi_operation_parameters(
self,
*,
model_name_map: t.Dict[t.Union[t.Type[BaseModel], t.Type[Enum]], str],
) -> t.List[t.Dict[str, t.Any]]:
parameters: t.List[t.Dict[str, t.Any]] = []
for param in self.input_fields:
field_info = param.field_info
field_info = t.cast(Param, field_info)
parameter = {
"name": param.alias,
"in": field_info.in_.value,
"required": param.required,
"schema": field_schema(
param, model_name_map=model_name_map, ref_prefix=REF_PREFIX
)[0],
}
if field_info.description:
parameter["description"] = field_info.description
if field_info.examples:
parameter["examples"] = field_info.examples
elif field_info.example != Undefined:
parameter["example"] = field_info.example
if field_info.deprecated:
parameter["deprecated"] = field_info.deprecated
parameters.append(parameter)
return parameters + self.global_route_parameters
def get_openapi_operation_request_body(
self,
*,
model_name_map: t.Dict[t.Union[t.Type[BaseModel], t.Type[Enum]], str],
) -> t.Optional[t.Dict[str, t.Any]]:
if not self.route.endpoint_parameter_model.body_resolver:
return None
model_field = self.route.endpoint_parameter_model.body_resolver.model_field
assert isinstance(model_field, ModelField)
body_schema, _, _ = field_schema(
model_field, model_name_map=model_name_map, ref_prefix=REF_PREFIX
)
field_info = t.cast(Body, model_field.field_info)
request_media_type = field_info.media_type
request_body_oai: t.Dict[str, t.Any] = {}
if model_field.required:
request_body_oai["required"] = model_field.required
request_media_content: t.Dict[str, t.Any] = {"schema": body_schema}
if field_info.examples:
request_media_content["examples"] = field_info.examples
elif field_info.example != Undefined:
request_media_content["example"] = field_info.example
request_body_oai["content"] = {request_media_type: request_media_content}
return request_body_oai
def _get_openapi_path_object(
self, model_name_map: t.Dict[t.Union[t.Type[BaseModel], t.Type[Enum]], str]
) -> t.Tuple:
path: t.Dict = {}
security_schemes: t.Dict[str, t.Any] = {}
for method in self.route.methods:
operation = self.get_openapi_operation_metadata(method=method)
parameters: t.List[t.Dict[str, t.Any]] = []
operation_parameters = self.get_openapi_operation_parameters(
model_name_map=model_name_map
)
parameters.extend(operation_parameters)
if parameters:
operation["parameters"] = list(
{param["name"]: param for param in parameters}.values()
)
if method in METHODS_WITH_BODY:
request_body_oai = self.get_openapi_operation_request_body(
model_name_map=model_name_map
)
if request_body_oai:
operation["requestBody"] = request_body_oai
(
security_definitions,
operation_security,
) = self._get_openapi_security_scheme()
if operation_security:
operation.setdefault("security", []).extend(operation_security)
if security_definitions:
security_schemes.update(security_definitions)
operation_responses = operation.setdefault("responses", {})
for status, response_model in self.route.response_model.models.items():
operation_responses_status = operation_responses.setdefault(status, {})
operation_responses_status["description"] = getattr(
response_model, "description", ""
)
content = operation_responses_status.setdefault("content", {})
media_type = content.setdefault(
getattr(response_model, "media_type", "text/plain"), {}
)
media_type.setdefault("schema", {"type": "string"})
model_field = response_model.get_model_field()
if model_field:
model_field_schema, _, _ = field_schema(
model_field,
model_name_map=model_name_map,
ref_prefix=REF_PREFIX,
)
media_type["schema"] = model_field_schema
http422 = str(HTTP_422_UNPROCESSABLE_ENTITY)
if (
parameters or self.route.endpoint_parameter_model.body_resolver
) and not any(
[
status in operation["responses"]
for status in [http422, "4XX", "default"]
]
):
operation["responses"][http422] = {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {"$ref": REF_PREFIX + "HTTPValidationError"}
}
},
}
path[method.lower()] = operation
return path, security_schemes
def get_child_openapi_path(
self,
model_name_map: t.Dict[t.Union[t.Type[BaseModel], t.Type[Enum]], str],
) -> t.Tuple:
_path, _security_schemes = self._get_openapi_path_object(
model_name_map=model_name_map
)
return _path, _security_schemes
def get_openapi_path(
self,
model_name_map: t.Dict[t.Union[t.Type[BaseModel], t.Type[Enum]], str],
paths: t.Dict,
security_schemes: t.Dict[str, t.Any],
path_prefix: t.Optional[str] = None,
) -> None:
path, _security_schemes = self.get_child_openapi_path(
model_name_map=model_name_map
)
if path:
route_path = (
normalize_path(f"{path_prefix}/{self.route.path_format}")
if path_prefix
else self.route.path_format
)
paths.setdefault(route_path, {}).update(path)
security_schemes.update(_security_schemes)