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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
"""OpenAPI core app module"""
from functools import cached_property
from pathlib import Path
from typing import Optional
from jsonschema._utils import Unset
from jsonschema.validators import _UNSET
from jsonschema_path import SchemaPath
from jsonschema_path.handlers.protocols import SupportsRead
from jsonschema_path.typing import Schema
from openapi_spec_validator import validate
from openapi_spec_validator.validation.exceptions import ValidatorDetectError
from openapi_spec_validator.versions.datatypes import SpecVersion
from openapi_spec_validator.versions.exceptions import OpenAPIVersionNotFound
from openapi_spec_validator.versions.shortcuts import get_spec_version
from openapi_core.configurations import Config
from openapi_core.exceptions import SpecError
from openapi_core.protocols import Request
from openapi_core.protocols import Response
from openapi_core.protocols import WebhookRequest
from openapi_core.types import AnyRequest
from openapi_core.unmarshalling.request import (
UNMARSHALLERS as REQUEST_UNMARSHALLERS,
)
from openapi_core.unmarshalling.request import (
WEBHOOK_UNMARSHALLERS as WEBHOOK_REQUEST_UNMARSHALLERS,
)
from openapi_core.unmarshalling.request.datatypes import RequestUnmarshalResult
from openapi_core.unmarshalling.request.protocols import RequestUnmarshaller
from openapi_core.unmarshalling.request.protocols import (
WebhookRequestUnmarshaller,
)
from openapi_core.unmarshalling.request.types import RequestUnmarshallerType
from openapi_core.unmarshalling.request.types import (
WebhookRequestUnmarshallerType,
)
from openapi_core.unmarshalling.response import (
UNMARSHALLERS as RESPONSE_UNMARSHALLERS,
)
from openapi_core.unmarshalling.response import (
WEBHOOK_UNMARSHALLERS as WEBHOOK_RESPONSE_UNMARSHALLERS,
)
from openapi_core.unmarshalling.response.datatypes import (
ResponseUnmarshalResult,
)
from openapi_core.unmarshalling.response.protocols import ResponseUnmarshaller
from openapi_core.unmarshalling.response.protocols import (
WebhookResponseUnmarshaller,
)
from openapi_core.unmarshalling.response.types import ResponseUnmarshallerType
from openapi_core.unmarshalling.response.types import (
WebhookResponseUnmarshallerType,
)
from openapi_core.validation.request import VALIDATORS as REQUEST_VALIDATORS
from openapi_core.validation.request import (
WEBHOOK_VALIDATORS as WEBHOOK_REQUEST_VALIDATORS,
)
from openapi_core.validation.request.protocols import RequestValidator
from openapi_core.validation.request.protocols import WebhookRequestValidator
from openapi_core.validation.request.types import RequestValidatorType
from openapi_core.validation.request.types import WebhookRequestValidatorType
from openapi_core.validation.response import VALIDATORS as RESPONSE_VALIDATORS
from openapi_core.validation.response import (
WEBHOOK_VALIDATORS as WEBHOOK_RESPONSE_VALIDATORS,
)
from openapi_core.validation.response.protocols import ResponseValidator
from openapi_core.validation.response.protocols import WebhookResponseValidator
from openapi_core.validation.response.types import ResponseValidatorType
from openapi_core.validation.response.types import WebhookResponseValidatorType
class OpenAPI:
"""OpenAPI class."""
def __init__(
self,
spec: SchemaPath,
config: Optional[Config] = None,
):
if not isinstance(spec, SchemaPath):
raise TypeError("'spec' argument is not type of SchemaPath")
self.spec = spec
self.config = config or Config()
self.check_spec()
@classmethod
def from_dict(
cls, data: Schema, config: Optional[Config] = None, base_uri: str = ""
) -> "OpenAPI":
sp = SchemaPath.from_dict(data, base_uri=base_uri)
return cls(sp, config=config)
@classmethod
def from_path(
cls, path: Path, config: Optional[Config] = None
) -> "OpenAPI":
sp = SchemaPath.from_path(path)
return cls(sp, config=config)
@classmethod
def from_file_path(
cls, file_path: str, config: Optional[Config] = None
) -> "OpenAPI":
sp = SchemaPath.from_file_path(file_path)
return cls(sp, config=config)
@classmethod
def from_file(
cls,
fileobj: SupportsRead,
config: Optional[Config] = None,
base_uri: str = "",
) -> "OpenAPI":
sp = SchemaPath.from_file(fileobj, base_uri=base_uri)
return cls(sp, config=config)
def _get_version(self) -> SpecVersion:
try:
return get_spec_version(self.spec.contents())
# backward compatibility
except OpenAPIVersionNotFound:
raise SpecError("Spec schema version not detected")
def check_spec(self) -> None:
if self.config.spec_validator_cls is None:
return
cls = None
if self.config.spec_validator_cls is not _UNSET:
cls = self.config.spec_validator_cls
try:
validate(
self.spec.contents(),
base_uri=self.config.spec_base_uri
or self.spec.accessor.resolver._base_uri, # type: ignore[attr-defined]
cls=cls,
)
except ValidatorDetectError:
raise SpecError("spec not detected")
@property
def version(self) -> SpecVersion:
return self._get_version()
@cached_property
def request_validator_cls(self) -> Optional[RequestValidatorType]:
if not isinstance(self.config.request_validator_cls, Unset):
return self.config.request_validator_cls
return REQUEST_VALIDATORS.get(self.version)
@cached_property
def response_validator_cls(self) -> Optional[ResponseValidatorType]:
if not isinstance(self.config.response_validator_cls, Unset):
return self.config.response_validator_cls
return RESPONSE_VALIDATORS.get(self.version)
@cached_property
def webhook_request_validator_cls(
self,
) -> Optional[WebhookRequestValidatorType]:
if not isinstance(self.config.webhook_request_validator_cls, Unset):
return self.config.webhook_request_validator_cls
return WEBHOOK_REQUEST_VALIDATORS.get(self.version)
@cached_property
def webhook_response_validator_cls(
self,
) -> Optional[WebhookResponseValidatorType]:
if not isinstance(self.config.webhook_response_validator_cls, Unset):
return self.config.webhook_response_validator_cls
return WEBHOOK_RESPONSE_VALIDATORS.get(self.version)
@cached_property
def request_unmarshaller_cls(self) -> Optional[RequestUnmarshallerType]:
if not isinstance(self.config.request_unmarshaller_cls, Unset):
return self.config.request_unmarshaller_cls
return REQUEST_UNMARSHALLERS.get(self.version)
@cached_property
def response_unmarshaller_cls(self) -> Optional[ResponseUnmarshallerType]:
if not isinstance(self.config.response_unmarshaller_cls, Unset):
return self.config.response_unmarshaller_cls
return RESPONSE_UNMARSHALLERS.get(self.version)
@cached_property
def webhook_request_unmarshaller_cls(
self,
) -> Optional[WebhookRequestUnmarshallerType]:
if not isinstance(self.config.webhook_request_unmarshaller_cls, Unset):
return self.config.webhook_request_unmarshaller_cls
return WEBHOOK_REQUEST_UNMARSHALLERS.get(self.version)
@cached_property
def webhook_response_unmarshaller_cls(
self,
) -> Optional[WebhookResponseUnmarshallerType]:
if not isinstance(
self.config.webhook_response_unmarshaller_cls, Unset
):
return self.config.webhook_response_unmarshaller_cls
return WEBHOOK_RESPONSE_UNMARSHALLERS.get(self.version)
@cached_property
def request_validator(self) -> RequestValidator:
if self.request_validator_cls is None:
raise SpecError("Validator class not found")
return self.request_validator_cls(
self.spec,
base_url=self.config.server_base_url,
style_deserializers_factory=self.config.style_deserializers_factory,
media_type_deserializers_factory=self.config.media_type_deserializers_factory,
schema_casters_factory=self.config.schema_casters_factory,
schema_validators_factory=self.config.schema_validators_factory,
path_finder_cls=self.config.path_finder_cls,
spec_validator_cls=self.config.spec_validator_cls,
extra_format_validators=self.config.extra_format_validators,
extra_media_type_deserializers=self.config.extra_media_type_deserializers,
security_provider_factory=self.config.security_provider_factory,
)
@cached_property
def response_validator(self) -> ResponseValidator:
if self.response_validator_cls is None:
raise SpecError("Validator class not found")
return self.response_validator_cls(
self.spec,
base_url=self.config.server_base_url,
style_deserializers_factory=self.config.style_deserializers_factory,
media_type_deserializers_factory=self.config.media_type_deserializers_factory,
schema_casters_factory=self.config.schema_casters_factory,
schema_validators_factory=self.config.schema_validators_factory,
path_finder_cls=self.config.path_finder_cls,
spec_validator_cls=self.config.spec_validator_cls,
extra_format_validators=self.config.extra_format_validators,
extra_media_type_deserializers=self.config.extra_media_type_deserializers,
)
@cached_property
def webhook_request_validator(self) -> WebhookRequestValidator:
if self.webhook_request_validator_cls is None:
raise SpecError("Validator class not found")
return self.webhook_request_validator_cls(
self.spec,
base_url=self.config.server_base_url,
style_deserializers_factory=self.config.style_deserializers_factory,
media_type_deserializers_factory=self.config.media_type_deserializers_factory,
schema_casters_factory=self.config.schema_casters_factory,
schema_validators_factory=self.config.schema_validators_factory,
path_finder_cls=self.config.webhook_path_finder_cls,
spec_validator_cls=self.config.spec_validator_cls,
extra_format_validators=self.config.extra_format_validators,
extra_media_type_deserializers=self.config.extra_media_type_deserializers,
security_provider_factory=self.config.security_provider_factory,
)
@cached_property
def webhook_response_validator(self) -> WebhookResponseValidator:
if self.webhook_response_validator_cls is None:
raise SpecError("Validator class not found")
return self.webhook_response_validator_cls(
self.spec,
base_url=self.config.server_base_url,
style_deserializers_factory=self.config.style_deserializers_factory,
media_type_deserializers_factory=self.config.media_type_deserializers_factory,
schema_casters_factory=self.config.schema_casters_factory,
schema_validators_factory=self.config.schema_validators_factory,
path_finder_cls=self.config.webhook_path_finder_cls,
spec_validator_cls=self.config.spec_validator_cls,
extra_format_validators=self.config.extra_format_validators,
extra_media_type_deserializers=self.config.extra_media_type_deserializers,
)
@cached_property
def request_unmarshaller(self) -> RequestUnmarshaller:
if self.request_unmarshaller_cls is None:
raise SpecError("Unmarshaller class not found")
return self.request_unmarshaller_cls(
self.spec,
base_url=self.config.server_base_url,
style_deserializers_factory=self.config.style_deserializers_factory,
media_type_deserializers_factory=self.config.media_type_deserializers_factory,
schema_casters_factory=self.config.schema_casters_factory,
schema_validators_factory=self.config.schema_validators_factory,
path_finder_cls=self.config.path_finder_cls,
spec_validator_cls=self.config.spec_validator_cls,
extra_format_validators=self.config.extra_format_validators,
extra_media_type_deserializers=self.config.extra_media_type_deserializers,
security_provider_factory=self.config.security_provider_factory,
schema_unmarshallers_factory=self.config.schema_unmarshallers_factory,
extra_format_unmarshallers=self.config.extra_format_unmarshallers,
)
@cached_property
def response_unmarshaller(self) -> ResponseUnmarshaller:
if self.response_unmarshaller_cls is None:
raise SpecError("Unmarshaller class not found")
return self.response_unmarshaller_cls(
self.spec,
base_url=self.config.server_base_url,
style_deserializers_factory=self.config.style_deserializers_factory,
media_type_deserializers_factory=self.config.media_type_deserializers_factory,
schema_casters_factory=self.config.schema_casters_factory,
schema_validators_factory=self.config.schema_validators_factory,
path_finder_cls=self.config.path_finder_cls,
spec_validator_cls=self.config.spec_validator_cls,
extra_format_validators=self.config.extra_format_validators,
extra_media_type_deserializers=self.config.extra_media_type_deserializers,
schema_unmarshallers_factory=self.config.schema_unmarshallers_factory,
extra_format_unmarshallers=self.config.extra_format_unmarshallers,
)
@cached_property
def webhook_request_unmarshaller(self) -> WebhookRequestUnmarshaller:
if self.webhook_request_unmarshaller_cls is None:
raise SpecError("Unmarshaller class not found")
return self.webhook_request_unmarshaller_cls(
self.spec,
base_url=self.config.server_base_url,
style_deserializers_factory=self.config.style_deserializers_factory,
media_type_deserializers_factory=self.config.media_type_deserializers_factory,
schema_casters_factory=self.config.schema_casters_factory,
schema_validators_factory=self.config.schema_validators_factory,
path_finder_cls=self.config.webhook_path_finder_cls,
spec_validator_cls=self.config.spec_validator_cls,
extra_format_validators=self.config.extra_format_validators,
extra_media_type_deserializers=self.config.extra_media_type_deserializers,
security_provider_factory=self.config.security_provider_factory,
schema_unmarshallers_factory=self.config.schema_unmarshallers_factory,
extra_format_unmarshallers=self.config.extra_format_unmarshallers,
)
@cached_property
def webhook_response_unmarshaller(self) -> WebhookResponseUnmarshaller:
if self.webhook_response_unmarshaller_cls is None:
raise SpecError("Unmarshaller class not found")
return self.webhook_response_unmarshaller_cls(
self.spec,
base_url=self.config.server_base_url,
style_deserializers_factory=self.config.style_deserializers_factory,
media_type_deserializers_factory=self.config.media_type_deserializers_factory,
schema_casters_factory=self.config.schema_casters_factory,
schema_validators_factory=self.config.schema_validators_factory,
path_finder_cls=self.config.webhook_path_finder_cls,
spec_validator_cls=self.config.spec_validator_cls,
extra_format_validators=self.config.extra_format_validators,
extra_media_type_deserializers=self.config.extra_media_type_deserializers,
schema_unmarshallers_factory=self.config.schema_unmarshallers_factory,
extra_format_unmarshallers=self.config.extra_format_unmarshallers,
)
def validate_request(self, request: AnyRequest) -> None:
if isinstance(request, WebhookRequest):
self.validate_webhook_request(request)
else:
self.validate_apicall_request(request)
def validate_response(
self, request: AnyRequest, response: Response
) -> None:
if isinstance(request, WebhookRequest):
self.validate_webhook_response(request, response)
else:
self.validate_apicall_response(request, response)
def validate_apicall_request(self, request: Request) -> None:
if not isinstance(request, Request):
raise TypeError("'request' argument is not type of Request")
self.request_validator.validate(request)
def validate_apicall_response(
self, request: Request, response: Response
) -> None:
if not isinstance(request, Request):
raise TypeError("'request' argument is not type of Request")
if not isinstance(response, Response):
raise TypeError("'response' argument is not type of Response")
self.response_validator.validate(request, response)
def validate_webhook_request(self, request: WebhookRequest) -> None:
if not isinstance(request, WebhookRequest):
raise TypeError("'request' argument is not type of WebhookRequest")
self.webhook_request_validator.validate(request)
def validate_webhook_response(
self, request: WebhookRequest, response: Response
) -> None:
if not isinstance(request, WebhookRequest):
raise TypeError("'request' argument is not type of WebhookRequest")
if not isinstance(response, Response):
raise TypeError("'response' argument is not type of Response")
self.webhook_response_validator.validate(request, response)
def unmarshal_request(self, request: AnyRequest) -> RequestUnmarshalResult:
if isinstance(request, WebhookRequest):
return self.unmarshal_webhook_request(request)
else:
return self.unmarshal_apicall_request(request)
def unmarshal_response(
self, request: AnyRequest, response: Response
) -> ResponseUnmarshalResult:
if isinstance(request, WebhookRequest):
return self.unmarshal_webhook_response(request, response)
else:
return self.unmarshal_apicall_response(request, response)
def unmarshal_apicall_request(
self, request: Request
) -> RequestUnmarshalResult:
if not isinstance(request, Request):
raise TypeError("'request' argument is not type of Request")
return self.request_unmarshaller.unmarshal(request)
def unmarshal_apicall_response(
self, request: Request, response: Response
) -> ResponseUnmarshalResult:
if not isinstance(request, Request):
raise TypeError("'request' argument is not type of Request")
if not isinstance(response, Response):
raise TypeError("'response' argument is not type of Response")
return self.response_unmarshaller.unmarshal(request, response)
def unmarshal_webhook_request(
self, request: WebhookRequest
) -> RequestUnmarshalResult:
if not isinstance(request, WebhookRequest):
raise TypeError("'request' argument is not type of WebhookRequest")
return self.webhook_request_unmarshaller.unmarshal(request)
def unmarshal_webhook_response(
self, request: WebhookRequest, response: Response
) -> ResponseUnmarshalResult:
if not isinstance(request, WebhookRequest):
raise TypeError("'request' argument is not type of WebhookRequest")
if not isinstance(response, Response):
raise TypeError("'response' argument is not type of Response")
return self.webhook_response_unmarshaller.unmarshal(request, response)
|
