# # @SEMANTICS: search, superset, dataset, regex # @PURPOSE: Предоставляет утилиты для поиска по текстовым паттернам в метаданных датасетов Superset. # @DEPENDS_ON: superset_tool.client -> Для взаимодействия с API Superset. # @DEPENDS_ON: superset_tool.utils -> Для логирования и инициализации клиентов. # import logging import re from typing import Dict, Optional from requests.exceptions import RequestException from superset_tool.client import SupersetClient from superset_tool.exceptions import SupersetAPIError from superset_tool.utils.logger import SupersetLogger from superset_tool.utils.init_clients import setup_clients # # --- Начало кода модуля --- # # @PURPOSE: Выполняет поиск по строковому паттерну в метаданных всех датасетов. # @PRE: `client` должен быть инициализированным экземпляром `SupersetClient`. # @PRE: `search_pattern` должен быть валидной строкой регулярного выражения. # @POST: Возвращает словарь с результатами поиска, где ключ - ID датасета, значение - список совпадений. # @PARAM: client: SupersetClient - Клиент для доступа к API Superset. # @PARAM: search_pattern: str - Регулярное выражение для поиска. # @PARAM: logger: Optional[SupersetLogger] - Инстанс логгера. # @RETURN: Optional[Dict] - Словарь с результатами или None, если ничего не найдено. # @THROW: re.error - Если паттерн регулярного выражения невалиден. # @THROW: SupersetAPIError, RequestException - При критических ошибках API. # @RELATION: CALLS -> client.get_datasets def search_datasets( client: SupersetClient, search_pattern: str, logger: Optional[SupersetLogger] = None ) -> Optional[Dict]: logger = logger or SupersetLogger(name="dataset_search") logger.info(f"[search_datasets][Enter] Searching for pattern: '{search_pattern}'") try: _, datasets = client.get_datasets(query={"columns": ["id", "table_name", "sql", "database", "columns"]}) if not datasets: logger.warning("[search_datasets][State] No datasets found.") return None pattern = re.compile(search_pattern, re.IGNORECASE) results = {} for dataset in datasets: dataset_id = dataset.get('id') if not dataset_id: continue matches = [] for field, value in dataset.items(): value_str = str(value) if pattern.search(value_str): match_obj = pattern.search(value_str) matches.append({ "field": field, "match": match_obj.group() if match_obj else "", "value": value_str }) if matches: results[dataset_id] = matches logger.info(f"[search_datasets][Success] Found matches in {len(results)} datasets.") return results except re.error as e: logger.error(f"[search_datasets][Failure] Invalid regex pattern: {e}", exc_info=True) raise except (SupersetAPIError, RequestException) as e: logger.critical(f"[search_datasets][Failure] Critical error during search: {e}", exc_info=True) raise # # # @PURPOSE: Форматирует результаты поиска для читаемого вывода в консоль. # @PRE: `results` является словарем, возвращенным `search_datasets`, или `None`. # @POST: Возвращает отформатированную строку с результатами. # @PARAM: results: Optional[Dict] - Словарь с результатами поиска. # @PARAM: context_lines: int - Количество строк контекста для вывода до и после совпадения. # @RETURN: str - Отформатированный отчет. def print_search_results(results: Optional[Dict], context_lines: int = 3) -> str: if not results: return "Ничего не найдено" output = [] for dataset_id, matches in results.items(): output.append(f"\n--- Dataset ID: {dataset_id} ---") for match_info in matches: field, match_text, full_value = match_info['field'], match_info['match'], match_info['value'] output.append(f" - Поле: {field}") output.append(f" Совпадение: '{match_text}'") lines = full_value.splitlines() if not lines: continue match_line_index = -1 for i, line in enumerate(lines): if match_text in line: match_line_index = i break if match_line_index != -1: start = max(0, match_line_index - context_lines) end = min(len(lines), match_line_index + context_lines + 1) output.append(" Контекст:") for i in range(start, end): prefix = f"{i + 1:5d}: " line_content = lines[i] if i == match_line_index: highlighted = line_content.replace(match_text, f">>>{match_text}<<<") output.append(f" {prefix}{highlighted}") else: output.append(f" {prefix}{line_content}") output.append("-" * 25) return "\n".join(output) # # # @PURPOSE: Основная точка входа для запуска скрипта поиска. # @RELATION: CALLS -> setup_clients # @RELATION: CALLS -> search_datasets # @RELATION: CALLS -> print_search_results def main(): logger = SupersetLogger(level=logging.INFO, console=True) clients = setup_clients(logger) target_client = clients['prod'] search_query = r".account_balance_by_contract" results = search_datasets( client=target_client, search_pattern=search_query, logger=logger ) report = print_search_results(results) logger.info(f"[main][Success] Search finished. Report:\n{report}") # if __name__ == "__main__": main() # --- Конец кода модуля --- #