-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathbuilder.py
More file actions
336 lines (295 loc) · 11.4 KB
/
Copy pathbuilder.py
File metadata and controls
336 lines (295 loc) · 11.4 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
import functools
import typing as t
from ellar.common import IIdentitySchemes
from ellar.common import constants as common_constants
from ellar.common.compatible import AttributeDict, cached_property
from ellar.common.constants import GUARDS_KEY
from ellar.core.routing import (
ControllerRouteOperation,
EllarControllerMount,
RouteOperation,
)
from ellar.openapi import constants
from ellar.pydantic import (
EmailStr,
GenerateJsonSchema,
ModelField,
create_model_field,
get_definitions,
)
from ellar.pydantic import (
types as pydantic_types,
)
from .openapi_v3 import APIKeyIn, OpenAPI
from .route_doc_models import (
OpenAPIMountDocumentation,
OpenAPIRoute,
OpenAPIRouteDocumentation,
)
from .schemas import HTTPValidationError, ValidationError
if t.TYPE_CHECKING:
from ellar.app import App
default_openapi_version = "3.1.0"
AnyUrl = pydantic_types.AnyUrl
class DocumentOpenAPIFactory:
def __init__(self, document_dict: t.Dict) -> None:
self._build = document_dict
def _update_openapi_route_models(
self,
route_models: t.List[OpenAPIRoute],
model: OpenAPIMountDocumentation,
openapi_tags: AttributeDict,
) -> None:
route_models.append(model)
if openapi_tags:
self._build.setdefault("tags", []).append(openapi_tags)
def _get_openapi_route_document_models(self, app: "App") -> t.List[OpenAPIRoute]:
openapi_route_models: t.List = []
reflector = app.reflector
app_guards = list(app.get_guards())
for route in app.routes:
if (
isinstance(route, EllarControllerMount)
and len(route.routes) > 0
and route.include_in_schema
):
control_type = reflector.get(
common_constants.CONTROLLER_CLASS_KEY, route
)
assert control_type
openapi_tags = AttributeDict(
reflector.get(constants.OPENAPI_TAG, control_type) or {}
)
ignore_tag = (
reflector.get(constants.IGNORE_CONTROLLER_TYPE, control_type)
or False
)
if route.name:
openapi_tags.setdefault("name", route.name)
guards = reflector.get(GUARDS_KEY, control_type)
openapi_route_models.append(
OpenAPIMountDocumentation(
mount=route,
global_guards=guards or app_guards,
name=openapi_tags.name,
global_route_models_update=functools.partial(
self._update_openapi_route_models, openapi_route_models
),
)
)
if openapi_tags and not ignore_tag:
self._build.setdefault("tags", []).append(openapi_tags)
elif (
isinstance(route, (RouteOperation, ControllerRouteOperation))
and route.include_in_schema
):
openapi = (
reflector.get(constants.OPENAPI_OPERATION_KEY, route.endpoint) or {}
)
guards = reflector.get(GUARDS_KEY, route.endpoint) or app.get_guards()
openapi_route_models.append(
OpenAPIRouteDocumentation(route=route, guards=guards, **openapi)
)
return openapi_route_models
def _get_operations_models(
self, routes: t.List[OpenAPIRoute]
) -> t.List[ModelField]:
operation_models = []
for route in routes:
operation_models.extend(route.get_route_models())
return operation_models
@cached_property
def error_model_fields(
self,
) -> t.List[ModelField]:
_model_fields = []
for schema in [ValidationError, HTTPValidationError]:
model_field = create_model_field(name=schema.__name__, type_=schema)
_model_fields.append(model_field)
return _model_fields
def create_document(self, app: "App") -> OpenAPI:
openapi_route_models = self._get_openapi_route_document_models(app=app)
components: t.Dict[str, t.Dict[str, t.Any]] = {}
paths: t.Dict[str, t.Dict[str, t.Any]] = self._build.setdefault("paths", {})
_flat_model = (
self._get_operations_models(openapi_route_models) + self.error_model_fields
)
schema_generator = GenerateJsonSchema(ref_template=constants.REF_TEMPLATE)
field_mapping, definitions = get_definitions(
fields=_flat_model,
schema_generator=schema_generator,
separate_input_output_schemas=True,
)
# mounts: t.List[t.Union[BaseRoute, EllarControllerMount, Mount]] = []
# for _, item in app.injector.get_templating_modules().items():
# mounts.extend(item.routers)
for route in openapi_route_models:
security_schemes: t.Dict[str, t.Any] = {}
route.get_openapi_path(
field_mapping=field_mapping,
paths=paths,
security_schemes=security_schemes,
)
if security_schemes:
components.setdefault("securitySchemes", {}).update(security_schemes)
identity_schemes = app.injector.get(IIdentitySchemes)
for auth in identity_schemes.get_authentication_schemes():
security_scheme = auth.openapi_security_scheme()
if security_scheme:
components.setdefault("securitySchemes", {}).update(security_scheme)
# scheme_name = list(security_scheme.keys())[0]
# self._build.setdefault("security", []).append(
# {scheme_name: getattr(auth, "openapi_scope", [])}
# )
if definitions:
components["schemas"] = {k: definitions[k] for k in sorted(definitions)}
if components:
self._build.setdefault("components", {}).update(components)
return OpenAPI(**self._build)
class OpenAPIDocumentBuilder:
def __init__(self) -> None:
self._build: t.Dict = {}
self._build.setdefault("info", {}).update(
title="Ellar API Docs", version="1.0.0"
)
self._build.setdefault("tags", [])
self._build.setdefault("openapi", default_openapi_version)
# self.add_server("/", description="development server")
def set_openapi_version(self, openapi_version: str) -> "OpenAPIDocumentBuilder":
"""
Sets OpenAPI version
This is not fully supported yet
:param openapi_version:
:return: "OpenAPIDocumentBuilder"
"""
self._build["openapi"] = openapi_version
return self
def set_title(self, title: str) -> "OpenAPIDocumentBuilder":
self._build["info"]["title"] = title
return self
def set_version(self, version: str) -> "OpenAPIDocumentBuilder":
self._build["info"]["version"] = version
return self
def set_description(self, description: str) -> "OpenAPIDocumentBuilder":
self._build["info"]["description"] = description
return self
def set_term_of_service(self, term_of_service: str) -> "OpenAPIDocumentBuilder":
self._build["info"]["termsOfService"] = term_of_service
return self
def set_contact(
self,
name: str,
url: t.Optional[t.Union[AnyUrl, str]] = None,
email: t.Optional[t.Union[EmailStr, str]] = None,
) -> "OpenAPIDocumentBuilder":
self._build["info"]["contact"] = {"name": name, "url": url, "email": email}
return self
def set_license(
self, name: str, url: t.Optional[t.Union[AnyUrl, str]] = None
) -> "OpenAPIDocumentBuilder":
self._build["info"]["license"] = {"name": name, "url": url}
return self
def set_external_doc(
self, url: AnyUrl, description: t.Optional[str] = None
) -> "OpenAPIDocumentBuilder":
self._build["externalDocs"] = {"url": url, "description": description}
return self
def add_server(
self,
url: t.Union[AnyUrl, str],
description: t.Optional[str] = None,
**variables: t.Union[str, t.List[str]],
) -> "OpenAPIDocumentBuilder":
self._build.setdefault("servers", []).append(
{"url": url, "description": description, "variables": variables}
)
return self
def add_tags(
self,
name: str,
description: t.Optional[str] = None,
external_doc_url: t.Optional[t.Union[AnyUrl, str]] = None,
external_doc_description: t.Optional[str] = None,
) -> "OpenAPIDocumentBuilder":
data: t.Dict = {"name": name, "description": description}
if external_doc_url:
data["externalDocs"] = {
"description": external_doc_description,
"url": external_doc_url,
}
self._build.setdefault("tags", []).append(data)
return self
def add_security_requirements(
self, name: str, requirements: t.List[str]
) -> "OpenAPIDocumentBuilder":
self._build.setdefault("security", []).append({name: requirements})
return self
def add_security(self, name: str, options: t.Dict) -> "OpenAPIDocumentBuilder":
self._build.setdefault("components", {}).setdefault(
"securitySchemes", {}
).update({name: options})
return self
def add_api_key(
self,
openapi_in: APIKeyIn,
openapi_description: t.Optional[str] = None,
name: str = "api_key",
) -> "OpenAPIDocumentBuilder":
return self.add_security(
name=name,
options={
"type": "apiKey",
"description": openapi_description,
"in": openapi_in.value,
"name": name,
},
)
def add_basic_auth(
self,
openapi_scheme: str = "basic",
openapi_description: t.Optional[str] = None,
name: str = "basic",
) -> "OpenAPIDocumentBuilder":
return self.add_security(
name=name,
options={
"type": "http",
"description": openapi_description,
"scheme": openapi_scheme,
"name": name,
},
)
def add_bearer_auth(
self,
openapi_description: t.Optional[str] = None,
name: str = "bearer",
bearer_format: str = "JWT",
) -> "OpenAPIDocumentBuilder":
return self.add_security(
name=name,
options={
"type": "http",
"description": openapi_description,
"scheme": "bearer",
"bearerFormat": bearer_format,
"name": name,
},
)
def add_cookie_auth(
self,
cookie_name: str,
openapi_description: t.Optional[str] = None,
security_name: str = "cookie",
) -> "OpenAPIDocumentBuilder":
return self.add_security(
name=security_name,
options={
"type": "apiKey",
"description": openapi_description,
"in": APIKeyIn.cookie.value,
"name": cookie_name,
},
)
def build_document(self, app: "App") -> OpenAPI:
build_action = DocumentOpenAPIFactory(document_dict=self._build)
return build_action.create_document(app)