Merge pull request #347 from p1c2u/refactor/deserializing-refactor

Deserializing refactor

Author: p1c2u

openapi_core/deserializing/exceptions.py

@@ -1,14 +1,5 @@
-from dataclasses import dataclass
-
 from openapi_core.exceptions import OpenAPIError
 
 
-@dataclass
 class DeserializeError(OpenAPIError):
     """Deserialize operation error"""
-    value: str
-    style: str
-
-    def __str__(self):
-        return "Failed to deserialize value {value} with style {style}".format(
-            value=self.value, style=self.style)

openapi_core/deserializing/media_types/deserializers.py

@@ -1,7 +1,27 @@
-from openapi_core.deserializing.exceptions import DeserializeError
+import warnings
 
+from openapi_core.deserializing.media_types.exceptions import (
+    MediaTypeDeserializeError,
+)
 
-class PrimitiveDeserializer:
+
+class BaseMediaTypeDeserializer:
+
+    def __init__(self, mimetype):
+        self.mimetype = mimetype
+
+    def __call__(self, value):
+        raise NotImplementedError
+
+
+class UnsupportedMimetypeDeserializer(BaseMediaTypeDeserializer):
+
+    def __call__(self, value):
+        warnings.warn(f"Unsupported {self.mimetype} mimetype")
+        return value
+
+
+class CallableMediaTypeDeserializer(BaseMediaTypeDeserializer):
 
     def __init__(self, mimetype, deserializer_callable):
         self.mimetype = mimetype
@@ -11,4 +31,4 @@ def __call__(self, value):
         try:
             return self.deserializer_callable(value)
         except (ValueError, TypeError, AttributeError):
-            raise DeserializeError(value, self.mimetype)
+            raise MediaTypeDeserializeError(self.mimetype, value)

openapi_core/deserializing/media_types/exceptions.py

@@ -0,0 +1,15 @@
+from dataclasses import dataclass
+
+from openapi_core.deserializing.exceptions import DeserializeError
+
+
+@dataclass
+class MediaTypeDeserializeError(DeserializeError):
+    """Media type deserialize operation error"""
+    mimetype: str
+    value: str
+
+    def __str__(self):
+        return (
+            "Failed to deserialize value with {mimetype} mimetype: {value}"
+        ).format(value=self.value, mimetype=self.mimetype)

openapi_core/deserializing/media_types/factories.py

@@ -5,7 +5,7 @@
 )
 
 from openapi_core.deserializing.media_types.deserializers import (
-    PrimitiveDeserializer,
+    CallableMediaTypeDeserializer, UnsupportedMimetypeDeserializer,
 )
 
 
@@ -25,10 +25,14 @@ def __init__(self, custom_deserializers=None):
     def create(self, mimetype):
         deserialize_callable = self.get_deserializer_callable(
             mimetype)
-        return PrimitiveDeserializer(
+
+        if deserialize_callable is None:
+            return UnsupportedMimetypeDeserializer(mimetype)
+
+        return CallableMediaTypeDeserializer(
             mimetype, deserialize_callable)
 
     def get_deserializer_callable(self, mimetype):
         if mimetype in self.custom_deserializers:
             return self.custom_deserializers[mimetype]
-        return self.MEDIA_TYPE_DESERIALIZERS.get(mimetype, lambda x: x)
+        return self.MEDIA_TYPE_DESERIALIZERS.get(mimetype)

openapi_core/deserializing/parameters/deserializers.py

@@ -2,20 +2,36 @@
 
 from openapi_core.deserializing.exceptions import DeserializeError
 from openapi_core.deserializing.parameters.exceptions import (
-    EmptyParameterValue,
+    EmptyQueryParameterValue,
 )
-from openapi_core.schema.parameters import get_aslist, get_explode, get_style
+from openapi_core.schema.parameters import get_aslist, get_explode
 
 
-class PrimitiveDeserializer:
+class BaseParameterDeserializer:
 
-    def __init__(self, param_or_header, deserializer_callable):
+    def __init__(self, param_or_header, style):
         self.param_or_header = param_or_header
+        self.style = style
+
+    def __call__(self, value):
+        raise NotImplementedError
+
+
+class UnsupportedStyleDeserializer(BaseParameterDeserializer):
+
+    def __call__(self, value):
+        warnings.warn(f"Unsupported {self.style} style")
+        return value
+
+
+class CallableParameterDeserializer(BaseParameterDeserializer):
+
+    def __init__(self, param_or_header, style, deserializer_callable):
+        super().__init__(param_or_header, style)
         self.deserializer_callable = deserializer_callable
 
         self.aslist = get_aslist(self.param_or_header)
         self.explode = get_explode(self.param_or_header)
-        self.style = get_style(self.param_or_header)
 
     def __call__(self, value):
         # if "in" not defined then it's a Header
@@ -29,12 +45,12 @@ def __call__(self, value):
         location_name = self.param_or_header.getkey('in', 'header')
         if (location_name == 'query' and value == "" and
                 not allow_empty_values):
-            name = self.param_or_header.getkey('name', 'header')
-            raise EmptyParameterValue(value, self.style, name)
+            name = self.param_or_header['name']
+            raise EmptyQueryParameterValue(name)
 
         if not self.aslist or self.explode:
             return value
         try:
             return self.deserializer_callable(value)
         except (ValueError, TypeError, AttributeError):
-            raise DeserializeError(value, self.style)
+            raise DeserializeError(location_name, self.style, value)

openapi_core/deserializing/parameters/exceptions.py

@@ -4,8 +4,32 @@
 
 
 @dataclass
-class EmptyParameterValue(DeserializeError):
+class BaseParameterDeserializeError(DeserializeError):
+    """Base parameter deserialize operation error"""
+    location: str
+
+
+@dataclass
+class ParameterDeserializeError(BaseParameterDeserializeError):
+    """Parameter deserialize operation error"""
+    style: str
+    value: str
+
+    def __str__(self):
+        return (
+            "Failed to deserialize value "
+            "of {location} parameter with style {style}: {value}"
+        ).format(location=self.location, style=self.style, value=self.value)
+
+
+@dataclass(init=False)
+class EmptyQueryParameterValue(BaseParameterDeserializeError):
     name: str
 
+    def __init__(self, name):
+        super().__init__(location='query')
+        self.name = name
+
     def __str__(self):
-        return "Value of parameter cannot be empty: {0}".format(self.name)
+        return "Value of {name} {location} parameter cannot be empty".format(
+            name=self.name, location=self.location)

openapi_core/deserializing/parameters/factories.py

@@ -1,20 +1,27 @@
+from functools import partial
+
 from openapi_core.deserializing.parameters.deserializers import (
-    PrimitiveDeserializer,
+    CallableParameterDeserializer, UnsupportedStyleDeserializer,
 )
+from openapi_core.deserializing.parameters.util import split
 from openapi_core.schema.parameters import get_style
 
 
 class ParameterDeserializersFactory:
 
     PARAMETER_STYLE_DESERIALIZERS = {
-        'form': lambda x: x.split(','),
-        'simple': lambda x: x.split(','),
-        'spaceDelimited': lambda x: x.split(' '),
-        'pipeDelimited': lambda x: x.split('|'),
+        'form': partial(split, separator=','),
+        'simple': partial(split, separator=','),
+        'spaceDelimited': partial(split, separator=' '),
+        'pipeDelimited': partial(split, separator='|'),
     }
 
-    def create(self, param):
-        style = get_style(param)
+    def create(self, param_or_header):
+        style = get_style(param_or_header)
+
+        if style not in self.PARAMETER_STYLE_DESERIALIZERS:
+            return UnsupportedStyleDeserializer(param_or_header, style)
 
         deserialize_callable = self.PARAMETER_STYLE_DESERIALIZERS[style]
-        return PrimitiveDeserializer(param, deserialize_callable)
+        return CallableParameterDeserializer(
+            param_or_header, style, deserialize_callable)

openapi_core/deserializing/parameters/util.py

@@ -0,0 +1,2 @@
+def split(value, separator=','):
+    return value.split(separator)

tests/integration/validation/test_petstore.py

@@ -8,7 +8,7 @@
 from openapi_core.casting.schemas.exceptions import CastError
 from openapi_core.deserializing.exceptions import DeserializeError
 from openapi_core.deserializing.parameters.exceptions import (
-    EmptyParameterValue,
+    EmptyQueryParameterValue,
 )
 from openapi_core.extensions.models.models import BaseModel
 from openapi_core.exceptions import (
@@ -375,7 +375,7 @@ def test_get_pets_empty_value(self, spec):
             path_pattern=path_pattern, args=query_params,
         )
 
-        with pytest.raises(EmptyParameterValue):
+        with pytest.raises(EmptyQueryParameterValue):
             spec_validate_parameters(spec, request)
         body = spec_validate_body(spec, request)
 

tests/integration/validation/test_validators.py

@@ -3,7 +3,9 @@
 import pytest
 
 from openapi_core.casting.schemas.exceptions import CastError
-from openapi_core.deserializing.exceptions import DeserializeError
+from openapi_core.deserializing.media_types.exceptions import (
+    MediaTypeDeserializeError,
+)
 from openapi_core.extensions.models.models import BaseModel
 from openapi_core.exceptions import (
     MissingRequiredParameter, MissingRequiredRequestBody,
@@ -572,7 +574,7 @@ def test_invalid_media_type(self, validator):
         result = validator.validate(request, response)
 
         assert len(result.errors) == 1
-        assert type(result.errors[0]) == DeserializeError
+        assert type(result.errors[0]) == MediaTypeDeserializeError
         assert result.data is None
         assert result.headers == {}