Files
superset2/superset/commands/dashboard/exceptions.py
Mike Bridge af0a55a4f3 feat(dashboards): soft-delete and restore (#40128)
Co-authored-by: Mike Bridge <michael.bridge@ext.preset.io>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-07-01 17:20:44 -07:00

125 lines
4.0 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 typing import Optional
from flask_babel import lazy_gettext as _
from marshmallow.validate import ValidationError
from superset.commands.exceptions import (
CommandException,
CommandInvalidError,
CreateFailedError,
DeleteFailedError,
ForbiddenError,
ImportFailedError,
ObjectNotFoundError,
UpdateFailedError,
)
class DashboardSlugExistsValidationError(ValidationError):
"""
Marshmallow validation error for dashboard slug already exists
"""
def __init__(self) -> None:
super().__init__([_("Must be unique")], field_name="slug")
class DashboardInvalidError(CommandInvalidError):
message = _("Dashboard parameters are invalid.")
class DashboardNotFoundError(ObjectNotFoundError):
def __init__(
self, dashboard_id: Optional[str] = None, exception: Optional[Exception] = None
) -> None:
super().__init__("Dashboard", dashboard_id, exception)
class DashboardCreateFailedError(CreateFailedError):
message = _("Dashboards could not be created.")
class DashboardUpdateFailedError(UpdateFailedError):
message = _("Dashboard could not be updated.")
class DashboardNativeFiltersUpdateFailedError(UpdateFailedError):
message = _("Dashboard native filters could not be patched.")
class DashboardChartCustomizationsUpdateFailedError(UpdateFailedError):
message = _("Dashboard chart customizations could not be updated.")
class DashboardColorsConfigUpdateFailedError(UpdateFailedError):
message = _("Dashboard color configuration could not be updated.")
class DashboardRestoreFailedError(UpdateFailedError):
# Restore semantically clears ``deleted_at``; it is an UPDATE, not a new
# row. ``UpdateFailedError`` is the nearest typed middle-tier base in the
# codebase. A dedicated ``RestoreFailedError`` in
# ``superset/commands/exceptions.py`` would be more precise across the
# entity rollouts; extracting it there is left as a cross-entity follow-up.
message = _("Dashboard could not be restored.")
class DashboardSlugConflictError(CommandException):
status = 422
message = _(
"Dashboard cannot be restored because its slug is now used by "
"another active dashboard. Rename one of the dashboards and retry."
)
class DashboardDeleteFailedError(DeleteFailedError):
message = _("Dashboard could not be deleted.")
class DashboardDeleteEmbeddedFailedError(DeleteFailedError):
message = _("Embedded dashboard could not be deleted.")
class DashboardDeleteFailedReportsExistError(DashboardDeleteFailedError):
message = _("There are associated alerts or reports")
class DashboardForbiddenError(ForbiddenError):
message = _("Changing this Dashboard is forbidden")
class DashboardImportError(ImportFailedError):
message = _("Import dashboard failed for an unknown reason")
class DashboardAccessDeniedError(ForbiddenError):
message = _("You don't have access to this dashboard.")
class DashboardCopyError(CommandInvalidError):
message = _("Dashboard cannot be copied due to invalid parameters.")
class DashboardFaveError(CommandInvalidError):
message = _("Dashboard cannot be favorited.")
class DashboardUnfaveError(CommandInvalidError):
message = _("Dashboard cannot be unfavorited.")