Source code for httk.serve.optimade.model.errors

from httk.store import FilterTranslationError



[docs]
class OptimadeError(Exception):
    """Represent an OPTIMADE response error.

    :param message: Short error detail used as the exception message.
    :param response_code: HTTP status code returned to the client.
    :param response_message: HTTP status title returned to the client.
    :param longmsg: Optional longer error detail returned in the response.
    """

    def __init__(self, message: str, response_code: int, response_message: str, longmsg: str | None = None) -> None:
        super().__init__(message)

[docs]
        self.response_code = response_code


[docs]
        self.response_msg = response_message


[docs]
        self.content = longmsg if longmsg is not None else message





[docs]
class TranslatorError(OptimadeError):
    """Represent a filter translation failure with an HTTP response contract."""



# HTTP status and title for each neutral filter-translation failure category
# reported by httk.store.
_CATEGORY_STATUS: dict[str, tuple[int, str]] = {
    "unrecognized-property": (400, "Bad request"),
    "type-mismatch": (400, "Bad request"),
    "not-implemented": (501, "Not implemented"),
    "internal": (500, "Internal server error."),
}



[docs]
def translator_error_from(error: FilterTranslationError) -> TranslatorError:
    """Wrap a neutral :class:`~httk.store.FilterTranslationError` for HTTP output.

    :param error: Neutral filter translation failure to classify.
    :return: A translated error carrying the corresponding HTTP status.
    """
    response_code, response_message = _CATEGORY_STATUS.get(error.category, _CATEGORY_STATUS["internal"])
    return TranslatorError(str(error), response_code, response_message, longmsg=error.detail)