mirror of
https://github.com/apache/superset.git
synced 2026-09-09 00:34:49 +00:00
b7301ac88a
Co-authored-by: rusackas <evan@rusackas.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
97 lines
3.4 KiB
Python
97 lines
3.4 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.abc import Iterator
|
|
from datetime import datetime, timezone
|
|
from typing import Callable
|
|
|
|
import yaml
|
|
from flask_appbuilder import Model
|
|
|
|
from superset.commands.base import BaseCommand
|
|
from superset.commands.exceptions import CommandException
|
|
from superset.daos.base import BaseDAO
|
|
from superset.utils.dict_import_export import EXPORT_VERSION
|
|
|
|
METADATA_FILE_NAME = "metadata.yaml"
|
|
|
|
|
|
class ExportModelsCommand(BaseCommand):
|
|
dao: type[BaseDAO[Model]] = BaseDAO
|
|
not_found: type[CommandException] = CommandException
|
|
|
|
def __init__(self, model_ids: list[int], export_related: bool = True):
|
|
self.model_ids = model_ids
|
|
self.export_related = export_related
|
|
|
|
# this will be set when calling validate()
|
|
self._models: list[Model] = []
|
|
|
|
@staticmethod
|
|
def _file_name(model: Model) -> str:
|
|
raise NotImplementedError("Subclasses MUST implement _file_name")
|
|
|
|
@staticmethod
|
|
def _file_content(model: Model) -> str:
|
|
raise NotImplementedError("Subclasses MUST implement _file_content")
|
|
|
|
@staticmethod
|
|
def _export(
|
|
model: Model, export_related: bool = True, seen: set[str] | None = None
|
|
) -> Iterator[tuple[str, Callable[[], str]]]:
|
|
raise NotImplementedError("Subclasses MUST implement _export")
|
|
|
|
def run(
|
|
self, seen: set[str] | None = None
|
|
) -> Iterator[tuple[str, Callable[[], str]]]:
|
|
self.validate()
|
|
|
|
# Use provided seen set or create new one
|
|
if seen is None:
|
|
seen = set()
|
|
should_add_metadata = True
|
|
else:
|
|
# If seen set is provided, we're being called from another command
|
|
should_add_metadata = False
|
|
|
|
# Only add metadata if this is the root command
|
|
if should_add_metadata:
|
|
metadata = {
|
|
"version": EXPORT_VERSION,
|
|
"type": self.dao.model_cls.__name__, # type: ignore
|
|
"timestamp": datetime.now(tz=timezone.utc).isoformat(),
|
|
}
|
|
if METADATA_FILE_NAME not in seen:
|
|
yield (
|
|
METADATA_FILE_NAME,
|
|
lambda: yaml.safe_dump(metadata, sort_keys=False),
|
|
)
|
|
seen.add(METADATA_FILE_NAME)
|
|
|
|
for model in self._models:
|
|
for file_name, file_content in self._export(
|
|
model, self.export_related, seen
|
|
):
|
|
if file_name not in seen:
|
|
yield file_name, file_content
|
|
seen.add(file_name)
|
|
|
|
def validate(self) -> None:
|
|
self._models = self.dao.find_by_ids(self.model_ids)
|
|
if len(self._models) != len(self.model_ids):
|
|
raise self.not_found()
|