Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 238da55

Browse files
p1c2up1c2u
committed
Get rid of create_spec shortcut
1 parent 5e9af67 commit 238da55

33 files changed

+235
-200
lines changed

‎README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ Firstly create your specification object:
6262
.. code-block:: python
6363
6464
from json import load
65-
from openapi_core import create_spec
65+
from openapi_core import OpenAPISpec as Spec
6666
6767
with open('openapi.json', 'r') as spec_file:
6868
spec_dict = load(spec_file)
6969
70-
spec = create_spec(spec_dict)
70+
spec = OpenAPISpec.from_dict(spec_dict)
7171
7272
Request
7373
*******

‎docs/customizations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ By default, spec dict is validated on spec creation time. Disabling the validati
88

99
.. code-block:: python
1010
11-
from openapi_core import create_spec
11+
from openapi_core import OpenAPISpec as Spec
1212
13-
spec = create_spec(spec_dict, validate_spec=False)
13+
spec = Spec.from_dict(spec_dict, validate=False)
1414
1515
Deserializers
1616
-------------

‎docs/integrations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware` to your `M
2121
.. code-block:: python
2222
2323
# settings.py
24-
from openapi_core import create_spec
24+
from openapi_core import OpenAPISpec as Spec
2525
2626
MIDDLEWARE = [
2727
# ...
2828
'openapi_core.contrib.django.middlewares.DjangoOpenAPIMiddleware',
2929
]
3030
31-
OPENAPI_SPEC = create_spec(spec_dict)
31+
OPENAPI_SPEC = Spec.from_dict(spec_dict)
3232
3333
After that you have access to validation result object with all validated request data from Django view through request object.
3434

‎docs/usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Firstly create your specification: object
66
.. code-block:: python
77
88
from json import load
9-
from openapi_core import create_spec
9+
from openapi_core import OpenAPISpec as Spec
1010
1111
with open('openapi.json', 'r') as spec_file:
1212
spec_dict = load(spec_file)
1313
14-
spec = create_spec(spec_dict)
14+
spec = Spec.from_dict(spec_dict)
1515
1616
1717
Request

‎openapi_core/__init__.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
"""OpenAPI core module"""
2-
from openapi_core.shortcuts import create_spec
32
from openapi_core.shortcuts import spec_validate_body
43
from openapi_core.shortcuts import spec_validate_data
54
from openapi_core.shortcuts import spec_validate_headers
65
from openapi_core.shortcuts import spec_validate_parameters
76
from openapi_core.shortcuts import spec_validate_security
87
from openapi_core.shortcuts import validate_request
98
from openapi_core.shortcuts import validate_response
9+
from openapi_core.spec import OpenAPIv30Spec
1010
from openapi_core.validation.request.validators import RequestBodyValidator
1111
from openapi_core.validation.request.validators import (
1212
RequestParametersValidator,
@@ -26,7 +26,9 @@
2626
__license__ = "BSD 3-Clause License"
2727

2828
__all__ = [
29-
"create_spec",
29+
"OpenAPIv30Spec",
30+
"OpenAPIv3Spec",
31+
"OpenAPISpec",
3032
"validate_request",
3133
"validate_response",
3234
"spec_validate_body",
@@ -42,3 +44,9 @@
4244
"ResponseDataValidator",
4345
"ResponseHeadersValidator",
4446
]
47+
48+
# aliases to the latest v3 version
49+
OpenAPIv3Spec = OpenAPIv30Spec
50+
51+
# aliases to the latest version
52+
OpenAPISpec = OpenAPIv3Spec

‎openapi_core/shortcuts.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
"""OpenAPI core shortcuts module"""
22
# backward compatibility
3-
from openapi_core.spec.shortcuts import create_spec
43
from openapi_core.validation.request.shortcuts import spec_validate_body
54
from openapi_core.validation.request.shortcuts import spec_validate_parameters
65
from openapi_core.validation.request.shortcuts import spec_validate_security
@@ -10,7 +9,6 @@
109
from openapi_core.validation.response.shortcuts import validate_response
1110

1211
__all__ = [
13-
"create_spec",
1412
"validate_request",
1513
"validate_response",
1614
"spec_validate_body",

‎openapi_core/spec/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from openapi_core.spec.paths import OpenAPIv30Spec
2+
3+
__all__ = [
4+
"OpenAPIv30Spec",
5+
]

‎openapi_core/spec/paths.py

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,37 @@
1+
from jsonschema.validators import RefResolver
2+
from openapi_spec_validator import default_handlers
3+
from openapi_spec_validator import openapi_v3_spec_validator
4+
from openapi_spec_validator.validators import Dereferencer
15
from pathable.paths import AccessorPath
26

37
from openapi_core.spec.accessors import SpecAccessor
48

59
SPEC_SEPARATOR = "#"
610

711

8-
class SpecPath(AccessorPath):
12+
class Spec(AccessorPath):
13+
14+
validator = NotImplemented
15+
916
@classmethod
10-
def from_spec(cls, spec_dict, dereferencer=None, *args, **kwargs):
11-
separator = kwargs.pop("separator", SPEC_SEPARATOR)
12-
accessor = SpecAccessor(spec_dict, dereferencer)
17+
def from_dict(
18+
cls,
19+
data,
20+
url="",
21+
ref_resolver_handlers=default_handlers,
22+
separator=SPEC_SEPARATOR,
23+
validate=True,
24+
*args
25+
):
26+
if validate:
27+
cls.validator.validate(data, spec_url=url)
28+
29+
ref_resolver = RefResolver(url, data, handlers=ref_resolver_handlers)
30+
dereferencer = Dereferencer(ref_resolver)
31+
accessor = SpecAccessor(data, dereferencer)
1332
return cls(accessor, *args, separator=separator)
33+
34+
35+
class OpenAPIv30Spec(Spec):
36+
37+
validator = openapi_v3_spec_validator

‎openapi_core/templating/paths/util.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
from typing import Tuple
22

3-
from openapi_core.spec.paths import SpecPath
3+
from openapi_core.spec.paths import OpenAPIv30Spec as Spec
44
from openapi_core.templating.datatypes import TemplateResult
55

66

7-
def template_path_len(template_path: Tuple[SpecPath, TemplateResult]) -> int:
7+
def template_path_len(template_path: Tuple[Spec, TemplateResult]) -> int:
88
return len(template_path[1].variables)

‎tests/integration/contrib/django/data/v3.0/djangoproject/settings.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
import yaml
1717

18-
from openapi_core import create_spec
18+
from openapi_core import OpenAPISpec as Spec
1919

2020
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
2121
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -123,4 +123,4 @@
123123

124124
OPENAPI_SPEC_DICT = yaml.load(OPENAPI_SPEC_PATH.read_text(), yaml.Loader)
125125

126-
OPENAPI_SPEC = create_spec(OPENAPI_SPEC_DICT)
126+
OPENAPI_SPEC = Spec.from_dict(OPENAPI_SPEC_DICT)

0 commit comments

Comments
 (0)