connexion.exceptions¶
This module defines Exception classes used by Connexion to generate a proper response.
Module Contents¶
- exception connexion.exceptions.ConnexionException¶
Bases:
ExceptionCommon base class for all non-exit exceptions.
Initialize self. See help(type(self)) for accurate signature.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __str__()¶
Return str(self).
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.ProblemException(status=400, title=None, detail=None, type=None, instance=None, headers=None, ext=None)¶
Bases:
ConnexionExceptionCommon base class for all non-exit exceptions.
This exception holds arguments that are going to be passed to the connexion.problem function to generate a proper response.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __str__()¶
Return str(self).
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.ResolverError(reason='Unknown reason', exc_info=None)¶
Bases:
LookupErrorBase class for lookup errors.
- Parameters
reason (str) – Reason why the resolver failed.
exc_info (tuple | None) – If specified, gives details of the original exception as returned by sys.exc_info()
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- __str__(self)¶
Return str(self).
- __repr__(self)¶
Return repr(self).
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.InvalidSpecification¶
Bases:
ConnexionException,jsonschema.exceptions.ValidationErrorCommon base class for all non-exit exceptions.
Initialize self. See help(type(self)) for accurate signature.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __str__()¶
Return str(self).
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- classmethod create_from(cls, other)¶
- property absolute_path(self)¶
- property absolute_schema_path(self)¶
- property json_path(self)¶
- exception connexion.exceptions.NonConformingResponse(reason='Unknown Reason', message=None)¶
Bases:
ProblemExceptionCommon base class for all non-exit exceptions.
- Parameters
reason (str) – Reason why the response did not conform to the specification
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- __str__(self)¶
Return str(self).
- __repr__(self)¶
Return repr(self).
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.AuthenticationProblem(status, title, detail)¶
Bases:
ProblemExceptionCommon base class for all non-exit exceptions.
This exception holds arguments that are going to be passed to the connexion.problem function to generate a proper response.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __str__()¶
Return str(self).
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.ResolverProblem(status, title, detail)¶
Bases:
ProblemExceptionCommon base class for all non-exit exceptions.
This exception holds arguments that are going to be passed to the connexion.problem function to generate a proper response.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __str__()¶
Return str(self).
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.BadRequestProblem(title='Bad Request', detail=None)¶
Bases:
ProblemExceptionCommon base class for all non-exit exceptions.
This exception holds arguments that are going to be passed to the connexion.problem function to generate a proper response.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __str__()¶
Return str(self).
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.UnsupportedMediaTypeProblem(title='Unsupported Media Type', detail=None)¶
Bases:
ProblemExceptionCommon base class for all non-exit exceptions.
This exception holds arguments that are going to be passed to the connexion.problem function to generate a proper response.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __str__()¶
Return str(self).
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.NonConformingResponseBody(message, reason='Response body does not conform to specification')¶
Bases:
NonConformingResponseCommon base class for all non-exit exceptions.
- Parameters
reason (str) – Reason why the response did not conform to the specification
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- __str__(self)¶
Return str(self).
- __repr__(self)¶
Return repr(self).
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.NonConformingResponseHeaders(message, reason='Response headers do not conform to specification')¶
Bases:
NonConformingResponseCommon base class for all non-exit exceptions.
- Parameters
reason (str) – Reason why the response did not conform to the specification
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- __str__(self)¶
Return str(self).
- __repr__(self)¶
Return repr(self).
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.OAuthProblem(description: Optional[str] = None, response: Optional[werkzeug.sansio.response.Response] = None, www_authenticate: Optional[Union[werkzeug.datastructures.WWWAuthenticate, Iterable[werkzeug.datastructures.WWWAuthenticate]]] = None)¶
Bases:
werkzeug.exceptions.Unauthorized401
UnauthorizedRaise if the user is not authorized to access a resource.
The
www_authenticateargument should be used to set theWWW-Authenticateheader. This is used for HTTP basic auth and other schemes. UseWWWAuthenticateto create correctly formatted values. Strictly speaking a 401 response is invalid if it doesn’t provide at least one value for this header, although real clients typically don’t care.- Parameters
description – Override the default message used for the body of the response.
www-authenticate – A single value, or list of values, for the WWW-Authenticate header(s).
Changed in version 2.0: Serialize multiple
www_authenticateitems into multipleWWW-Authenticateheaders, rather than joining them into a single value, for better interoperability.Changed in version 0.15.3: If the
www_authenticateargument is not set, theWWW-Authenticateheader is not set.Changed in version 0.15.3: The
responseargument was restored.Changed in version 0.15.1:
descriptionwas moved back as the first argument, restoring its previous position.Changed in version 0.15.0:
www_authenticatewas added as the first argument, ahead ofdescription.Initialize self. See help(type(self)) for accurate signature.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- code = 401¶
- description = The server could not verify that you are authorized to access the URL requested. You either...¶
- get_headers(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) List[Tuple[str, str]]¶
Get a list of headers.
- classmethod wrap(cls, exception: Type[BaseException], name: Optional[str] = None) Type[HTTPException]¶
Create an exception that is a subclass of the calling HTTP exception and the
exceptionargument.The first argument to the class will be passed to the wrapped
exception, the rest to the HTTP exception. Ife.argsis not empty ande.show_exceptionisTrue, the wrapped exception message is added to the HTTP error description.Deprecated since version 2.0: Will be removed in Werkzeug 2.1. Create a subclass manually instead.
Changed in version 0.15.5: The
show_exceptionattribute controls whether the description includes the wrapped exception message.Changed in version 0.15.0: The description includes the wrapped exception message.
- property name(self) str¶
The status name.
- get_description(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) str¶
Get the description.
- get_body(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) str¶
Get the HTML body.
- get_response(self, environ: Optional[Union[_typeshed.wsgi.WSGIEnvironment, werkzeug.wrappers.request.Request]] = None, scope: Optional[dict] = None) werkzeug.sansio.response.Response¶
Get a response object. If one was passed to the exception it’s returned directly.
- Parameters
environ – the optional environ for the request. This can be used to modify the response depending on how the request looked like.
- Returns
a
Responseobject or a subclass thereof.
- __call__(self, environ: _typeshed.wsgi.WSGIEnvironment, start_response: _typeshed.wsgi.StartResponse) Iterable[bytes]¶
Call the exception as WSGI application.
- Parameters
environ – the WSGI environment.
start_response – the response callable provided by the WSGI server.
- __str__(self) str¶
Return str(self).
- __repr__(self) str¶
Return repr(self).
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.OAuthResponseProblem(token_response, **kwargs)¶
Bases:
OAuthProblem401
UnauthorizedRaise if the user is not authorized to access a resource.
The
www_authenticateargument should be used to set theWWW-Authenticateheader. This is used for HTTP basic auth and other schemes. UseWWWAuthenticateto create correctly formatted values. Strictly speaking a 401 response is invalid if it doesn’t provide at least one value for this header, although real clients typically don’t care.- Parameters
description – Override the default message used for the body of the response.
www-authenticate – A single value, or list of values, for the WWW-Authenticate header(s).
Changed in version 2.0: Serialize multiple
www_authenticateitems into multipleWWW-Authenticateheaders, rather than joining them into a single value, for better interoperability.Changed in version 0.15.3: If the
www_authenticateargument is not set, theWWW-Authenticateheader is not set.Changed in version 0.15.3: The
responseargument was restored.Changed in version 0.15.1:
descriptionwas moved back as the first argument, restoring its previous position.Changed in version 0.15.0:
www_authenticatewas added as the first argument, ahead ofdescription.Initialize self. See help(type(self)) for accurate signature.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- code = 401¶
- description = The server could not verify that you are authorized to access the URL requested. You either...¶
- get_headers(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) List[Tuple[str, str]]¶
Get a list of headers.
- classmethod wrap(cls, exception: Type[BaseException], name: Optional[str] = None) Type[HTTPException]¶
Create an exception that is a subclass of the calling HTTP exception and the
exceptionargument.The first argument to the class will be passed to the wrapped
exception, the rest to the HTTP exception. Ife.argsis not empty ande.show_exceptionisTrue, the wrapped exception message is added to the HTTP error description.Deprecated since version 2.0: Will be removed in Werkzeug 2.1. Create a subclass manually instead.
Changed in version 0.15.5: The
show_exceptionattribute controls whether the description includes the wrapped exception message.Changed in version 0.15.0: The description includes the wrapped exception message.
- property name(self) str¶
The status name.
- get_description(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) str¶
Get the description.
- get_body(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) str¶
Get the HTML body.
- get_response(self, environ: Optional[Union[_typeshed.wsgi.WSGIEnvironment, werkzeug.wrappers.request.Request]] = None, scope: Optional[dict] = None) werkzeug.sansio.response.Response¶
Get a response object. If one was passed to the exception it’s returned directly.
- Parameters
environ – the optional environ for the request. This can be used to modify the response depending on how the request looked like.
- Returns
a
Responseobject or a subclass thereof.
- __call__(self, environ: _typeshed.wsgi.WSGIEnvironment, start_response: _typeshed.wsgi.StartResponse) Iterable[bytes]¶
Call the exception as WSGI application.
- Parameters
environ – the WSGI environment.
start_response – the response callable provided by the WSGI server.
- __str__(self) str¶
Return str(self).
- __repr__(self) str¶
Return repr(self).
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.OAuthScopeProblem(token_scopes, required_scopes, **kwargs)¶
Bases:
werkzeug.exceptions.Forbidden403 Forbidden
Raise if the user doesn’t have the permission for the requested resource but was authenticated.
Initialize self. See help(type(self)) for accurate signature.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- code = 403¶
- description = You don't have the permission to access the requested resource. It is either read-protected or...¶
- classmethod wrap(cls, exception: Type[BaseException], name: Optional[str] = None) Type[HTTPException]¶
Create an exception that is a subclass of the calling HTTP exception and the
exceptionargument.The first argument to the class will be passed to the wrapped
exception, the rest to the HTTP exception. Ife.argsis not empty ande.show_exceptionisTrue, the wrapped exception message is added to the HTTP error description.Deprecated since version 2.0: Will be removed in Werkzeug 2.1. Create a subclass manually instead.
Changed in version 0.15.5: The
show_exceptionattribute controls whether the description includes the wrapped exception message.Changed in version 0.15.0: The description includes the wrapped exception message.
- property name(self) str¶
The status name.
- get_description(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) str¶
Get the description.
- get_body(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) str¶
Get the HTML body.
- get_headers(self, environ: Optional[_typeshed.wsgi.WSGIEnvironment] = None, scope: Optional[dict] = None) List[Tuple[str, str]]¶
Get a list of headers.
- get_response(self, environ: Optional[Union[_typeshed.wsgi.WSGIEnvironment, werkzeug.wrappers.request.Request]] = None, scope: Optional[dict] = None) werkzeug.sansio.response.Response¶
Get a response object. If one was passed to the exception it’s returned directly.
- Parameters
environ – the optional environ for the request. This can be used to modify the response depending on how the request looked like.
- Returns
a
Responseobject or a subclass thereof.
- __call__(self, environ: _typeshed.wsgi.WSGIEnvironment, start_response: _typeshed.wsgi.StartResponse) Iterable[bytes]¶
Call the exception as WSGI application.
- Parameters
environ – the WSGI environment.
start_response – the response callable provided by the WSGI server.
- __str__(self) str¶
Return str(self).
- __repr__(self) str¶
Return repr(self).
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception connexion.exceptions.ExtraParameterProblem(formdata_parameters, query_parameters, title=None, detail=None, **kwargs)¶
Bases:
ProblemExceptionCommon base class for all non-exit exceptions.
This exception holds arguments that are going to be passed to the connexion.problem function to generate a proper response.
- class __cause__¶
exception cause
- class __context__¶
exception context
- class __suppress_context__¶
- class __traceback__¶
- class args¶
- to_problem(self)¶
- __delattr__()¶
Implement delattr(self, name).
- __dir__()¶
Default dir() implementation.
- __eq__()¶
Return self==value.
- __format__()¶
Default object formatter.
- __ge__()¶
Return self>=value.
- __getattribute__()¶
Return getattr(self, name).
- __gt__()¶
Return self>value.
- __hash__()¶
Return hash(self).
- __le__()¶
Return self<=value.
- __lt__()¶
Return self<value.
- __ne__()¶
Return self!=value.
- __reduce__()¶
Helper for pickle.
- __reduce_ex__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__()¶
Implement setattr(self, name, value).
- __setstate__()¶
- __sizeof__()¶
Size of object in memory, in bytes.
- __str__()¶
Return str(self).
- __subclasshook__()¶
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.