Source code for

# -*- coding: utf-8 -*-
# TheVirtualBrain-Framework Package. This package holds all Data Management, and
# Web-UI helpful to run brain-simulations. To use it, you also need to download
# TheVirtualBrain-Scientific Package (for simulators). See content of the
# documentation-folder for more details. See also
# (c) 2012-2024, Baycrest Centre for Geriatric Care ("Baycrest") and others
# This program is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.  See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with this
# program.  If not, see <>.
# When using The Virtual Brain for scientific publications, please cite it as explained here:

from abc import abstractmethod

from tvb.basic.exceptions import TVBException

[docs] class BaseRestException(TVBException): def __init__(self, message=None, code=None, payload=None): Exception.__init__(self) self.message = message if message is not None and message.strip() else self.get_default_message() self.code = code self.payload = payload
[docs] def to_dict(self): payload = dict(self.payload or ()) payload['message'] = self.message payload['code'] = self.code return payload
[docs] @abstractmethod def get_default_message(self): return None
[docs] class BadRequestException(BaseRestException): def __init__(self, message, payload=None): super(BadRequestException, self).__init__(message, code=HTTP_STATUS_BAD_REQUEST, payload=payload)
[docs] def get_default_message(self): return "Bad request error"
[docs] class InvalidIdentifierException(BaseRestException): def __init__(self, message=None, payload=None): super(InvalidIdentifierException, self).__init__(message, code=HTTP_STATUS_NOT_FOUND, payload=payload)
[docs] def get_default_message(self): return "No data found for the given identifier"
[docs] class AuthorizationRequestException(BaseRestException): def __init__(self, message=None, code=HTTP_STATUS_DENIED): super(AuthorizationRequestException, self).__init__(message, code)
[docs] def get_default_message(self): return "Token is missing."
[docs] class InvalidInputException(BadRequestException): def __init__(self, message=None, payload=None): super(InvalidInputException, self).__init__(message, payload=payload)
[docs] def get_default_message(self): return "The input file is incomplete"
[docs] class ServiceException(BaseRestException): message_prefix = "Something went wrong on the server side" def __init__(self, message, code=HTTP_STATUS_SERVER_ERROR, payload=None): super(ServiceException, self).__init__(message, code, payload) self.message = self.message_prefix + ": " + message
[docs] def get_default_message(self): return self.message_prefix
[docs] class ClientException(BaseRestException): def __init__(self, message, code=HTTP_STATUS_BAD_REQUEST): super(ClientException, self).__init__(message, code)
[docs] def get_default_message(self): return "There was an error on client request"