Flask factories; Get rid of wrappers

Author: p1c2u

README.rst

@@ -81,7 +81,7 @@ or use shortcuts for simple validation
    validated_params = validate_parameters(spec, request)
    validated_body = validate_body(spec, request)
 
-Request object should implement BaseOpenAPIRequest interface. You can use FlaskOpenAPIRequest a Flask/Werkzeug request wrapper implementation:
+Request object should be instance of OpenAPIRequest class. You can use FlaskOpenAPIRequest a Flask/Werkzeug request factory:
 
 .. code-block:: python
 
@@ -92,16 +92,16 @@ Request object should implement BaseOpenAPIRequest interface. You can use FlaskO
    validator = RequestValidator(spec)
    result = validator.validate(openapi_request)
 
-or specify request wrapper class for shortcuts
+or simply specify request factory for shortcuts
 
 .. code-block:: python
 
    from openapi_core import validate_parameters, validate_body
 
    validated_params = validate_parameters(
-       spec, request, wrapper_class=FlaskOpenAPIRequest)
+       spec, request, request_factory=FlaskOpenAPIRequest)
    validated_body = validate_body(
-       spec, request, wrapper_class=FlaskOpenAPIRequest)
+       spec, request, request_factory=FlaskOpenAPIRequest)
 
 You can also validate responses
 
@@ -136,7 +136,7 @@ or use shortcuts for simple validation
 
    validated_data = validate_data(spec, request, response)
 
-Response object should implement BaseOpenAPIResponse interface. You can use FlaskOpenAPIResponse a Flask/Werkzeug response wrapper implementation:
+Response object should be instance of OpenAPIResponse class. You can use FlaskOpenAPIResponse a Flask/Werkzeug response factory:
 
 .. code-block:: python
 
@@ -147,14 +147,14 @@ Response object should implement BaseOpenAPIResponse interface. You can use Flas
    validator = ResponseValidator(spec)
    result = validator.validate(openapi_request, openapi_response)
 
-or specify response wrapper class for shortcuts
+or simply specify response factory for shortcuts
 
 .. code-block:: python
 
    from openapi_core import validate_parameters, validate_body
 
    validated_data = validate_data(
-       spec, request, response, response_wrapper_class=FlaskOpenAPIResponse)
+       spec, request, response, response_factory=FlaskOpenAPIResponse)
 
 Related projects
 ================

openapi_core/contrib/flask/__init__.py

@@ -1,4 +1,11 @@
-from openapi_core.contrib.flask.requests import FlaskOpenAPIRequest
-from openapi_core.contrib.flask.responses import FlaskOpenAPIResponse
+from openapi_core.contrib.flask.requests import FlaskOpenAPIRequestFactory
+from openapi_core.contrib.flask.responses import FlaskOpenAPIResponseFactory
 
-__all__ = ['FlaskOpenAPIRequest', 'FlaskOpenAPIResponse']
+# backward compatibility
+FlaskOpenAPIRequest = FlaskOpenAPIRequestFactory.create
+FlaskOpenAPIResponse = FlaskOpenAPIResponseFactory.create
+
+__all__ = [
+    'FlaskOpenAPIRequestFactory', 'FlaskOpenAPIResponseFactory',
+    'FlaskOpenAPIRequest', 'FlaskOpenAPIResponse',
+]

openapi_core/contrib/flask/requests.py

@@ -1,51 +1,39 @@
 """OpenAPI core contrib flask requests module"""
 import re
 
-from openapi_core.wrappers.base import BaseOpenAPIRequest
+from openapi_core.validation.request.datatypes import (
+    RequestParameters, OpenAPIRequest,
+)
 
 # http://flask.pocoo.org/docs/1.0/quickstart/#variable-rules
 PATH_PARAMETER_PATTERN = r'<(?:(?:string|int|float|path|uuid):)?(\w+)>'
 
 
-class FlaskOpenAPIRequest(BaseOpenAPIRequest):
+class FlaskOpenAPIRequestFactory(object):
 
     path_regex = re.compile(PATH_PARAMETER_PATTERN)
 
-    def __init__(self, request):
-        self.request = request
-
-    @property
-    def host_url(self):
-        return self.request.host_url
-
-    @property
-    def path(self):
-        return self.request.path
-
-    @property
-    def method(self):
-        return self.request.method.lower()
-
-    @property
-    def path_pattern(self):
-        if self.request.url_rule is None:
-            return self.path
-
-        return self.path_regex.sub(r'{\1}', self.request.url_rule.rule)
-
-    @property
-    def parameters(self):
-        return {
-            'path': self.request.view_args,
-            'query': self.request.args,
-            'header': self.request.headers,
-            'cookie': self.request.cookies,
-        }
-
-    @property
-    def body(self):
-        return self.request.data
-
-    @property
-    def mimetype(self):
-        return self.request.mimetype
+    @classmethod
+    def create(cls, request):
+        method = request.method.lower()
+
+        if request.url_rule is None:
+            path_pattern = request.path
+        else:
+            path_pattern = cls.path_regex.sub(r'{\1}', request.url_rule.rule)
+
+        parameters = RequestParameters(
+            path=request.view_args,
+            query=request.args,
+            header=request.headers,
+            cookie=request.cookies,
+        )
+        return OpenAPIRequest(
+            host_url=request.host_url,
+            path=request.path,
+            path_pattern=path_pattern,
+            method=method,
+            parameters=parameters,
+            body=request.data,
+            mimetype=request.mimetype,
+        )

openapi_core/contrib/flask/responses.py

@@ -1,22 +1,15 @@
 """OpenAPI core contrib flask responses module"""
 import re
 
-from openapi_core.wrappers.base import BaseOpenAPIResponse
+from openapi_core.validation.response.datatypes import OpenAPIResponse
 
 
-class FlaskOpenAPIResponse(BaseOpenAPIResponse):
+class FlaskOpenAPIResponseFactory(object):
 
-    def __init__(self, response):
-        self.response = response
-
-    @property
-    def data(self):
-        return self.response.data
-
-    @property
-    def status_code(self):
-        return self.response._status_code
-
-    @property
-    def mimetype(self):
-        return self.response.mimetype
+    @classmethod
+    def create(cls, response):
+        return OpenAPIResponse(
+            data=response.data,
+            status_code=response._status_code,
+            mimetype=response.mimetype,
+        )

openapi_core/shortcuts.py

@@ -20,9 +20,9 @@ def create_spec(spec_dict, spec_url=''):
     return spec_factory.create(spec_dict, spec_url=spec_url)
 
 
-def validate_parameters(spec, request, wrapper_class=None):
-    if wrapper_class is not None:
-        request = wrapper_class(request)
+def validate_parameters(spec, request, request_factory=None):
+    if request_factory is not None:
+        request = request_factory(request)
 
     validator = RequestValidator(spec)
     result = validator.validate(request)
@@ -38,9 +38,9 @@ def validate_parameters(spec, request, wrapper_class=None):
         return result.parameters
 
 
-def validate_body(spec, request, wrapper_class=None):
-    if wrapper_class is not None:
-        request = wrapper_class(request)
+def validate_body(spec, request, request_factory=None):
+    if request_factory is not None:
+        request = request_factory(request)
 
     validator = RequestValidator(spec)
     result = validator.validate(request)
@@ -55,13 +55,13 @@ def validate_body(spec, request, wrapper_class=None):
 
 def validate_data(
         spec, request, response,
-        request_wrapper_class=None,
-        response_wrapper_class=None):
-    if request_wrapper_class is not None:
-        request = request_wrapper_class(request)
+        request_factory=None,
+        response_factory=None):
+    if request_factory is not None:
+        request = request_factory(request)
 
-    if response_wrapper_class is not None:
-        response = response_wrapper_class(response)
+    if response_factory is not None:
+        response = response_factory(response)
 
     validator = ResponseValidator(spec)
     result = validator.validate(request, response)

openapi_core/wrappers/__init__.py

@@ -4,12 +4,13 @@
 from werkzeug.routing import Map, Rule, Subdomain
 from werkzeug.test import create_environ
 
-from openapi_core.shortcuts import create_spec
-from openapi_core.validation.response.validators import ResponseValidator
-from openapi_core.validation.request.validators import RequestValidator
 from openapi_core.contrib.flask import (
     FlaskOpenAPIRequest, FlaskOpenAPIResponse,
 )
+from openapi_core.shortcuts import create_spec
+from openapi_core.validation.request.datatypes import RequestParameters
+from openapi_core.validation.request.validators import RequestValidator
+from openapi_core.validation.response.validators import ResponseValidator
 
 
 @pytest.fixture
@@ -67,12 +68,12 @@ def test_simple(self, request_factory, request):
         query = ImmutableMultiDict([])
         headers = EnvironHeaders(request.environ)
         cookies = {}
-        assert openapi_request.parameters == {
-            'path': path,
-            'query': query,
-            'header': headers,
-            'cookie': cookies,
-        }
+        assert openapi_request.parameters == RequestParameters(
+            path=path,
+            query=query,
+            header=headers,
+            cookie=cookies,
+        )
         assert openapi_request.host_url == request.host_url
         assert openapi_request.path == request.path
         assert openapi_request.method == request.method.lower()
@@ -92,12 +93,12 @@ def test_multiple_values(self, request_factory, request):
         ])
         headers = EnvironHeaders(request.environ)
         cookies = {}
-        assert openapi_request.parameters == {
-            'path': path,
-            'query': query,
-            'header': headers,
-            'cookie': cookies,
-        }
+        assert openapi_request.parameters == RequestParameters(
+            path=path,
+            query=query,
+            header=headers,
+            cookie=cookies,
+        )
         assert openapi_request.host_url == request.host_url
         assert openapi_request.path == request.path
         assert openapi_request.method == request.method.lower()
@@ -114,12 +115,12 @@ def test_url_rule(self, request_factory, request):
         query = ImmutableMultiDict([])
         headers = EnvironHeaders(request.environ)
         cookies = {}
-        assert openapi_request.parameters == {
-            'path': path,
-            'query': query,
-            'header': headers,
-            'cookie': cookies,
-        }
+        assert openapi_request.parameters == RequestParameters(
+            path=path,
+            query=query,
+            header=headers,
+            cookie=cookies,
+        )
         assert openapi_request.host_url == request.host_url
         assert openapi_request.path == request.path
         assert openapi_request.method == request.method.lower()
@@ -135,7 +136,6 @@ def test_invalid_server(self, response_factory):
 
         openapi_response = FlaskOpenAPIResponse(response)
 
-        assert openapi_response.response == response
         assert openapi_response.data == response.data
         assert openapi_response.status_code == response._status_code
         assert openapi_response.mimetype == response.mimetype
@@ -145,7 +145,7 @@ class TestFlaskOpenAPIValidation(object):
 
     @pytest.fixture
     def flask_spec(self, factory):
-        specfile = 'data/v3.0/flask_wrapper.yaml'
+        specfile = 'data/v3.0/flask_factory.yaml'
         return create_spec(factory.spec_from_file(specfile))
 
     def test_response_validator_path_pattern(self,

openapi_core/wrappers/base.py

@@ -1,6 +1,6 @@
 openapi: "3.0.0"
 info:
-  title: Basic OpenAPI specification used with test_wrappers.TestFlaskOpenAPIIValidation
+  title: Basic OpenAPI specification used with test_flask.TestFlaskOpenAPIIValidation
   version: "0.1"
 servers:
   - url: 'http://localhost'