project map script | semantic parcer
This commit is contained in:
@@ -48,7 +48,7 @@ class SupersetClient:
|
||||
)
|
||||
self.delete_before_reimport: bool = False
|
||||
self.logger.info("[SupersetClient.__init__][Exit] SupersetClient initialized.")
|
||||
# [/DEF:SupersetClient.__init__]
|
||||
# [/DEF:SupersetClient.__init__:Function]
|
||||
|
||||
# [DEF:SupersetClient._validate_config:Function]
|
||||
# @PURPOSE: Проверяет, что переданный объект конфигурации имеет корректный тип.
|
||||
@@ -60,7 +60,7 @@ class SupersetClient:
|
||||
self.logger.debug("[_validate_config][Enter] Validating SupersetConfig.")
|
||||
assert isinstance(config, SupersetConfig), "Конфигурация должна быть экземпляром SupersetConfig"
|
||||
self.logger.debug("[_validate_config][Exit] Config is valid.")
|
||||
# [/DEF:SupersetClient._validate_config]
|
||||
# [/DEF:SupersetClient._validate_config:Function]
|
||||
|
||||
@property
|
||||
def headers(self) -> dict:
|
||||
@@ -69,7 +69,7 @@ class SupersetClient:
|
||||
# @PRE: self.network должен быть инициализирован.
|
||||
# @POST: Возвращаемый словарь содержит актуальные заголовки, включая токен авторизации.
|
||||
return self.network.headers
|
||||
# [/DEF:SupersetClient.headers]
|
||||
# [/DEF:SupersetClient.headers:Function]
|
||||
|
||||
# [DEF:SupersetClient.get_dashboards:Function]
|
||||
# @PURPOSE: Получает полный список дашбордов, автоматически обрабатывая пагинацию.
|
||||
@@ -93,7 +93,7 @@ class SupersetClient:
|
||||
)
|
||||
self.logger.info("[get_dashboards][Exit] Found %d dashboards.", total_count)
|
||||
return total_count, paginated_data
|
||||
# [/DEF:SupersetClient.get_dashboards]
|
||||
# [/DEF:SupersetClient.get_dashboards:Function]
|
||||
|
||||
# [DEF:SupersetClient.export_dashboard:Function]
|
||||
# @PURPOSE: Экспортирует дашборд в виде ZIP-архива.
|
||||
@@ -118,7 +118,7 @@ class SupersetClient:
|
||||
filename = self._resolve_export_filename(response, dashboard_id)
|
||||
self.logger.info("[export_dashboard][Exit] Exported dashboard %s to %s.", dashboard_id, filename)
|
||||
return response.content, filename
|
||||
# [/DEF:SupersetClient.export_dashboard]
|
||||
# [/DEF:SupersetClient.export_dashboard:Function]
|
||||
|
||||
# [DEF:SupersetClient.import_dashboard:Function]
|
||||
# @PURPOSE: Импортирует дашборд из ZIP-файла с возможностью автоматического удаления и повторной попытки при ошибке.
|
||||
@@ -152,7 +152,7 @@ class SupersetClient:
|
||||
self.delete_dashboard(target_id)
|
||||
self.logger.info("[import_dashboard][State] Deleted dashboard ID %s, retrying import.", target_id)
|
||||
return self._do_import(file_path)
|
||||
# [/DEF:SupersetClient.import_dashboard]
|
||||
# [/DEF:SupersetClient.import_dashboard:Function]
|
||||
|
||||
# [DEF:SupersetClient._resolve_target_id_for_delete:Function]
|
||||
# @PURPOSE: Определяет ID дашборда для удаления, используя ID или slug.
|
||||
@@ -177,7 +177,7 @@ class SupersetClient:
|
||||
except Exception as e:
|
||||
self.logger.warning("[_resolve_target_id_for_delete][Warning] Could not resolve slug '%s' to ID: %s", dash_slug, e)
|
||||
return None
|
||||
# [/DEF:SupersetClient._resolve_target_id_for_delete]
|
||||
# [/DEF:SupersetClient._resolve_target_id_for_delete:Function]
|
||||
|
||||
# [DEF:SupersetClient._do_import:Function]
|
||||
# @PURPOSE: Выполняет один запрос на импорт без обработки исключений.
|
||||
@@ -200,7 +200,7 @@ class SupersetClient:
|
||||
extra_data={"overwrite": "true"},
|
||||
timeout=self.config.timeout * 2,
|
||||
)
|
||||
# [/DEF:SupersetClient._do_import]
|
||||
# [/DEF:SupersetClient._do_import:Function]
|
||||
|
||||
# [DEF:SupersetClient.delete_dashboard:Function]
|
||||
# @PURPOSE: Удаляет дашборд по его ID или slug.
|
||||
@@ -218,7 +218,7 @@ class SupersetClient:
|
||||
self.logger.info("[delete_dashboard][Success] Dashboard %s deleted.", dashboard_id)
|
||||
else:
|
||||
self.logger.warning("[delete_dashboard][Warning] Unexpected response while deleting %s: %s", dashboard_id, response)
|
||||
# [/DEF:SupersetClient.delete_dashboard]
|
||||
# [/DEF:SupersetClient.delete_dashboard:Function]
|
||||
|
||||
# [DEF:SupersetClient._extract_dashboard_id_from_zip:Function]
|
||||
# @PURPOSE: Извлекает ID дашборда из `metadata.yaml` внутри ZIP-архива.
|
||||
@@ -241,7 +241,7 @@ class SupersetClient:
|
||||
except Exception as exc:
|
||||
self.logger.error("[_extract_dashboard_id_from_zip][Failure] %s", exc, exc_info=True)
|
||||
return None
|
||||
# [/DEF:SupersetClient._extract_dashboard_id_from_zip]
|
||||
# [/DEF:SupersetClient._extract_dashboard_id_from_zip:Function]
|
||||
|
||||
# [DEF:SupersetClient._extract_dashboard_slug_from_zip:Function]
|
||||
# @PURPOSE: Извлекает slug дашборда из `metadata.yaml` внутри ZIP-архива.
|
||||
@@ -264,7 +264,7 @@ class SupersetClient:
|
||||
except Exception as exc:
|
||||
self.logger.error("[_extract_dashboard_slug_from_zip][Failure] %s", exc, exc_info=True)
|
||||
return None
|
||||
# [/DEF:SupersetClient._extract_dashboard_slug_from_zip]
|
||||
# [/DEF:SupersetClient._extract_dashboard_slug_from_zip:Function]
|
||||
|
||||
# [DEF:SupersetClient._validate_export_response:Function]
|
||||
# @PURPOSE: Проверяет, что HTTP-ответ на экспорт является валидным ZIP-архивом.
|
||||
@@ -280,7 +280,7 @@ class SupersetClient:
|
||||
raise ExportError(f"Получен не ZIP-архив (Content-Type: {content_type})")
|
||||
if not response.content:
|
||||
raise ExportError("Получены пустые данные при экспорте")
|
||||
# [/DEF:SupersetClient._validate_export_response]
|
||||
# [/DEF:SupersetClient._validate_export_response:Function]
|
||||
|
||||
# [DEF:SupersetClient._resolve_export_filename:Function]
|
||||
# @PURPOSE: Определяет имя файла для экспорта из заголовков или генерирует его.
|
||||
@@ -298,7 +298,7 @@ class SupersetClient:
|
||||
filename = f"dashboard_export_{dashboard_id}_{timestamp}.zip"
|
||||
self.logger.warning("[_resolve_export_filename][Warning] Generated filename: %s", filename)
|
||||
return filename
|
||||
# [/DEF:SupersetClient._resolve_export_filename]
|
||||
# [/DEF:SupersetClient._resolve_export_filename:Function]
|
||||
|
||||
# [DEF:SupersetClient._validate_query_params:Function]
|
||||
# @PURPOSE: Формирует корректный набор параметров запроса с пагинацией.
|
||||
@@ -310,7 +310,7 @@ class SupersetClient:
|
||||
assert query is None or isinstance(query, dict), "[_validate_query_params][PRE] query must be a dictionary or None."
|
||||
base_query = {"page": 0, "page_size": 1000}
|
||||
return {**base_query, **(query or {})}
|
||||
# [/DEF:SupersetClient._validate_query_params]
|
||||
# [/DEF:SupersetClient._validate_query_params:Function]
|
||||
|
||||
# [DEF:SupersetClient._fetch_total_object_count:Function]
|
||||
# @PURPOSE: Получает общее количество объектов по указанному эндпоинту для пагинации.
|
||||
@@ -326,7 +326,7 @@ class SupersetClient:
|
||||
query_params={"page": 0, "page_size": 1},
|
||||
count_field="count",
|
||||
)
|
||||
# [/DEF:SupersetClient._fetch_total_object_count]
|
||||
# [/DEF:SupersetClient._fetch_total_object_count:Function]
|
||||
|
||||
# [DEF:SupersetClient._fetch_all_pages:Function]
|
||||
# @PURPOSE: Итерируется по всем страницам пагинированного API и собирает все данные.
|
||||
@@ -340,7 +340,7 @@ class SupersetClient:
|
||||
assert endpoint and isinstance(endpoint, str), "[_fetch_all_pages][PRE] endpoint must be a non-empty string."
|
||||
assert isinstance(pagination_options, dict), "[_fetch_all_pages][PRE] pagination_options must be a dictionary."
|
||||
return self.network.fetch_paginated_data(endpoint=endpoint, pagination_options=pagination_options)
|
||||
# [/DEF:SupersetClient._fetch_all_pages]
|
||||
# [/DEF:SupersetClient._fetch_all_pages:Function]
|
||||
|
||||
# [DEF:SupersetClient._validate_import_file:Function]
|
||||
# @PURPOSE: Проверяет, что файл существует, является ZIP-архивом и содержит `metadata.yaml`.
|
||||
@@ -356,7 +356,7 @@ class SupersetClient:
|
||||
assert zipfile.is_zipfile(path), f"Файл {zip_path} не является ZIP-архивом"
|
||||
with zipfile.ZipFile(path, "r") as zf:
|
||||
assert any(n.endswith("metadata.yaml") for n in zf.namelist()), f"Архив {zip_path} не содержит 'metadata.yaml'"
|
||||
# [/DEF:SupersetClient._validate_import_file]
|
||||
# [/DEF:SupersetClient._validate_import_file:Function]
|
||||
|
||||
# [DEF:SupersetClient.get_datasets:Function]
|
||||
# @PURPOSE: Получает полный список датасетов, автоматически обрабатывая пагинацию.
|
||||
@@ -379,7 +379,7 @@ class SupersetClient:
|
||||
)
|
||||
self.logger.info("[get_datasets][Exit] Found %d datasets.", total_count)
|
||||
return total_count, paginated_data
|
||||
# [/DEF:SupersetClient.get_datasets]
|
||||
# [/DEF:SupersetClient.get_datasets:Function]
|
||||
|
||||
# [DEF:SupersetClient.get_databases:Function]
|
||||
# @PURPOSE: Получает полный список баз данных, автоматически обрабатывая пагинацию.
|
||||
@@ -403,7 +403,7 @@ class SupersetClient:
|
||||
)
|
||||
self.logger.info("[get_databases][Exit] Found %d databases.", total_count)
|
||||
return total_count, paginated_data
|
||||
# [/DEF:SupersetClient.get_databases]
|
||||
# [/DEF:SupersetClient.get_databases:Function]
|
||||
|
||||
# [DEF:SupersetClient.get_dataset:Function]
|
||||
# @PURPOSE: Получает информацию о конкретном датасете по его ID.
|
||||
@@ -420,7 +420,7 @@ class SupersetClient:
|
||||
response = cast(Dict, response)
|
||||
self.logger.info("[get_dataset][Exit] Got dataset %s.", dataset_id)
|
||||
return response
|
||||
# [/DEF:SupersetClient.get_dataset]
|
||||
# [/DEF:SupersetClient.get_dataset:Function]
|
||||
|
||||
# [DEF:SupersetClient.get_database:Function]
|
||||
# @PURPOSE: Получает информацию о конкретной базе данных по её ID.
|
||||
@@ -437,7 +437,7 @@ class SupersetClient:
|
||||
response = cast(Dict, response)
|
||||
self.logger.info("[get_database][Exit] Got database %s.", database_id)
|
||||
return response
|
||||
# [/DEF:SupersetClient.get_database]
|
||||
# [/DEF:SupersetClient.get_database:Function]
|
||||
|
||||
# [DEF:SupersetClient.update_dataset:Function]
|
||||
# @PURPOSE: Обновляет данные датасета по его ID.
|
||||
@@ -461,8 +461,8 @@ class SupersetClient:
|
||||
response = cast(Dict, response)
|
||||
self.logger.info("[update_dataset][Exit] Updated dataset %s.", dataset_id)
|
||||
return response
|
||||
# [/DEF:SupersetClient.update_dataset]
|
||||
# [/DEF:SupersetClient.update_dataset:Function]
|
||||
|
||||
# [/DEF:SupersetClient]
|
||||
# [/DEF:SupersetClient:Class]
|
||||
|
||||
# [/DEF:superset_tool.client]
|
||||
# [/DEF:superset_tool.client:Module]
|
||||
|
||||
Reference in New Issue
Block a user