refactor 1st stage
This commit is contained in:
Volobuev Andrey
@@ -1,23 +1,23 @@
|
||||
# [MODULE] Superset API Client
|
||||
# @contract: Реализует полное взаимодействие с Superset API
|
||||
# @semantic_layers:
|
||||
# 1. Авторизация/CSRF
|
||||
# 2. Основные операции (дашборды)
|
||||
# 3. Импорт/экспорт
|
||||
# 1. Авторизация/CSRF (делегируется `APIClient`)
|
||||
# 2. Основные операции (получение метаданных, список дашбордов)
|
||||
# 3. Импорт/экспорт дашбордов
|
||||
# @coherence:
|
||||
# - Согласован с models.SupersetConfig
|
||||
# - Полная обработка всех errors из exceptions.py
|
||||
# - Согласован с `models.SupersetConfig` для конфигурации.
|
||||
# - Полная обработка всех ошибок из `exceptions.py` (делегируется `APIClient` и дополняется специфичными).
|
||||
# - Полностью использует `utils.network.APIClient` для всех HTTP-запросов.
|
||||
|
||||
# [IMPORTS] Стандартная библиотека
|
||||
import json
|
||||
from typing import Optional, Dict, Tuple, List, Any, Literal, Union
|
||||
import datetime
|
||||
from pathlib import Path
|
||||
from requests import Response
|
||||
import zipfile # Для валидации ZIP-файлов
|
||||
|
||||
# [IMPORTS] Сторонние библиотеки
|
||||
import requests
|
||||
import urllib3
|
||||
import zipfile
|
||||
# [IMPORTS] Сторонние библиотеки (убраны requests и urllib3, т.к. они теперь в network.py)
|
||||
|
||||
# [IMPORTS] Локальные модули
|
||||
from superset_tool.models import SupersetConfig
|
||||
@@ -32,304 +32,295 @@ from superset_tool.exceptions import (
|
||||
)
|
||||
from superset_tool.utils.fileio import get_filename_from_headers
|
||||
from superset_tool.utils.logger import SupersetLogger
|
||||
from superset_tool.utils.network import APIClient
|
||||
from superset_tool.utils.network import APIClient # [REFACTORING_TARGET] Использование APIClient
|
||||
|
||||
# [CONSTANTS] Логирование
|
||||
HTTP_METHODS = Literal['GET', 'POST', 'PUT', 'DELETE']
|
||||
DEFAULT_TIMEOUT = 30 # seconds
|
||||
# [CONSTANTS] Общие константы (для информации, т.к. тайм-аут теперь в конфиге)
|
||||
DEFAULT_TIMEOUT = 30 # seconds - используется как значение по умолчанию в SupersetConfig
|
||||
|
||||
# [TYPE-ALIASES] Для сложных сигнатур
|
||||
JsonType = Union[Dict[str, Any], List[Dict[str, Any]]]
|
||||
ResponseType = Tuple[bytes, str]
|
||||
|
||||
# [CHECK] Валидация импортов для контрактов
|
||||
# [COHERENCE_CHECK_PASSED] Теперь зависимость на requests и urllib3 скрыта за APIClient
|
||||
try:
|
||||
# Проверка наличия ключевых зависимостей
|
||||
assert requests.__version__ >= '2.28.0' # для retry механизмов
|
||||
assert urllib3.__version__ >= '1.26.0' # для SSL warnings
|
||||
|
||||
# Проверка локальных модулей
|
||||
from .utils.fileio import get_filename_from_headers as fileio_check
|
||||
assert callable(fileio_check)
|
||||
|
||||
from .utils.network import APIClient as network_check
|
||||
assert callable(network_check)
|
||||
except (ImportError, AssertionError) as imp_err:
|
||||
raise RuntimeError(
|
||||
f"[COHERENCE_CHECK_FAILED] Импорт не прошел валидацию: {str(imp_err)}"
|
||||
) from imp_err
|
||||
|
||||
|
||||
|
||||
class SupersetClient:
|
||||
"""[MAIN-CONTRACT] Клиент для работы с Superset API
|
||||
@pre:
|
||||
- config должен быть валидным SupersetConfig
|
||||
- Целевой API доступен
|
||||
- `config` должен быть валидным `SupersetConfig`.
|
||||
- Целевой API доступен и учетные данные корректны.
|
||||
@post:
|
||||
- Все методы возвращают данные или вызывают явные ошибки
|
||||
- Токены автоматически обновляются
|
||||
- Все методы возвращают ожидаемые данные или вызывают явные, типизированные ошибки.
|
||||
- Токены для API-вызовов автоматически управляются (`APIClient`).
|
||||
@invariant:
|
||||
- Сессия остается валидной между вызовами
|
||||
- Все ошибки типизированы согласно exceptions.py
|
||||
- Сессия остается валидной между вызовами.
|
||||
- Все ошибки типизированы согласно `exceptions.py`.
|
||||
- Все HTTP-запросы проходят через `self.network`.
|
||||
"""
|
||||
|
||||
def __init__(self, config: SupersetConfig):
|
||||
"""[INIT] Инициализация клиента
|
||||
def __init__(self, config: SupersetConfig, logger: Optional[SupersetLogger] = None):
|
||||
"""[INIT] Инициализация клиента Superset.
|
||||
@semantic:
|
||||
- Создает сессию requests
|
||||
- Настраивает адаптеры подключения
|
||||
- Выполняет первичную аутентификацию
|
||||
- Валидирует входную конфигурацию.
|
||||
- Инициализирует внутренний `APIClient` для сетевого взаимодействия.
|
||||
- Выполняет первичную аутентификацию через `APIClient`.
|
||||
"""
|
||||
# [PRECONDITION] Валидация конфигурации
|
||||
self.logger = logger or SupersetLogger(name="SupersetClient")
|
||||
self._validate_config(config)
|
||||
self.config = config
|
||||
self.logger = config.logger or SupersetLogger(name="client")
|
||||
|
||||
|
||||
# [ANCHOR] API_CLIENT_INIT
|
||||
# [REFACTORING_COMPLETE] Теперь вся сетевая логика инкапсулирована в APIClient.
|
||||
# APIClient отвечает за аутентификацию, повторные попытки и обработку низкоуровневых ошибок.
|
||||
self.network = APIClient(
|
||||
base_url=config.base_url,
|
||||
auth=config.auth,
|
||||
verify_ssl=config.verify_ssl
|
||||
verify_ssl=config.verify_ssl,
|
||||
timeout=config.timeout,
|
||||
logger=self.logger # Передаем логгер в APIClient
|
||||
)
|
||||
self.tokens = self.network.authenticate()
|
||||
|
||||
try:
|
||||
# Аутентификация выполняется в конструкторе APIClient или по первому запросу
|
||||
# Для явного вызова: self.network.authenticate()
|
||||
# APIClient сам управляет токенами после первого успешного входа
|
||||
self.logger.info(
|
||||
"[COHERENCE_CHECK_PASSED] Клиент успешно инициализирован",
|
||||
"[COHERENCE_CHECK_PASSED] Клиент Superset успешно инициализирован",
|
||||
extra={"base_url": config.base_url}
|
||||
)
|
||||
except Exception as e:
|
||||
self.logger.error(
|
||||
"[INIT_FAILED] Ошибка инициализации клиента",
|
||||
"[INIT_FAILED] Ошибка инициализации клиента Superset",
|
||||
exc_info=True,
|
||||
extra={"config": config.dict()}
|
||||
extra={"config_base_url": config.base_url, "error": str(e)}
|
||||
)
|
||||
raise
|
||||
|
||||
raise # Перевыброс ошибки инициализации
|
||||
|
||||
def _validate_config(self, config: SupersetConfig) -> None:
|
||||
"""[PRECONDITION] Валидация конфигурации клиента
|
||||
"""[PRECONDITION] Валидация конфигурации клиента.
|
||||
@semantic:
|
||||
- Проверяет обязательные поля
|
||||
- Валидирует URL и учетные данные
|
||||
- Проверяет, что `config` является экземпляром `SupersetConfig`.
|
||||
- Проверяет обязательные поля `base_url` и `auth`.
|
||||
- Логирует ошибки валидации.
|
||||
@raise:
|
||||
- ValueError при невалидных параметрах
|
||||
- TypeError при некорректном типе
|
||||
- `TypeError`: если `config` не является `SupersetConfig`.
|
||||
- `ValueError`: если отсутствуют обязательные поля или они невалидны.
|
||||
"""
|
||||
if not isinstance(config, SupersetConfig):
|
||||
self.logger.error(
|
||||
"[CONFIG_VALIDATION_FAILED] Некорректный тип конфигурации",
|
||||
"[CONTRACT_VIOLATION] Некорректный тип конфигурации",
|
||||
extra={"actual_type": type(config).__name__}
|
||||
)
|
||||
raise TypeError("Конфигурация должна быть экземпляром SupersetConfig")
|
||||
|
||||
required_fields = ["base_url", "auth"]
|
||||
for field in required_fields:
|
||||
if not getattr(config, field, None):
|
||||
self.logger.error(
|
||||
"[CONFIG_VALIDATION_FAILED] Отсутствует обязательное поле",
|
||||
extra={"missing_field": field}
|
||||
)
|
||||
raise ValueError(f"Обязательное поле {field} не указано")
|
||||
|
||||
if not config.auth.get("username") or not config.auth.get("password"):
|
||||
# Pydantic SupersetConfig уже выполняет основную валидацию через Field и validator.
|
||||
# Здесь можно добавить дополнительные бизнес-правила или проверки доступности, если нужно.
|
||||
try:
|
||||
# Попытка доступа к полям через Pydantic для проверки их существования
|
||||
_ = config.base_url
|
||||
_ = config.auth
|
||||
_ = config.auth.get("username")
|
||||
_ = config.auth.get("password")
|
||||
self.logger.debug("[COHERENCE_CHECK_PASSED] Конфигурация SupersetClient прошла внутреннюю валидацию.")
|
||||
except Exception as e:
|
||||
self.logger.error(
|
||||
"[CONFIG_VALIDATION_FAILED] Не указаны учетные данные",
|
||||
extra={"auth_keys": list(config.auth.keys())}
|
||||
f"[CONTRACT_VIOLATION] Ошибка валидации полей конфигурации: {e}",
|
||||
extra={"config_dict": config.dict()}
|
||||
)
|
||||
raise ValueError("В конфигурации должны быть указаны username и password")
|
||||
|
||||
# Дополнительная валидация URL
|
||||
if not config.base_url.startswith(("http://", "https://")):
|
||||
self.logger.error(
|
||||
"[CONFIG_VALIDATION_FAILED] Некорректный URL",
|
||||
extra={"base_url": config.base_url}
|
||||
)
|
||||
raise ValueError("base_url должен начинаться с http:// или https://")
|
||||
raise ValueError(f"Конфигурация SupersetConfig невалидна: {e}") from e
|
||||
|
||||
@property
|
||||
def headers(self) -> dict:
|
||||
"""[INTERFACE] Базовые заголовки для API-вызовов
|
||||
@semantic: Объединяет общие заголовки для всех запросов
|
||||
@post: Всегда возвращает актуальные токены
|
||||
"""[INTERFACE] Базовые заголовки для API-вызовов.
|
||||
@semantic: Делегирует получение актуальных заголовков `APIClient`.
|
||||
@post: Всегда возвращает актуальные токены и CSRF-токен.
|
||||
@invariant: Заголовки содержат 'Authorization' и 'X-CSRFToken'.
|
||||
"""
|
||||
return {
|
||||
"Authorization": f"Bearer {self.tokens['access_token']}",
|
||||
"X-CSRFToken": self.tokens["csrf_token"],
|
||||
"Referer": self.config.base_url,
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
# [REFACTORING_COMPLETE] Заголовки теперь управляются APIClient.
|
||||
return self.network.headers
|
||||
|
||||
# [MAIN-OPERATIONS] Работа с дашбордами
|
||||
# [SECTION] Основные операции с дашбордами
|
||||
def get_dashboard(self, dashboard_id_or_slug: str) -> dict:
|
||||
"""[CONTRACT] Получение метаданных дашборда
|
||||
"""[CONTRACT] Получение метаданных дашборда по ID или SLUG.
|
||||
@pre:
|
||||
- dashboard_id_or_slug должен существовать
|
||||
- Клиент должен быть аутентифицирован (tokens актуальны)
|
||||
- `dashboard_id_or_slug` должен быть строкой (ID или slug).
|
||||
- Клиент должен быть аутентифицирован (токены актуальны).
|
||||
@post:
|
||||
- Возвращает dict с метаданными дашборда
|
||||
- В случае 404 вызывает DashboardNotFoundError
|
||||
@semantic_layers:
|
||||
1. Взаимодействие с API через APIClient
|
||||
2. Обработка специфичных для Superset ошибок
|
||||
- Возвращает `dict` с метаданными дашборда.
|
||||
@raise:
|
||||
- `DashboardNotFoundError`: Если дашборд не найден (HTTP 404).
|
||||
- `SupersetAPIError`: При других ошибках API.
|
||||
- `NetworkError`: При проблемах с сетью.
|
||||
"""
|
||||
self.logger.info(f"[INFO] Запрос метаданных дашборда: {dashboard_id_or_slug}")
|
||||
try:
|
||||
response = self.network.request(
|
||||
response_data = self.network.request(
|
||||
method="GET",
|
||||
endpoint=f"/dashboard/{dashboard_id_or_slug}",
|
||||
headers=self.headers # Автоматически включает токены
|
||||
)
|
||||
return response.json()["result"]
|
||||
|
||||
except requests.HTTPError as e:
|
||||
if e.response.status_code == 404:
|
||||
raise DashboardNotFoundError(
|
||||
dashboard_id_or_slug,
|
||||
context={"url": f"{self.config.base_url}/dashboard/{dashboard_id_or_slug}"}
|
||||
)
|
||||
raise SupersetAPIError(
|
||||
f"API Error: {str(e)}",
|
||||
status_code=e.response.status_code
|
||||
) from e
|
||||
|
||||
# [ERROR-HANDLER] Централизованная обработка ошибок
|
||||
def _handle_api_error(self, method_name: str, error: Exception, url: str) -> None:
|
||||
"""[UNIFIED-ERROR] Обработка API-ошибок
|
||||
@semantic: Преобразует requests исключения в наши типы
|
||||
"""
|
||||
context = {
|
||||
"method": method_name,
|
||||
"url": url,
|
||||
"status_code": getattr(error.response, 'status_code', None)
|
||||
}
|
||||
|
||||
if isinstance(error, requests.Timeout):
|
||||
raise NetworkError("Request timeout", context=context) from error
|
||||
elif getattr(error.response, 'status_code', None) == 403:
|
||||
raise PermissionDeniedError(context=context) from error
|
||||
else:
|
||||
raise SupersetAPIError(str(error), context=context) from error
|
||||
# headers=self.headers # [REFACTORING_NOTE] APIClient теперь сам добавляет заголовки
|
||||
).json()
|
||||
# [POSTCONDITION] Проверка структуры ответа
|
||||
if "result" not in response_data:
|
||||
self.logger.warning("[CONTRACT_VIOLATION] Ответ API не содержит поле 'result'", extra={"response": response_data})
|
||||
raise SupersetAPIError("Некорректный формат ответа API при получении дашборда")
|
||||
self.logger.debug(f"[DEBUG] Метаданные дашборда '{dashboard_id_or_slug}' успешно получены.")
|
||||
return response_data["result"]
|
||||
except (DashboardNotFoundError, SupersetAPIError, NetworkError, PermissionDeniedError) as e:
|
||||
self.logger.error(f"[ERROR] Не удалось получить дашборд '{dashboard_id_or_slug}': {str(e)}", exc_info=True, extra=getattr(e, 'context', {}))
|
||||
raise # Перевыброс уже типизированной ошибки
|
||||
except Exception as e:
|
||||
self.logger.critical(f"[CRITICAL] Непредвиденная ошибка при получении дашборда '{dashboard_id_or_slug}': {str(e)}", exc_info=True)
|
||||
raise SupersetAPIError(f"Непредвиденная ошибка: {str(e)}", context={"dashboard_id_or_slug": dashboard_id_or_slug}) from e
|
||||
|
||||
# [SECTION] EXPORT OPERATIONS
|
||||
def export_dashboard(self, dashboard_id: int) -> Tuple[bytes, str]:
|
||||
"""[CONTRACT] Экспорт дашборда в ZIP-архив
|
||||
"""[CONTRACT] Экспорт дашборда в ZIP-архив.
|
||||
@pre:
|
||||
- dashboard_id должен существовать
|
||||
- Пользователь имеет права на экспорт
|
||||
- `dashboard_id` должен быть целочисленным ID существующего дашборда.
|
||||
- Пользователь должен иметь права на экспорт.
|
||||
@post:
|
||||
- Возвращает кортеж (бинарное содержимое, имя файла)
|
||||
- Имя файла извлекается из headers или генерируется
|
||||
@errors:
|
||||
- DashboardNotFoundError если дашборд не существует
|
||||
- ExportError при проблемах экспорта
|
||||
- Возвращает кортеж: (бинарное_содержимое_zip, имя_файла).
|
||||
- Имя файла извлекается из заголовков `Content-Disposition` или генерируется.
|
||||
@raise:
|
||||
- `DashboardNotFoundError`: Если дашборд с `dashboard_id` не найден (HTTP 404).
|
||||
- `ExportError`: При любых других проблемах экспорта (например, неверный тип контента, пустой ответ).
|
||||
- `NetworkError`: При проблемах с сетью.
|
||||
"""
|
||||
url = f"{self.config.base_url}/dashboard/export/"
|
||||
self.logger.debug(
|
||||
"[EXPORT_START] Запуск экспорта",
|
||||
extra={"dashboard_id": dashboard_id, "export_url": url}
|
||||
)
|
||||
|
||||
self.logger.info(f"[INFO] Запуск экспорта дашборда с ID: {dashboard_id}")
|
||||
try:
|
||||
response = self._execute_export_request(dashboard_id, url)
|
||||
self._validate_export_response(response, dashboard_id)
|
||||
|
||||
filename = self._resolve_export_filename(response, dashboard_id)
|
||||
return response.content, filename
|
||||
|
||||
except requests.exceptions.HTTPError as http_err:
|
||||
error_ctx = {
|
||||
"dashboard_id": dashboard_id,
|
||||
"status_code": http_err.response.status_code
|
||||
}
|
||||
if http_err.response.status_code == 404:
|
||||
self.logger.error(
|
||||
"[EXPORT_FAILED] Дашборд не найден",
|
||||
extra=error_ctx
|
||||
)
|
||||
raise DashboardNotFoundError(dashboard_id, context=error_ctx)
|
||||
raise ExportError("HTTP ошибка экспорта", context=error_ctx) from http_err
|
||||
|
||||
except requests.exceptions.RequestException as req_err:
|
||||
error_ctx = {"dashboard_id": dashboard_id}
|
||||
self.logger.error(
|
||||
"[EXPORT_FAILED] Ошибка запроса",
|
||||
exc_info=True,
|
||||
extra=error_ctx
|
||||
)
|
||||
raise ExportError("Ошибка экспорта", context=error_ctx) from req_err
|
||||
|
||||
def _execute_export_request(self, dashboard_id: int, url: str) -> requests.Response:
|
||||
"""[HELPER] Выполнение запроса экспорта
|
||||
@coherence_check:
|
||||
- Ответ должен иметь status_code 200
|
||||
- Content-Type: application/zip
|
||||
"""
|
||||
response = self.network.request(
|
||||
# [ANCHOR] EXECUTE_EXPORT_REQUEST
|
||||
# [REFACTORING_COMPLETE] Использование self.network.request для экспорта
|
||||
response = self.network.request(
|
||||
method="GET",
|
||||
endpoint="/dashboard/export/",
|
||||
params={"q": f"[{dashboard_id}]"},
|
||||
raw_response=True # Для получения бинарного содержимого
|
||||
params={"q": json.dumps([dashboard_id])},
|
||||
stream=True, # Используем stream для обработки больших файлов
|
||||
raw_response=True # Получаем сырой объект ответа requests.Response
|
||||
# headers=self.headers # APIClient сам добавляет заголовки
|
||||
)
|
||||
response.raise_for_status()
|
||||
return response
|
||||
response.raise_for_status() # Проверка статуса ответа
|
||||
|
||||
# [ANCHOR] VALIDATE_EXPORT_RESPONSE
|
||||
self._validate_export_response(response, dashboard_id)
|
||||
|
||||
# [ANCHOR] RESOLVE_FILENAME
|
||||
filename = self._resolve_export_filename(response, dashboard_id)
|
||||
|
||||
# [POSTCONDITION] Успешный экспорт
|
||||
content = response.content # Получаем все содержимое
|
||||
self.logger.info(
|
||||
f"[COHERENCE_CHECK_PASSED] Дашборд {dashboard_id} успешно экспортирован. Размер: {len(content)} байт, Имя файла: {filename}"
|
||||
)
|
||||
return content, filename
|
||||
|
||||
def _validate_export_response(self, response: requests.Response, dashboard_id: int) -> None:
|
||||
"""[HELPER] Валидация ответа экспорта
|
||||
except (DashboardNotFoundError, ExportError, NetworkError, PermissionDeniedError, SupersetAPIError) as e:
|
||||
# Перехват и перевыброс уже типизированных ошибок от APIClient или предыдущих валидаций
|
||||
self.logger.error(f"[ERROR] Ошибка экспорта дашборда {dashboard_id}: {str(e)}", exc_info=True, extra=getattr(e, 'context', {}))
|
||||
raise
|
||||
except Exception as e:
|
||||
# Обработка любых непредвиденных ошибок
|
||||
error_ctx = {"dashboard_id": dashboard_id, "error_type": type(e).__name__}
|
||||
self.logger.critical(f"[CRITICAL] Непредвиденная ошибка при экспорте дашборда {dashboard_id}: {str(e)}", exc_info=True, extra=error_ctx)
|
||||
raise ExportError(f"Непредвиденная ошибка при экспорте: {str(e)}", context=error_ctx) from e
|
||||
|
||||
# [HELPER] Метод _execute_export_request был инлайнирован в export_dashboard
|
||||
# Это сделано, чтобы избежать лишней абстракции, так как он просто вызывает self.network.request.
|
||||
# Валидация HTTP-ответа и ошибок теперь происходит в self.network.request и последующей self.raise_for_status().
|
||||
|
||||
def _validate_export_response(self, response: Response, dashboard_id: int) -> None:
|
||||
"""[HELPER] Валидация ответа экспорта.
|
||||
@semantic:
|
||||
- Проверка Content-Type
|
||||
- Проверка наличия данных
|
||||
- Проверяет, что Content-Type является `application/zip`.
|
||||
- Проверяет, что ответ не пуст.
|
||||
@raise:
|
||||
- `ExportError`: При невалидном Content-Type или пустом содержимом.
|
||||
"""
|
||||
if 'application/zip' not in response.headers.get('Content-Type', ''):
|
||||
content_type = response.headers.get('Content-Type', '')
|
||||
if 'application/zip' not in content_type:
|
||||
self.logger.error(
|
||||
"[EXPORT_VALIDATION_FAILED] Неверный Content-Type",
|
||||
"[CONTRACT_VIOLATION] Неверный Content-Type для экспорта",
|
||||
extra={
|
||||
"dashboard_id": dashboard_id,
|
||||
"content_type": response.headers.get('Content-Type')
|
||||
"expected_type": "application/zip",
|
||||
"received_type": content_type
|
||||
}
|
||||
)
|
||||
raise ExportError("Получен не ZIP-архив")
|
||||
raise ExportError(f"Получен не ZIP-архив (Content-Type: {content_type})")
|
||||
|
||||
if not response.content:
|
||||
self.logger.error(
|
||||
"[EXPORT_VALIDATION_FAILED] Пустой ответ",
|
||||
"[CONTRACT_VIOLATION] Пустой ответ при экспорте дашборда",
|
||||
extra={"dashboard_id": dashboard_id}
|
||||
)
|
||||
raise ExportError("Получены пустые данные")
|
||||
raise ExportError("Получены пустые данные при экспорте")
|
||||
self.logger.debug(f"[COHERENCE_CHECK_PASSED] Ответ экспорта для дашборда {dashboard_id} валиден.")
|
||||
|
||||
def _resolve_export_filename(self, response: requests.Response, dashboard_id: int) -> str:
|
||||
"""[HELPER] Определение имени экспортируемого файла
|
||||
@fallback: Генерирует имя если не найден заголовок
|
||||
def _resolve_export_filename(self, response: Response, dashboard_id: int) -> str:
|
||||
"""[HELPER] Определение имени экспортируемого файла.
|
||||
@semantic:
|
||||
- Пытается извлечь имя файла из заголовка `Content-Disposition`.
|
||||
- Если заголовок отсутствует, генерирует имя файла на основе ID дашборда и текущей даты.
|
||||
@post:
|
||||
- Возвращает строку с именем файла.
|
||||
"""
|
||||
filename = get_filename_from_headers(response.headers)
|
||||
if not filename:
|
||||
filename = f"dashboard_export_{dashboard_id}_{datetime.now().strftime('%Y%m%d')}.zip"
|
||||
# [FALLBACK] Генерация имени файла
|
||||
filename = f"dashboard_export_{dashboard_id}_{datetime.datetime.now().strftime('%Y%m%dT%H%M%S')}.zip"
|
||||
self.logger.warning(
|
||||
"[WARN] Не удалось извлечь имя файла из заголовков. Используется сгенерированное имя.",
|
||||
extra={"generated_filename": filename, "dashboard_id": dashboard_id}
|
||||
)
|
||||
else:
|
||||
self.logger.debug(
|
||||
"[EXPORT_FALLBACK] Используется сгенерированное имя файла",
|
||||
extra={"filename": filename}
|
||||
"[DEBUG] Имя файла экспорта получено из заголовков.",
|
||||
extra={"filename": filename, "dashboard_id": dashboard_id}
|
||||
)
|
||||
return filename
|
||||
|
||||
def export_to_file(self, dashboard_id: int, output_dir: Union[str, Path]) -> Path:
|
||||
"""[CONTRACT] Экспорт дашборда прямо в файл
|
||||
"""[CONTRACT] Экспорт дашборда напрямую в файл.
|
||||
@pre:
|
||||
- output_dir должен существовать
|
||||
- Доступ на запись в директорию
|
||||
- `dashboard_id` должен быть существующим ID дашборда.
|
||||
- `output_dir` должен быть валидным, существующим путем и иметь права на запись.
|
||||
@post:
|
||||
- Возвращает Path сохраненного файла
|
||||
- Создает поддиректорию с именем дашборда
|
||||
- Дашборд экспортируется и сохраняется как ZIP-файл в `output_dir`.
|
||||
- Возвращает `Path` к сохраненному файлу.
|
||||
@raise:
|
||||
- `FileNotFoundError`: Если `output_dir` не существует.
|
||||
- `ExportError`: При ошибках экспорта или записи файла.
|
||||
- `NetworkError`: При проблемах с сетью.
|
||||
"""
|
||||
output_dir = Path(output_dir)
|
||||
if not output_dir.exists():
|
||||
self.logger.error(
|
||||
"[EXPORT_PRE_FAILED] Директория не существует",
|
||||
"[CONTRACT_VIOLATION] Целевая директория для экспорта не найдена.",
|
||||
extra={"output_dir": str(output_dir)}
|
||||
)
|
||||
raise FileNotFoundError(f"Директория {output_dir} не найдена")
|
||||
|
||||
content, filename = self.export_dashboard(dashboard_id)
|
||||
target_path = output_dir / filename
|
||||
|
||||
|
||||
self.logger.info(f"[INFO] Экспорт дашборда {dashboard_id} в файл в директорию: {output_dir}")
|
||||
try:
|
||||
content, filename = self.export_dashboard(dashboard_id)
|
||||
target_path = output_dir / filename
|
||||
|
||||
with open(target_path, 'wb') as f:
|
||||
f.write(content)
|
||||
|
||||
self.logger.info(
|
||||
"[EXPORT_SUCCESS] Дашборд сохранен на диск",
|
||||
"[COHERENCE_CHECK_PASSED] Дашборд успешно сохранен на диск.",
|
||||
extra={
|
||||
"dashboard_id": dashboard_id,
|
||||
"file_path": str(target_path),
|
||||
@@ -338,167 +329,245 @@ class SupersetClient:
|
||||
)
|
||||
return target_path
|
||||
|
||||
except (FileNotFoundError, ExportError, NetworkError, SupersetAPIError, DashboardNotFoundError) as e:
|
||||
self.logger.error(f"[ERROR] Ошибка сохранения дашборда {dashboard_id} на диск: {str(e)}", exc_info=True, extra=getattr(e, 'context', {}))
|
||||
raise
|
||||
except IOError as io_err:
|
||||
self.logger.error(
|
||||
"[EXPORT_IO_FAILED] Ошибка записи файла",
|
||||
exc_info=True,
|
||||
extra={"target_path": str(target_path)}
|
||||
)
|
||||
raise ExportError("Ошибка сохранения файла") from io_err
|
||||
error_ctx = {"target_path": str(target_path), "dashboard_id": dashboard_id}
|
||||
self.logger.critical(f"[CRITICAL] Ошибка записи файла для дашборда {dashboard_id}: {str(io_err)}", exc_info=True, extra=error_ctx)
|
||||
raise ExportError("Ошибка сохранения файла на диск") from io_err
|
||||
except Exception as e:
|
||||
error_ctx = {"dashboard_id": dashboard_id, "error_type": type(e).__name__}
|
||||
self.logger.critical(f"[CRITICAL] Непредвиденная ошибка при экспорте в файл: {str(e)}", exc_info=True, extra=error_ctx)
|
||||
raise ExportError(f"Непредвиденная ошибка экспорта в файл: {str(e)}", context=error_ctx) from e
|
||||
|
||||
# [SECTION] Основной интерфейс API
|
||||
# [SECTION] API для получения списка дашбордов
|
||||
def get_dashboards(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]:
|
||||
"""[CONTRACT] Получение списка дашбордов с пагинацией
|
||||
"""[CONTRACT] Получение списка дашбордов с пагинацией.
|
||||
@pre:
|
||||
- Клиент должен быть авторизован
|
||||
- Параметры пагинации должны быть валидны
|
||||
- Клиент должен быть авторизован.
|
||||
- Параметры `query` (если предоставлены) должны быть валидны для API Superset.
|
||||
@post:
|
||||
- Возвращает кортеж (total_count, список метаданных)
|
||||
- Поддерживает кастомные query-параметры
|
||||
- Возвращает кортеж: (общее_количество_дашбордов, список_метаданных_дашбордов).
|
||||
- Обходит пагинацию для получения всех доступных дашбордов.
|
||||
@invariant:
|
||||
- Всегда возвращает полный список (обходит пагинацию)
|
||||
- Всегда возвращает полный список (если `total_count` > 0).
|
||||
@raise:
|
||||
- `SupersetAPIError`: При ошибках API (например, неверный формат ответа).
|
||||
- `NetworkError`: При проблемах с сетью.
|
||||
- `ValueError`: При некорректных параметрах пагинации (внутренняя ошибка).
|
||||
"""
|
||||
url = f"{self.config.base_url}/dashboard/"
|
||||
self.logger.debug(
|
||||
"[API_CALL] Запрос списка дашбордов",
|
||||
extra={"query": query}
|
||||
)
|
||||
|
||||
# [COHERENCE_CHECK] Валидация параметров
|
||||
self.logger.info("[INFO] Запрос списка всех дашбордов.")
|
||||
# [COHERENCE_CHECK] Валидация и нормализация параметров запроса
|
||||
validated_query = self._validate_query_params(query)
|
||||
self.logger.debug("[DEBUG] Параметры запроса списка дашбордов после валидации.", extra={"validated_query": validated_query})
|
||||
|
||||
try:
|
||||
# Инициализация пагинации
|
||||
# [ANCHOR] FETCH_TOTAL_COUNT
|
||||
total_count = self._fetch_total_count()
|
||||
self.logger.info(f"[INFO] Обнаружено {total_count} дашбордов в системе.")
|
||||
|
||||
# [ANCHOR] FETCH_ALL_PAGES
|
||||
paginated_data = self._fetch_all_pages(validated_query, total_count)
|
||||
|
||||
self.logger.info(
|
||||
"[API_SUCCESS] Дашборды получены",
|
||||
extra={"count": total_count}
|
||||
f"[COHERENCE_CHECK_PASSED] Успешно получено {len(paginated_data)} дашбордов из {total_count}."
|
||||
)
|
||||
return total_count, paginated_data
|
||||
|
||||
except requests.exceptions.RequestException as e:
|
||||
error_ctx = {"method": "get_dashboards", "query": validated_query}
|
||||
self._handle_api_error("Пагинация дашбордов", e, error_ctx)
|
||||
except (SupersetAPIError, NetworkError, ValueError, PermissionDeniedError) as e:
|
||||
self.logger.error(f"[ERROR] Ошибка при получении списка дашбордов: {str(e)}", exc_info=True, extra=getattr(e, 'context', {}))
|
||||
raise
|
||||
except Exception as e:
|
||||
error_ctx = {"query": query, "error_type": type(e).__name__}
|
||||
self.logger.critical(f"[CRITICAL] Непредвиденная ошибка при получении списка дашбордов: {str(e)}", exc_info=True, extra=error_ctx)
|
||||
raise SupersetAPIError(f"Непредвиденная ошибка: {str(e)}", context=error_ctx) from e
|
||||
|
||||
# [SECTION] Импорт
|
||||
def import_dashboard(self, file_name: Union[str, Path]) -> Dict:
|
||||
"""[CONTRACT] Импорт дашборда из архива
|
||||
"""[CONTRACT] Импорт дашборда из ZIP-архива.
|
||||
@pre:
|
||||
- Файл должен существовать и быть валидным ZIP
|
||||
- Должны быть права на импорт
|
||||
- `file_name` должен указывать на существующий и валидный ZIP-файл Superset экспорта.
|
||||
- Пользователь должен иметь права на импорт дашбордов.
|
||||
@post:
|
||||
- Возвращает метаданные импортированного дашборда
|
||||
- При конфликтах выполняет overwrite
|
||||
- Дашборд импортируется (или обновляется, если `overwrite` включен).
|
||||
- Возвращает `dict` с ответом API об импорте.
|
||||
@raise:
|
||||
- `FileNotFoundError`: Если файл не существует.
|
||||
- `InvalidZipFormatError`: Если файл не является корректным ZIP-архивом Superset.
|
||||
- `PermissionDeniedError`: Если у пользователя нет прав на импорт.
|
||||
- `SupersetAPIError`: При других ошибках API импорта.
|
||||
- `NetworkError`: При проблемах с сетью.
|
||||
"""
|
||||
self.logger.info(f"[INFO] Инициирован импорт дашборда из файла: {file_name}")
|
||||
# [PRECONDITION] Валидация входного файла
|
||||
self._validate_import_file(file_name)
|
||||
self.logger.debug(
|
||||
"[IMPORT_START] Инициирован импорт дашборда",
|
||||
extra={"file": file_name}
|
||||
)
|
||||
|
||||
try:
|
||||
return self.network.upload_file(
|
||||
# [ANCHOR] UPLOAD_FILE_TO_API
|
||||
# [REFACTORING_COMPLETE] Использование self.network.upload_file
|
||||
import_response = self.network.upload_file(
|
||||
endpoint="/dashboard/import/",
|
||||
file_obj=file_name,
|
||||
file_name=file_name,
|
||||
file_obj=Path(file_name), # Pathlib объект, который APIClient может преобразовать в бинарный
|
||||
file_name=Path(file_name).name, # Имя файла для FormData
|
||||
form_field="formData",
|
||||
extra_data={'overwrite': 'true'},
|
||||
timeout=self.config.timeout * 2
|
||||
extra_data={'overwrite': 'true'}, # Предполагаем, что всегда хотим перезаписывать
|
||||
timeout=self.config.timeout * 2 # Удвоенный таймаут для загрузки больших файлов
|
||||
# headers=self.headers # APIClient сам добавляет заголовки
|
||||
)
|
||||
|
||||
except PermissionDeniedError as e:
|
||||
self.logger.error(
|
||||
"[IMPORT_AUTH_FAILED] Недостаточно прав для импорта",
|
||||
exc_info=True
|
||||
)
|
||||
raise
|
||||
# [POSTCONDITION] Проверка успешного ответа импорта (Superset обычно возвращает JSON)
|
||||
if not isinstance(import_response, dict) or "message" not in import_response:
|
||||
self.logger.warning("[CONTRACT_VIOLATION] Неожиданный формат ответа при импорте", extra={"response": import_response})
|
||||
raise SupersetAPIError("Неожиданный формат ответа после импорта дашборда.")
|
||||
|
||||
except Exception as e:
|
||||
self.logger.error(
|
||||
"[IMPORT_FAILED] Ошибка импорта дашборда",
|
||||
exc_info=True,
|
||||
extra={"file": file_name}
|
||||
self.logger.info(
|
||||
f"[COHERENCE_CHECK_PASSED] Дашборд из '{file_name}' успешно импортирован.",
|
||||
extra={"api_message": import_response.get("message", "N/A"), "file": file_name}
|
||||
)
|
||||
raise SupersetAPIError(f"Ошибка импорта: {str(e)}") from e
|
||||
return import_response
|
||||
|
||||
except (FileNotFoundError, InvalidZipFormatError, PermissionDeniedError, SupersetAPIError, NetworkError, DashboardNotFoundError) as e:
|
||||
self.logger.error(f"[ERROR] Ошибка импорта дашборда из '{file_name}': {str(e)}", exc_info=True, extra=getattr(e, 'context', {}))
|
||||
raise
|
||||
except Exception as e:
|
||||
error_ctx = {"file": file_name, "error_type": type(e).__name__}
|
||||
self.logger.critical(f"[CRITICAL] Непредвиденная ошибка при импорте дашборда: {str(e)}", exc_info=True, extra=error_ctx)
|
||||
raise SupersetAPIError(f"Непредвиденная ошибка импорта: {str(e)}", context=error_ctx) from e
|
||||
|
||||
# [SECTION] Приватные методы-помощники
|
||||
def _validate_query_params(self, query: Optional[Dict]) -> Dict:
|
||||
"""[HELPER] Нормализация параметров запроса"""
|
||||
"""[HELPER] Нормализация и валидация параметров запроса для списка дашбордов.
|
||||
@semantic:
|
||||
- Устанавливает значения по умолчанию для `columns`, `page`, `page_size`.
|
||||
- Объединяет предоставленные `query` параметры с дефолтными.
|
||||
@post:
|
||||
- Возвращает словарь с полными и валидными параметрами запроса.
|
||||
"""
|
||||
base_query = {
|
||||
"columns": ["slug", "id", "changed_on_utc", "dashboard_title", "published"],
|
||||
"page": 0,
|
||||
"page_size": 20
|
||||
"page_size": 1000 # Достаточно большой размер страницы для обхода пагинации
|
||||
}
|
||||
# [COHERENCE_CHECK_PASSED] Параметры запроса сформированы корректно.
|
||||
return {**base_query, **(query or {})}
|
||||
|
||||
def _fetch_total_count(self) -> int:
|
||||
"""[CONTRACT][HELPER] Получение общего кол-ва дашбордов в системе
|
||||
"""[CONTRACT][HELPER] Получение общего количества дашбордов в системе.
|
||||
@delegates:
|
||||
- Сетевой запрос -> APIClient
|
||||
- Обработка ответа -> собственный метод
|
||||
@errors:
|
||||
- SupersetAPIError при проблемах с API
|
||||
- Сетевой запрос к `APIClient.fetch_paginated_count`.
|
||||
@pre:
|
||||
- Клиент должен быть авторизован.
|
||||
@post:
|
||||
- Возвращает целочисленное количество дашбордов.
|
||||
@raise:
|
||||
- `SupersetAPIError` или `NetworkError` при проблемах с API/сетью.
|
||||
"""
|
||||
query_params = {
|
||||
query_params_for_count = {
|
||||
'columns': ['id'],
|
||||
'page': 0,
|
||||
'page_size': 1
|
||||
}
|
||||
|
||||
self.logger.debug("[DEBUG] Запрос общего количества дашбордов.")
|
||||
try:
|
||||
return self.network.fetch_paginated_count(
|
||||
# [REFACTORING_COMPLETE] Использование self.network.fetch_paginated_count
|
||||
count = self.network.fetch_paginated_count(
|
||||
endpoint="/dashboard/",
|
||||
query_params=query_params,
|
||||
query_params=query_params_for_count,
|
||||
count_field="count"
|
||||
)
|
||||
except requests.exceptions.RequestException as e:
|
||||
raise SupersetAPIError(f"Ошибка получения количества дашбордов: {str(e)}")
|
||||
self.logger.debug(f"[COHERENCE_CHECK_PASSED] Получено общее количество дашбордов: {count}")
|
||||
return count
|
||||
except (SupersetAPIError, NetworkError, PermissionDeniedError) as e:
|
||||
self.logger.error(f"[ERROR] Ошибка получения общего количества дашбордов: {str(e)}", exc_info=True, extra=getattr(e, 'context', {}))
|
||||
raise # Перевыброс ошибки
|
||||
except Exception as e:
|
||||
error_ctx = {"error_type": type(e).__name__}
|
||||
self.logger.critical(f"[CRITICAL] Непредвиденная ошибка при получении общего количества: {str(e)}", exc_info=True, extra=error_ctx)
|
||||
raise SupersetAPIError(f"Непредвиденная ошибка при получении count: {str(e)}", context=error_ctx) from e
|
||||
|
||||
def _fetch_all_pages(self, query: Dict, total_count: int) -> List[Dict]:
|
||||
"""[HELPER] Обход всех страниц с пагинацией"""
|
||||
"""[CONTRACT] Получение всех данных с пагинированного API
|
||||
"""[CONTRACT][HELPER] Обход всех страниц пагинированного API для получения всех данных.
|
||||
@delegates:
|
||||
- Сетевые запросы -> APIClient.fetch_paginated_data()
|
||||
@params:
|
||||
query: оригинальный query-объект (без page)
|
||||
total_count: общее количество элементов
|
||||
@return:
|
||||
Список всех элементов
|
||||
@errors:
|
||||
- SupersetAPIError: проблемы с API
|
||||
- ValueError: некорректные параметры пагинации
|
||||
- Сетевые запросы к `APIClient.fetch_paginated_data()`.
|
||||
@pre:
|
||||
- `query` должен содержать `page_size`.
|
||||
- `total_count` должен быть корректным общим количеством элементов.
|
||||
@post:
|
||||
- Возвращает список всех элементов, собранных со всех страниц.
|
||||
@raise:
|
||||
- `SupersetAPIError` или `NetworkError` при проблемах с API/сетью.
|
||||
- `ValueError` при некорректных параметрах пагинации.
|
||||
"""
|
||||
self.logger.debug(f"[DEBUG] Запуск обхода пагинации. Всего элементов: {total_count}, query: {query}")
|
||||
try:
|
||||
if not query.get('page_size'):
|
||||
raise ValueError("Отсутствует page_size в query параметрах")
|
||||
if 'page_size' not in query or not query['page_size']:
|
||||
self.logger.error("[CONTRACT_VIOLATION] Параметр 'page_size' отсутствует или неверен в query.")
|
||||
raise ValueError("Отсутствует 'page_size' в query параметрах для пагинации")
|
||||
|
||||
return self.network.fetch_paginated_data(
|
||||
# [REFACTORING_COMPLETE] Использование self.network.fetch_paginated_data
|
||||
all_data = self.network.fetch_paginated_data(
|
||||
endpoint="/dashboard/",
|
||||
base_query=query,
|
||||
total_count=total_count,
|
||||
results_field="result"
|
||||
)
|
||||
self.logger.debug(f"[COHERENCE_CHECK_PASSED] Успешно получено {len(all_data)} элементов со всех страниц.")
|
||||
return all_data
|
||||
|
||||
except (requests.exceptions.RequestException, ValueError) as e:
|
||||
error_ctx = {
|
||||
"query": query,
|
||||
"total_count": total_count,
|
||||
"error": str(e)
|
||||
}
|
||||
self.logger.error("[PAGINATION_ERROR]", extra=error_ctx)
|
||||
raise SupersetAPIError(f"Ошибка пагинации: {str(e)}") from e
|
||||
except (SupersetAPIError, NetworkError, ValueError, PermissionDeniedError) as e:
|
||||
self.logger.error(f"[ERROR] Ошибка при обходе пагинации: {str(e)}", exc_info=True, extra=getattr(e, 'context', {}))
|
||||
raise
|
||||
except Exception as e:
|
||||
error_ctx = {"query": query, "total_count": total_count, "error_type": type(e).__name__}
|
||||
self.logger.critical(f"[CRITICAL] Непредвиденная ошибка при обходе пагинации: {str(e)}", exc_info=True, extra=error_ctx)
|
||||
raise SupersetAPIError(f"Непредвиденная ошибка пагинации: {str(e)}", context=error_ctx) from e
|
||||
|
||||
def _validate_import_file(self, zip_path: Union[str, Path]) -> None:
|
||||
"""[HELPER] Проверка файла перед импортом"""
|
||||
"""[HELPER] Проверка файла перед импортом.
|
||||
@semantic:
|
||||
- Проверяет существование файла.
|
||||
- Проверяет, что файл является валидным ZIP-архивом.
|
||||
- Проверяет, что ZIP-архив содержит `metadata.yaml` (ключевой для экспорта Superset).
|
||||
@raise:
|
||||
- `FileNotFoundError`: Если файл не существует.
|
||||
- `InvalidZipFormatError`: Если файл не ZIP или не содержит `metadata.yaml`.
|
||||
"""
|
||||
path = Path(zip_path)
|
||||
self.logger.debug(f"[DEBUG] Валидация файла для импорта: {path}")
|
||||
|
||||
if not path.exists():
|
||||
raise FileNotFoundError(f"[FILE_ERROR] {zip_path} не существует")
|
||||
self.logger.error(
|
||||
"[CONTRACT_VIOLATION] Файл для импорта не найден.",
|
||||
extra={"file_path": str(path)}
|
||||
)
|
||||
raise FileNotFoundError(f"Файл {zip_path} не существует")
|
||||
|
||||
if not zipfile.is_zipfile(path):
|
||||
raise InvalidZipFormatError(f"[FILE_ERROR] {zip_path} не ZIP-архив")
|
||||
self.logger.error(
|
||||
"[CONTRACT_VIOLATION] Файл не является валидным ZIP-архивом.",
|
||||
extra={"file_path": str(path)}
|
||||
)
|
||||
raise InvalidZipFormatError(f"Файл {zip_path} не является ZIP-архивом")
|
||||
|
||||
with zipfile.ZipFile(path) as zf:
|
||||
if not any(n.endswith('metadata.yaml') for n in zf.namelist()):
|
||||
raise DashboardNotFoundError("Архив не содержит metadata.yaml")
|
||||
try:
|
||||
with zipfile.ZipFile(path, 'r') as zf:
|
||||
# [CONTRACT] Проверяем наличие metadata.yaml
|
||||
if not any(n.endswith('metadata.yaml') for n in zf.namelist()):
|
||||
self.logger.error(
|
||||
"[CONTRACT_VIOLATION] ZIP-архив не содержит 'metadata.yaml'.",
|
||||
extra={"file_path": str(path), "zip_contents": zf.namelist()[:5]} # Логируем первые 5 файлов для отладки
|
||||
)
|
||||
raise InvalidZipFormatError(f"Архив {zip_path} не содержит 'metadata.yaml', не является корректным экспортом Superset.")
|
||||
self.logger.debug(f"[COHERENCE_CHECK_PASSED] Файл '{path}' успешно прошел валидацию для импорта.")
|
||||
except zipfile.BadZipFile as e:
|
||||
self.logger.error(
|
||||
f"[CONTRACT_VIOLATION] Ошибка чтения ZIP-файла: {str(e)}",
|
||||
exc_info=True, extra={"file_path": str(path)}
|
||||
)
|
||||
raise InvalidZipFormatError(f"Файл {zip_path} поврежден или имеет некорректный формат ZIP.") from e
|
||||
except Exception as e:
|
||||
self.logger.critical(
|
||||
f"[CRITICAL] Непредвиденная ошибка при валидации ZIP-файла: {str(e)}",
|
||||
exc_info=True, extra={"file_path": str(path)}
|
||||
)
|
||||
raise SupersetAPIError(f"Непредвиденная ошибка валидации ZIP: {str(e)}", context={"file_path": str(path)}) from e
|
||||
Reference in New Issue
Block a user