Exceptions restructure

Author: p1c2u

openapi_core/exceptions.py

@@ -0,0 +1,9 @@
+"""OpenAPI core schema exceptions module"""
+
+
+class OpenAPIError(Exception):
+    pass
+
+
+class OpenAPIMappingError(OpenAPIError):
+    pass

openapi_core/schema/exceptions.py

@@ -0,0 +1,13 @@
+from openapi_core.schema.exceptions import OpenAPIMappingError
+
+
+class OpenAPIMediaTypeError(OpenAPIMappingError):
+    pass
+
+
+class InvalidMediaTypeValue(OpenAPIMediaTypeError):
+    pass
+
+
+class InvalidContentType(OpenAPIMediaTypeError):
+    pass

openapi_core/schema/media_types/exceptions.py

@@ -2,9 +2,9 @@
 from collections import defaultdict
 
 from json import loads
-from six import iteritems
 
-from openapi_core.exceptions import InvalidValueType, InvalidMediaTypeValue
+from openapi_core.schema.media_types.exceptions import InvalidMediaTypeValue
+from openapi_core.schema.schemas.exceptions import InvalidSchemaValue
 
 
 MEDIA_TYPE_DESERIALIZERS = {
@@ -42,5 +42,5 @@ def unmarshal(self, value):
 
         try:
             return self.schema.unmarshal(deserialized)
-        except InvalidValueType as exc:
+        except InvalidSchemaValue as exc:
             raise InvalidMediaTypeValue(str(exc))

openapi_core/schema/media_types/models.py

@@ -0,0 +1,9 @@
+from openapi_core.schema.exceptions import OpenAPIMappingError
+
+
+class OpenAPIOperationError(OpenAPIMappingError):
+    pass
+
+
+class InvalidOperation(OpenAPIOperationError):
+    pass

openapi_core/schema/operations/exceptions.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """OpenAPI core operations models module"""
-from openapi_core.exceptions import InvalidResponse
+from openapi_core.schema.responses.exceptions import InvalidResponse
 
 
 class Operation(object):
@@ -21,6 +21,7 @@ def __getitem__(self, name):
         return self.parameters[name]
 
     def get_response(self, http_status='default'):
+        # @todo: move to Responses object
         try:
             return self.responses[http_status]
         except KeyError:

openapi_core/schema/operations/models.py

@@ -0,0 +1,21 @@
+from openapi_core.schema.exceptions import OpenAPIMappingError
+
+
+class OpenAPIParameterError(OpenAPIMappingError):
+    pass
+
+
+class MissingParameter(OpenAPIParameterError):
+    pass
+
+
+class MissingRequiredParameter(OpenAPIParameterError):
+    pass
+
+
+class EmptyParameterValue(OpenAPIParameterError):
+    pass
+
+
+class InvalidParameterValue(OpenAPIParameterError):
+    pass

openapi_core/schema/parameters/exceptions.py

@@ -2,11 +2,13 @@
 import logging
 import warnings
 
-from openapi_core.exceptions import (
-    EmptyValue, InvalidValueType, InvalidParameterValue,
-)
 from openapi_core.schema.parameters.enums import ParameterLocation, ParameterStyle
+from openapi_core.schema.parameters.exceptions import (
+    MissingRequiredParameter, MissingParameter, InvalidParameterValue,
+    EmptyParameterValue,
+)
 from openapi_core.schema.schemas.enums import SchemaType
+from openapi_core.schema.schemas.exceptions import InvalidSchemaValue
 
 log = logging.getLogger(__name__)
 
@@ -68,6 +70,27 @@ def deserialize(self, value):
         deserializer = self.get_dererializer()
         return deserializer(value)
 
+    def get_value(self, request):
+        location = request.parameters[self.location.value]
+
+        try:
+            raw = location[self.name]
+        except KeyError:
+            if self.required:
+                raise MissingRequiredParameter(
+                    "Missing required `{0}` parameter".format(self.name))
+
+            if not self.schema or self.schema.default is None:
+                raise MissingParameter(
+                    "Missing `{0}` parameter".format(self.name))
+            
+            raw = self.schema.default
+
+        if self.aslist and self.explode:
+            return location.getlist(self.name)
+
+        return raw
+
     def unmarshal(self, value):
         if self.deprecated:
             warnings.warn(
@@ -77,7 +100,7 @@ def unmarshal(self, value):
 
         if (self.location == ParameterLocation.QUERY and value == "" and
                 not self.allow_empty_value):
-            raise EmptyValue(
+            raise EmptyParameterValue(
                 "Value of {0} parameter cannot be empty".format(self.name))
 
         if not self.schema:
@@ -87,5 +110,5 @@ def unmarshal(self, value):
 
         try:
             return self.schema.unmarshal(deserialized)
-        except InvalidValueType as exc:
+        except InvalidSchemaValue as exc:
             raise InvalidParameterValue(str(exc))

openapi_core/schema/parameters/models.py

@@ -0,0 +1,9 @@
+from openapi_core.schema.exceptions import OpenAPIMappingError
+
+
+class OpenAPIRequestBodyError(OpenAPIMappingError):
+    pass
+
+
+class MissingRequestBody(OpenAPIRequestBodyError):
+    pass

openapi_core/schema/request_bodies/exceptions.py

@@ -1,5 +1,7 @@
 """OpenAPI core request bodies models module"""
-from openapi_core.exceptions import InvalidContentType
+
+from openapi_core.schema.media_types.exceptions import InvalidContentType
+from openapi_core.schema.request_bodies.exceptions import MissingRequestBody
 
 
 class RequestBody(object):
@@ -15,3 +17,9 @@ def __getitem__(self, mimetype):
         except KeyError:
             raise InvalidContentType(
                 "Invalid mime type `{0}`".format(mimetype))
+
+    def get_value(self, request):
+        if not request.body and self.required:
+            raise MissingRequestBody("Missing required request body")
+
+        return request.body

openapi_core/schema/request_bodies/models.py

@@ -0,0 +1,13 @@
+from openapi_core.schema.exceptions import OpenAPIMappingError
+
+
+class OpenAPIResponseError(OpenAPIMappingError):
+    pass
+
+
+class InvalidResponse(OpenAPIResponseError):
+    pass
+
+
+class MissingResponseContent(OpenAPIResponseError):
+    pass

openapi_core/schema/responses/exceptions.py

@@ -1,5 +1,6 @@
 """OpenAPI core responses models module"""
-from openapi_core.exceptions import InvalidContentType
+from openapi_core.schema.media_types.exceptions import InvalidContentType
+from openapi_core.schema.responses.exceptions import MissingResponseContent
 
 
 class Response(object):
@@ -19,3 +20,9 @@ def __getitem__(self, mimetype):
         except KeyError:
             raise InvalidContentType(
                 "Invalid mime type `{0}`".format(mimetype))
+
+    def get_value(self, response):
+        if not response.data:
+            raise MissingResponseContent("Missing response content")
+
+        return response.data

openapi_core/schema/responses/models.py

@@ -0,0 +1,17 @@
+from openapi_core.schema.exceptions import OpenAPIMappingError
+
+
+class OpenAPISchemaError(OpenAPIMappingError):
+    pass
+
+
+class InvalidSchemaValue(OpenAPISchemaError):
+    pass
+
+
+class UndefinedSchemaProperty(OpenAPISchemaError):
+    pass
+
+
+class MissingSchemaProperty(OpenAPISchemaError):
+    pass

openapi_core/schema/schemas/exceptions.py

@@ -5,11 +5,11 @@
 
 from six import iteritems
 
-from openapi_core.exceptions import (
-    InvalidValueType, UndefinedSchemaProperty, MissingProperty, InvalidValue,
-)
 from openapi_core.extensions.models.factories import ModelFactory
 from openapi_core.schema.schemas.enums import SchemaType, SchemaFormat
+from openapi_core.schema.schemas.exceptions import (
+    InvalidSchemaValue, UndefinedSchemaProperty, MissingSchemaProperty,
+)
 from openapi_core.schema.schemas.util import forcebool
 
 log = logging.getLogger(__name__)
@@ -74,7 +74,7 @@ def cast(self, value):
         """Cast value to schema type"""
         if value is None:
             if not self.nullable:
-                raise InvalidValueType("Null value for non-nullable schema")
+                raise InvalidSchemaValue("Null value for non-nullable schema")
             return self.default
 
         if self.type is None:
@@ -89,7 +89,7 @@ def cast(self, value):
         try:
             return cast_callable(value)
         except ValueError:
-            raise InvalidValueType(
+            raise InvalidSchemaValue(
                 "Failed to cast value of {0} to {1}".format(value, self.type)
             )
 
@@ -104,7 +104,7 @@ def unmarshal(self, value):
             return None
 
         if self.enum and casted not in self.enum:
-            raise InvalidValue(
+            raise InvalidSchemaValue(
                 "Value of {0} not in enum choices: {1}".format(
                     value, self.enum)
             )
@@ -116,7 +116,8 @@ def _unmarshal_collection(self, value):
 
     def _unmarshal_object(self, value):
         if not isinstance(value, (dict, )):
-            raise InvalidValueType("Value of {0} not an object".format(value))
+            raise InvalidSchemaValue(
+                "Value of {0} not an object".format(value))
 
         all_properties = self.get_all_properties()
         all_required_properties = self.get_all_required_properties()
@@ -135,7 +136,7 @@ def _unmarshal_object(self, value):
                 prop_value = value[prop_name]
             except KeyError:
                 if prop_name in all_required_properties:
-                    raise MissingProperty(
+                    raise MissingSchemaProperty(
                         "Missing schema property {0}".format(prop_name))
                 if not prop.nullable and not prop.default:
                     continue

openapi_core/schema/schemas/models.py

@@ -0,0 +1,9 @@
+from openapi_core.schema.exceptions import OpenAPIMappingError
+
+
+class OpenAPIServerError(OpenAPIMappingError):
+    pass
+
+
+class InvalidServer(OpenAPIServerError):
+    pass

openapi_core/schema/servers/exceptions.py

@@ -4,7 +4,8 @@
 
 from openapi_spec_validator import openapi_v3_spec_validator
 
-from openapi_core.exceptions import InvalidOperation, InvalidServer
+from openapi_core.schema.operations.exceptions import InvalidOperation
+from openapi_core.schema.servers.exceptions import InvalidServer
 from openapi_core.schema.components.factories import ComponentsFactory
 from openapi_core.schema.infos.factories import InfoFactory
 from openapi_core.schema.paths.generators import PathsGenerator

openapi_core/schema/specs/factories.py

@@ -3,7 +3,8 @@
 import logging
 from functools import partialmethod
 
-from openapi_core.exceptions import InvalidOperation, InvalidServer
+from openapi_core.schema.operations.exceptions import InvalidOperation
+from openapi_core.schema.servers.exceptions import InvalidServer
 
 
 log = logging.getLogger(__name__)