mirror of
https://github.com/LukeHagar/connexion.git
synced 2025-12-10 20:37:50 +00:00
b0b83c4879
* Converting response to raise a ProblemException * Centralizing around ProblemException for errors in the app. * Adding the ability to skip error handlers, allow for defining exception payload. * Fixing flake8 * Fixed some bugs found through unit testing. * Unit tests are now passing. * Added problem back to __init__ * Updating based on the feedback from the PR.
143 lines
5.0 KiB
Python
143 lines
5.0 KiB
Python
import warnings
|
|
from jsonschema.exceptions import ValidationError
|
|
from werkzeug.exceptions import Forbidden, Unauthorized
|
|
|
|
from .problem import problem
|
|
|
|
|
|
class ConnexionException(Exception):
|
|
pass
|
|
|
|
|
|
class ProblemException(ConnexionException):
|
|
def __init__(self, status=400, title=None, detail=None, type=None,
|
|
instance=None, headers=None, ext=None):
|
|
"""
|
|
This exception is holds arguments that are going to be passed to the
|
|
`connexion.problem` function to generate a propert response.
|
|
"""
|
|
self.status = status
|
|
self.title = title
|
|
self.detail = detail
|
|
self.type = type
|
|
self.instance = instance
|
|
self.headers = headers
|
|
self.ext = ext
|
|
|
|
def to_problem(self):
|
|
warnings.warn(
|
|
"'to_problem' is planned to be removed in a future release. "
|
|
"Call connexion.problem.problem(..) instead to maintain the existing error response.", DeprecationWarning)
|
|
return problem(status=self.status, title=self.title, detail=self.detail,
|
|
type=self.type, instance=self.instance, headers=self.headers,
|
|
ext=self.ext)
|
|
|
|
|
|
class ResolverError(LookupError):
|
|
def __init__(self, reason='Unknown reason', exc_info=None):
|
|
"""
|
|
:param reason: Reason why the resolver failed.
|
|
:type reason: str
|
|
:param exc_info: If specified, gives details of the original exception
|
|
as returned by sys.exc_info()
|
|
:type exc_info: tuple | None
|
|
"""
|
|
self.reason = reason
|
|
self.exc_info = exc_info
|
|
|
|
def __str__(self): # pragma: no cover
|
|
return '<ResolverError: {}>'.format(self.reason)
|
|
|
|
def __repr__(self): # pragma: no cover
|
|
return '<ResolverError: {}>'.format(self.reason)
|
|
|
|
|
|
class InvalidSpecification(ConnexionException, ValidationError):
|
|
pass
|
|
|
|
|
|
class NonConformingResponse(ProblemException):
|
|
def __init__(self, reason='Unknown Reason', message=None):
|
|
"""
|
|
:param reason: Reason why the response did not conform to the specification
|
|
:type reason: str
|
|
"""
|
|
super(NonConformingResponse, self).__init__(status=500, title=reason, detail=message)
|
|
self.reason = reason
|
|
self.message = message
|
|
|
|
def __str__(self): # pragma: no cover
|
|
return '<NonConformingResponse: {}>'.format(self.reason)
|
|
|
|
def __repr__(self): # pragma: no cover
|
|
return '<NonConformingResponse: {}>'.format(self.reason)
|
|
|
|
|
|
class AuthenticationProblem(ProblemException):
|
|
|
|
def __init__(self, status, title, detail):
|
|
super(AuthenticationProblem, self).__init__(status=status, title=title, detail=detail)
|
|
|
|
|
|
class ResolverProblem(ProblemException):
|
|
|
|
def __init__(self, status, title, detail):
|
|
super(ResolverProblem, self).__init__(status=status, title=title, detail=detail)
|
|
|
|
|
|
class BadRequestProblem(ProblemException):
|
|
|
|
def __init__(self, title='Bad Request', detail=None):
|
|
super(BadRequestProblem, self).__init__(status=400, title=title, detail=detail)
|
|
|
|
|
|
class UnsupportedMediaTypeProblem(ProblemException):
|
|
|
|
def __init__(self, title="Unsupported Media Type", detail=None):
|
|
super(UnsupportedMediaTypeProblem, self).__init__(status=415, title=title, detail=detail)
|
|
|
|
|
|
class NonConformingResponseBody(NonConformingResponse):
|
|
def __init__(self, message, reason="Response body does not conform to specification"):
|
|
super(NonConformingResponseBody, self).__init__(reason=reason, message=message)
|
|
|
|
|
|
class NonConformingResponseHeaders(NonConformingResponse):
|
|
def __init__(self, message, reason="Response headers do not conform to specification"):
|
|
super(NonConformingResponseHeaders, self).__init__(reason=reason, message=message)
|
|
|
|
|
|
class OAuthProblem(Unauthorized):
|
|
pass
|
|
|
|
|
|
class OAuthResponseProblem(OAuthProblem):
|
|
def __init__(self, token_response, **kwargs):
|
|
self.token_response = token_response
|
|
super(OAuthResponseProblem, self).__init__(**kwargs)
|
|
|
|
|
|
class OAuthScopeProblem(Forbidden):
|
|
def __init__(self, token_scopes, required_scopes, **kwargs):
|
|
self.required_scopes = required_scopes
|
|
self.token_scopes = token_scopes
|
|
|
|
super(OAuthScopeProblem, self).__init__(**kwargs)
|
|
|
|
|
|
class ExtraParameterProblem(ProblemException):
|
|
def __init__(self, formdata_parameters, query_parameters, title=None, detail=None, **kwargs):
|
|
self.extra_formdata = formdata_parameters
|
|
self.extra_query = query_parameters
|
|
|
|
# This keep backwards compatibility with the old returns
|
|
if detail is None:
|
|
if self.extra_query:
|
|
detail = "Extra {parameter_type} parameter(s) {extra_params} not in spec"\
|
|
.format(parameter_type='query', extra_params=', '.join(self.extra_query))
|
|
elif self.extra_formdata:
|
|
detail = "Extra {parameter_type} parameter(s) {extra_params} not in spec"\
|
|
.format(parameter_type='formData', extra_params=', '.join(self.extra_formdata))
|
|
|
|
super(ExtraParameterProblem, self).__init__(title=title, detail=detail, **kwargs)
|