Merge pull request #529 from python-openapi/feature/rename-validation-errors

Rename validation errors

Author: p1c2u

openapi_core/unmarshalling/request/unmarshallers.py

@@ -45,8 +45,10 @@
 from openapi_core.util import chainiters
 from openapi_core.validation.request.exceptions import MissingRequestBody
 from openapi_core.validation.request.exceptions import ParametersError
-from openapi_core.validation.request.exceptions import RequestBodyError
-from openapi_core.validation.request.exceptions import SecurityError
+from openapi_core.validation.request.exceptions import (
+    RequestBodyValidationError,
+)
+from openapi_core.validation.request.exceptions import SecurityValidationError
 from openapi_core.validation.request.validators import APICallRequestValidator
 from openapi_core.validation.request.validators import BaseRequestValidator
 from openapi_core.validation.request.validators import V30RequestBodyValidator
@@ -137,7 +139,7 @@ def _unmarshal(
     ) -> RequestUnmarshalResult:
         try:
             security = self._get_security(request.parameters, operation)
-        except SecurityError as exc:
+        except SecurityValidationError as exc:
             return RequestUnmarshalResult(errors=[exc])
 
         try:
@@ -153,7 +155,7 @@ def _unmarshal(
         except MissingRequestBody:
             body = None
             body_errors = []
-        except RequestBodyError as exc:
+        except RequestBodyValidationError as exc:
             body = None
             body_errors = [exc]
         else:
@@ -175,7 +177,7 @@ def _unmarshal_body(
         except MissingRequestBody:
             body = None
             errors = []
-        except RequestBodyError as exc:
+        except RequestBodyValidationError as exc:
             body = None
             errors = [exc]
         else:
@@ -207,7 +209,7 @@ def _unmarshal_security(
     ) -> RequestUnmarshalResult:
         try:
             security = self._get_security(request.parameters, operation)
-        except SecurityError as exc:
+        except SecurityValidationError as exc:
             return RequestUnmarshalResult(errors=[exc])
 
         return RequestUnmarshalResult(

openapi_core/unmarshalling/response/unmarshallers.py

@@ -25,7 +25,7 @@
 )
 from openapi_core.unmarshalling.unmarshallers import BaseUnmarshaller
 from openapi_core.util import chainiters
-from openapi_core.validation.response.exceptions import DataError
+from openapi_core.validation.response.exceptions import DataValidationError
 from openapi_core.validation.response.exceptions import HeadersError
 from openapi_core.validation.response.validators import (
     APICallResponseValidator,
@@ -77,7 +77,7 @@ def _unmarshal(
             validated_data = self._get_data(
                 response.data, response.mimetype, operation_response
             )
-        except DataError as exc:
+        except DataValidationError as exc:
             validated_data = None
             data_errors = [exc]
         else:
@@ -117,7 +117,7 @@ def _unmarshal_data(
             validated = self._get_data(
                 response.data, response.mimetype, operation_response
             )
-        except DataError as exc:
+        except DataValidationError as exc:
             validated = None
             data_errors = [exc]
         else:

openapi_core/validation/request/exceptions.py

@@ -24,20 +24,20 @@ def context(self) -> Iterable[OpenAPIError]:
         return self.errors
 
 
-class RequestError(ValidationError):
-    """Request error"""
+class RequestValidationError(ValidationError):
+    """Request validation error"""
 
 
-class RequestBodyError(RequestError):
+class RequestBodyValidationError(RequestValidationError):
     def __str__(self) -> str:
-        return "Request body error"
+        return "Request body validation error"
 
 
-class InvalidRequestBody(RequestBodyError, ValidateError):
+class InvalidRequestBody(RequestBodyValidationError, ValidateError):
     """Invalid request body"""
 
 
-class MissingRequestBodyError(RequestBodyError):
+class MissingRequestBodyError(RequestBodyValidationError):
     """Missing request body error"""
 
 
@@ -52,24 +52,24 @@ def __str__(self) -> str:
 
 
 @dataclass
-class ParameterError(RequestError):
+class ParameterValidationError(RequestValidationError):
     name: str
     location: str
 
     @classmethod
-    def from_spec(cls, spec: Spec) -> "ParameterError":
+    def from_spec(cls, spec: Spec) -> "ParameterValidationError":
         return cls(spec["name"], spec["in"])
 
     def __str__(self) -> str:
         return f"{self.location.title()} parameter error: {self.name}"
 
 
-class InvalidParameter(ParameterError, ValidateError):
+class InvalidParameter(ParameterValidationError, ValidateError):
     def __str__(self) -> str:
         return f"Invalid {self.location} parameter: {self.name}"
 
 
-class MissingParameterError(ParameterError):
+class MissingParameterError(ParameterValidationError):
     """Missing parameter error"""
 
 
@@ -83,9 +83,9 @@ def __str__(self) -> str:
         return f"Missing required {self.location} parameter: {self.name}"
 
 
-class SecurityError(RequestError):
+class SecurityValidationError(RequestValidationError):
     pass
 
 
-class InvalidSecurity(SecurityError, ValidateError):
+class InvalidSecurity(SecurityValidationError, ValidateError):
     """Invalid security"""

openapi_core/validation/request/validators.py

@@ -45,10 +45,12 @@
 from openapi_core.validation.request.exceptions import (
     MissingRequiredRequestBody,
 )
-from openapi_core.validation.request.exceptions import ParameterError
 from openapi_core.validation.request.exceptions import ParametersError
-from openapi_core.validation.request.exceptions import RequestBodyError
-from openapi_core.validation.request.exceptions import SecurityError
+from openapi_core.validation.request.exceptions import ParameterValidationError
+from openapi_core.validation.request.exceptions import (
+    RequestBodyValidationError,
+)
+from openapi_core.validation.request.exceptions import SecurityValidationError
 from openapi_core.validation.schemas import (
     oas30_write_schema_validators_factory,
 )
@@ -95,7 +97,7 @@ def _iter_errors(
         try:
             self._get_security(request.parameters, operation)
         # don't process if security errors
-        except SecurityError as exc:
+        except SecurityValidationError as exc:
             yield exc
             return
 
@@ -106,15 +108,15 @@ def _iter_errors(
 
         try:
             self._get_body(request.body, request.mimetype, operation)
-        except RequestBodyError as exc:
+        except RequestBodyValidationError as exc:
             yield exc
 
     def _iter_body_errors(
         self, request: BaseRequest, operation: Spec
     ) -> Iterator[Exception]:
         try:
             self._get_body(request.body, request.mimetype, operation)
-        except RequestBodyError as exc:
+        except RequestBodyValidationError as exc:
             yield exc
 
     def _iter_parameters_errors(
@@ -130,7 +132,7 @@ def _iter_security_errors(
     ) -> Iterator[Exception]:
         try:
             self._get_security(request.parameters, operation)
-        except SecurityError as exc:
+        except SecurityValidationError as exc:
             yield exc
 
     def _get_parameters(
@@ -158,7 +160,7 @@ def _get_parameters(
                 value = self._get_parameter(parameters, param)
             except MissingParameter:
                 continue
-            except ParameterError as exc:
+            except ParameterValidationError as exc:
                 errors.append(exc)
                 continue
             else:
@@ -171,7 +173,7 @@ def _get_parameters(
         return validated
 
     @ValidationErrorWrapper(
-        ParameterError,
+        ParameterValidationError,
         InvalidParameter,
         "from_spec",
         spec="param",
@@ -197,7 +199,7 @@ def _get_parameter(
                 raise MissingRequiredParameter(name, param_location)
             raise MissingParameter(name, param_location)
 
-    @ValidationErrorWrapper(SecurityError, InvalidSecurity)
+    @ValidationErrorWrapper(SecurityValidationError, InvalidSecurity)
     def _get_security(
         self, parameters: RequestParameters, operation: Spec
     ) -> Optional[Dict[str, str]]:
@@ -236,7 +238,7 @@ def _get_security_value(
         security_provider = self.security_provider_factory.create(scheme)
         return security_provider(parameters)
 
-    @ValidationErrorWrapper(RequestBodyError, InvalidRequestBody)
+    @ValidationErrorWrapper(RequestBodyValidationError, InvalidRequestBody)
     def _get_body(
         self, body: Optional[str], mimetype: str, operation: Spec
     ) -> Any:

openapi_core/validation/response/exceptions.py

@@ -14,33 +14,33 @@ class HeadersError(Exception):
     context: Iterable[OpenAPIError]
 
 
-class ResponseError(ValidationError):
+class ResponseValidationError(ValidationError):
     """Response error"""
 
 
-class DataError(ResponseError):
+class DataValidationError(ResponseValidationError):
     """Data error"""
 
 
-class InvalidData(DataError, ValidateError):
+class InvalidData(DataValidationError, ValidateError):
     """Invalid data"""
 
 
-class MissingData(DataError):
+class MissingData(DataValidationError):
     def __str__(self) -> str:
         return "Missing response data"
 
 
 @dataclass
-class HeaderError(ResponseError):
+class HeaderValidationError(ResponseValidationError):
     name: str
 
 
-class InvalidHeader(HeaderError, ValidateError):
+class InvalidHeader(HeaderValidationError, ValidateError):
     """Invalid header"""
 
 
-class MissingHeaderError(HeaderError):
+class MissingHeaderError(HeaderValidationError):
     """Missing header error"""
 
 

openapi_core/validation/response/validators.py

@@ -15,9 +15,9 @@
 from openapi_core.templating.responses.exceptions import ResponseFinderError
 from openapi_core.validation.decorators import ValidationErrorWrapper
 from openapi_core.validation.exceptions import ValidationError
-from openapi_core.validation.response.exceptions import DataError
-from openapi_core.validation.response.exceptions import HeaderError
+from openapi_core.validation.response.exceptions import DataValidationError
 from openapi_core.validation.response.exceptions import HeadersError
+from openapi_core.validation.response.exceptions import HeaderValidationError
 from openapi_core.validation.response.exceptions import InvalidData
 from openapi_core.validation.response.exceptions import InvalidHeader
 from openapi_core.validation.response.exceptions import MissingData
@@ -52,7 +52,7 @@ def _iter_errors(
 
         try:
             self._get_data(data, mimetype, operation_response)
-        except DataError as exc:
+        except DataValidationError as exc:
             yield exc
 
         try:
@@ -74,7 +74,7 @@ def _iter_data_errors(
 
         try:
             self._get_data(data, mimetype, operation_response)
-        except DataError as exc:
+        except DataValidationError as exc:
             yield exc
 
     def _iter_headers_errors(
@@ -104,7 +104,7 @@ def _get_operation_response(
         finder = ResponseFinder(operation / "responses")
         return finder.find(str(status_code))
 
-    @ValidationErrorWrapper(DataError, InvalidData)
+    @ValidationErrorWrapper(DataValidationError, InvalidData)
     def _get_data(
         self, data: str, mimetype: str, operation_response: Spec
     ) -> Any:
@@ -151,7 +151,7 @@ def _get_headers(
 
         return validated
 
-    @ValidationErrorWrapper(HeaderError, InvalidHeader, name="name")
+    @ValidationErrorWrapper(HeaderValidationError, InvalidHeader, name="name")
     def _get_header(
         self, headers: Mapping[str, Any], name: str, header: Spec
     ) -> Any: