mirror of
https://github.com/apache/superset.git
synced 2024-09-19 20:19:37 -04:00
237 lines
6.5 KiB
Python
237 lines
6.5 KiB
Python
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
from collections import defaultdict
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
from flask_babel import gettext as _
|
|
from marshmallow import ValidationError
|
|
|
|
from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
|
|
|
|
|
|
class SupersetException(Exception):
|
|
status = 500
|
|
message = ""
|
|
|
|
def __init__(
|
|
self,
|
|
message: str = "",
|
|
exception: Optional[Exception] = None,
|
|
error_type: Optional[SupersetErrorType] = None,
|
|
) -> None:
|
|
if message:
|
|
self.message = message
|
|
self._exception = exception
|
|
self._error_type = error_type
|
|
super().__init__(self.message)
|
|
|
|
@property
|
|
def exception(self) -> Optional[Exception]:
|
|
return self._exception
|
|
|
|
@property
|
|
def error_type(self) -> Optional[SupersetErrorType]:
|
|
return self._error_type
|
|
|
|
def to_dict(self) -> Dict[str, Any]:
|
|
rv = {}
|
|
if hasattr(self, "message"):
|
|
rv["message"] = self.message
|
|
if self.error_type:
|
|
rv["error_type"] = self.error_type
|
|
if self.exception is not None and hasattr(self.exception, "to_dict"):
|
|
rv = {**rv, **self.exception.to_dict()} # type: ignore
|
|
return rv
|
|
|
|
|
|
class SupersetErrorException(SupersetException):
|
|
"""Exceptions with a single SupersetErrorType associated with them"""
|
|
|
|
def __init__(self, error: SupersetError, status: Optional[int] = None) -> None:
|
|
super().__init__(error.message)
|
|
self.error = error
|
|
if status is not None:
|
|
self.status = status
|
|
|
|
def to_dict(self) -> Dict[str, Any]:
|
|
return self.error.to_dict()
|
|
|
|
|
|
class SupersetGenericErrorException(SupersetErrorException):
|
|
"""Exceptions that are too generic to have their own type"""
|
|
|
|
def __init__(self, message: str, status: Optional[int] = None) -> None:
|
|
super().__init__(
|
|
SupersetError(
|
|
message=message,
|
|
error_type=SupersetErrorType.GENERIC_BACKEND_ERROR,
|
|
level=ErrorLevel.ERROR,
|
|
)
|
|
)
|
|
if status is not None:
|
|
self.status = status
|
|
|
|
|
|
class SupersetErrorFromParamsException(SupersetErrorException):
|
|
"""Exceptions that pass in parameters to construct a SupersetError"""
|
|
|
|
def __init__(
|
|
self,
|
|
error_type: SupersetErrorType,
|
|
message: str,
|
|
level: ErrorLevel,
|
|
extra: Optional[Dict[str, Any]] = None,
|
|
) -> None:
|
|
super().__init__(
|
|
SupersetError(
|
|
error_type=error_type, message=message, level=level, extra=extra or {}
|
|
)
|
|
)
|
|
|
|
|
|
class SupersetErrorsException(SupersetException):
|
|
"""Exceptions with multiple SupersetErrorType associated with them"""
|
|
|
|
def __init__(
|
|
self, errors: List[SupersetError], status: Optional[int] = None
|
|
) -> None:
|
|
super().__init__(str(errors))
|
|
self.errors = errors
|
|
if status is not None:
|
|
self.status = status
|
|
|
|
|
|
class SupersetTimeoutException(SupersetErrorFromParamsException):
|
|
status = 408
|
|
|
|
|
|
class SupersetGenericDBErrorException(SupersetErrorFromParamsException):
|
|
status = 400
|
|
|
|
def __init__(
|
|
self,
|
|
message: str,
|
|
level: ErrorLevel = ErrorLevel.ERROR,
|
|
extra: Optional[Dict[str, Any]] = None,
|
|
) -> None:
|
|
super().__init__(
|
|
SupersetErrorType.GENERIC_DB_ENGINE_ERROR, message, level, extra,
|
|
)
|
|
|
|
|
|
class SupersetTemplateParamsErrorException(SupersetErrorFromParamsException):
|
|
status = 400
|
|
|
|
def __init__(
|
|
self,
|
|
message: str,
|
|
error: SupersetErrorType,
|
|
level: ErrorLevel = ErrorLevel.ERROR,
|
|
extra: Optional[Dict[str, Any]] = None,
|
|
) -> None:
|
|
super().__init__(
|
|
error, message, level, extra,
|
|
)
|
|
|
|
|
|
class SupersetSecurityException(SupersetErrorException):
|
|
status = 401
|
|
|
|
def __init__(
|
|
self, error: SupersetError, payload: Optional[Dict[str, Any]] = None
|
|
) -> None:
|
|
super().__init__(error)
|
|
self.payload = payload
|
|
|
|
|
|
class SupersetVizException(SupersetErrorsException):
|
|
status = 400
|
|
|
|
|
|
class NoDataException(SupersetException):
|
|
status = 400
|
|
|
|
|
|
class NullValueException(SupersetException):
|
|
status = 400
|
|
|
|
|
|
class SupersetTemplateException(SupersetException):
|
|
pass
|
|
|
|
|
|
class SpatialException(SupersetException):
|
|
pass
|
|
|
|
|
|
class CertificateException(SupersetException):
|
|
message = _("Invalid certificate")
|
|
|
|
|
|
class DatabaseNotFound(SupersetException):
|
|
status = 400
|
|
|
|
|
|
class QueryObjectValidationError(SupersetException):
|
|
status = 400
|
|
|
|
|
|
class CacheLoadError(SupersetException):
|
|
status = 404
|
|
|
|
|
|
class DashboardImportException(SupersetException):
|
|
pass
|
|
|
|
|
|
class SerializationError(SupersetException):
|
|
pass
|
|
|
|
|
|
class InvalidPayloadFormatError(SupersetErrorException):
|
|
status = 400
|
|
|
|
def __init__(self, message: str = "Request payload has incorrect format"):
|
|
error = SupersetError(
|
|
message=message,
|
|
error_type=SupersetErrorType.INVALID_PAYLOAD_FORMAT_ERROR,
|
|
level=ErrorLevel.ERROR,
|
|
)
|
|
super().__init__(error)
|
|
|
|
|
|
class InvalidPayloadSchemaError(SupersetErrorException):
|
|
status = 422
|
|
|
|
def __init__(self, error: ValidationError):
|
|
# dataclasses.asdict does not work with defaultdict, convert to dict
|
|
# https://bugs.python.org/issue35540
|
|
for k, v in error.messages.items():
|
|
if isinstance(v, defaultdict):
|
|
error.messages[k] = dict(v)
|
|
error = SupersetError(
|
|
message="An error happened when validating the request",
|
|
error_type=SupersetErrorType.INVALID_PAYLOAD_SCHEMA_ERROR,
|
|
level=ErrorLevel.ERROR,
|
|
extra={"messages": error.messages},
|
|
)
|
|
super().__init__(error)
|
|
|
|
|
|
class SupersetCancelQueryException(SupersetException):
|
|
status = 422
|