semantic markup update
This commit is contained in:
@@ -5,6 +5,12 @@
|
||||
- 📦 **generate_semantic_map** (`Module`)
|
||||
- 📝 Scans the codebase to generate a Semantic Map and Compliance Report based on the System Standard.
|
||||
- 🏗️ Layer: DevOps/Tooling
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Mock init.
|
||||
- ƒ **__enter__** (`Function`)
|
||||
- 📝 Mock enter.
|
||||
- ƒ **__exit__** (`Function`)
|
||||
- 📝 Mock exit.
|
||||
- ℂ **SemanticEntity** (`Class`)
|
||||
- 📝 Represents a code entity (Module, Function, Component) found during parsing.
|
||||
- ƒ **__init__** (`Function`)
|
||||
@@ -142,6 +148,15 @@
|
||||
- 🔗 INHERITS_FROM -> `SupersetToolError`
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Initializes a network error.
|
||||
- ℂ **FileOperationError** (`Class`)
|
||||
- 📝 Общие ошибки файловых операций (I/O).
|
||||
- 🔗 INHERITS_FROM -> `SupersetToolError`
|
||||
- ℂ **InvalidFileStructureError** (`Class`)
|
||||
- 📝 Ошибка, указывающая на некорректную структуру файлов или директорий.
|
||||
- 🔗 INHERITS_FROM -> `FileOperationError`
|
||||
- ℂ **ConfigurationError** (`Class`)
|
||||
- 📝 Ошибки, связанные с неверной конфигурацией инструмента.
|
||||
- 🔗 INHERITS_FROM -> `SupersetToolError`
|
||||
- 📦 **superset_tool.models** (`Module`)
|
||||
- 📝 Определяет Pydantic-модели для конфигурации инструмента, обеспечивая валидацию данных.
|
||||
- 🏗️ Layer: Infra
|
||||
@@ -239,24 +254,28 @@
|
||||
- 📦 **superset_tool.utils.logger** (`Module`)
|
||||
- 📝 Предоставляет универсальную обёртку над стандартным `logging.Logger` для унифицированного создания и управления логгерами с выводом в консоль и/или файл.
|
||||
- 🏗️ Layer: Infra
|
||||
- ƒ **belief_scope** (`Function`)
|
||||
- 📝 Context manager for belief state logging to maintain execution coherence.
|
||||
- ℂ **SupersetLogger** (`Class`)
|
||||
- 📝 Обёртка над `logging.Logger`, которая упрощает конфигурацию и использование логгеров.
|
||||
- ƒ **SupersetLogger.__init__** (`Function`)
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Конфигурирует и инициализирует логгер, добавляя обработчики для файла и/или консоли.
|
||||
- ƒ **SupersetLogger._log** (`Function`)
|
||||
- ƒ **_log** (`Function`)
|
||||
- 📝 (Helper) Универсальный метод для вызова соответствующего уровня логирования.
|
||||
- ƒ **SupersetLogger.info** (`Function`)
|
||||
- ƒ **info** (`Function`)
|
||||
- 📝 Записывает сообщение уровня INFO.
|
||||
- ƒ **SupersetLogger.debug** (`Function`)
|
||||
- ƒ **debug** (`Function`)
|
||||
- 📝 Записывает сообщение уровня DEBUG.
|
||||
- ƒ **SupersetLogger.warning** (`Function`)
|
||||
- ƒ **warning** (`Function`)
|
||||
- 📝 Записывает сообщение уровня WARNING.
|
||||
- ƒ **SupersetLogger.error** (`Function`)
|
||||
- ƒ **error** (`Function`)
|
||||
- 📝 Записывает сообщение уровня ERROR.
|
||||
- ƒ **SupersetLogger.critical** (`Function`)
|
||||
- ƒ **critical** (`Function`)
|
||||
- 📝 Записывает сообщение уровня CRITICAL.
|
||||
- ƒ **SupersetLogger.exception** (`Function`)
|
||||
- ƒ **exception** (`Function`)
|
||||
- 📝 Записывает сообщение уровня ERROR вместе с трассировкой стека текущего исключения.
|
||||
- 📦 **belief_scope** (`Method`)
|
||||
- 📝 Instance method wrapper for belief_scope context manager.
|
||||
- 📦 **superset_tool.utils.fileio** (`Module`)
|
||||
- 📝 Предоставляет набор утилит для управления файловыми операциями, включая работу с временными файлами, архивами ZIP, файлами YAML и очистку директорий.
|
||||
- 🏗️ Layer: Infra
|
||||
@@ -286,6 +305,8 @@
|
||||
- 🔗 CALLS -> `_update_yaml_file`
|
||||
- ƒ **_update_yaml_file** (`Function`)
|
||||
- 📝 (Helper) Обновляет один YAML файл.
|
||||
- ƒ **replacer** (`Function`)
|
||||
- 📝 Функция замены, сохраняющая кавычки если они были.
|
||||
- ƒ **create_dashboard_export** (`Function`)
|
||||
- 📝 Создает ZIP-архив из указанных исходных путей.
|
||||
- ƒ **sanitize_filename** (`Function`)
|
||||
@@ -302,27 +323,27 @@
|
||||
- 🔗 DEPENDS_ON -> `requests`
|
||||
- ℂ **APIClient** (`Class`)
|
||||
- 📝 Инкапсулирует HTTP-логику для работы с API, включая сессии, аутентификацию, и обработку запросов.
|
||||
- ƒ **APIClient.__init__** (`Function`)
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Инициализирует API клиент с конфигурацией, сессией и логгером.
|
||||
- ƒ **APIClient._init_session** (`Function`)
|
||||
- ƒ **_init_session** (`Function`)
|
||||
- 📝 Создает и настраивает `requests.Session` с retry-логикой.
|
||||
- ƒ **APIClient.authenticate** (`Function`)
|
||||
- ƒ **authenticate** (`Function`)
|
||||
- 📝 Выполняет аутентификацию в Superset API и получает access и CSRF токены.
|
||||
- ƒ **APIClient.headers** (`Function`)
|
||||
- ƒ **headers** (`Function`)
|
||||
- 📝 Возвращает HTTP-заголовки для аутентифицированных запросов.
|
||||
- ƒ **APIClient.request** (`Function`)
|
||||
- ƒ **request** (`Function`)
|
||||
- 📝 Выполняет универсальный HTTP-запрос к API.
|
||||
- ƒ **APIClient._handle_http_error** (`Function`)
|
||||
- ƒ **_handle_http_error** (`Function`)
|
||||
- 📝 (Helper) Преобразует HTTP ошибки в кастомные исключения.
|
||||
- ƒ **APIClient._handle_network_error** (`Function`)
|
||||
- ƒ **_handle_network_error** (`Function`)
|
||||
- 📝 (Helper) Преобразует сетевые ошибки в `NetworkError`.
|
||||
- ƒ **APIClient.upload_file** (`Function`)
|
||||
- ƒ **upload_file** (`Function`)
|
||||
- 📝 Загружает файл на сервер через multipart/form-data.
|
||||
- ƒ **APIClient._perform_upload** (`Function`)
|
||||
- ƒ **_perform_upload** (`Function`)
|
||||
- 📝 (Helper) Выполняет POST запрос с файлом.
|
||||
- ƒ **APIClient.fetch_paginated_count** (`Function`)
|
||||
- ƒ **fetch_paginated_count** (`Function`)
|
||||
- 📝 Получает общее количество элементов для пагинации.
|
||||
- ƒ **APIClient.fetch_paginated_data** (`Function`)
|
||||
- ƒ **fetch_paginated_data** (`Function`)
|
||||
- 📝 Автоматически собирает данные со всех страниц пагинированного эндпоинта.
|
||||
- 📦 **superset_tool.utils.whiptail_fallback** (`Module`)
|
||||
- 📝 Предоставляет плотный консольный UI-fallback для интерактивных диалогов, имитируя `whiptail` для систем, где он недоступен.
|
||||
@@ -339,6 +360,16 @@
|
||||
- 📝 Запрашивает у пользователя текстовый ввод.
|
||||
- ℂ **_ConsoleGauge** (`Class`)
|
||||
- 📝 Контекстный менеджер для имитации `whiptail gauge` в консоли.
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Initializes the gauge.
|
||||
- ƒ **__enter__** (`Function`)
|
||||
- 📝 Enters the context.
|
||||
- ƒ **__exit__** (`Function`)
|
||||
- 📝 Exits the context.
|
||||
- ƒ **set_text** (`Function`)
|
||||
- 📝 Sets the gauge text.
|
||||
- ƒ **set_percent** (`Function`)
|
||||
- 📝 Sets the gauge percentage.
|
||||
- ƒ **gauge** (`Function`)
|
||||
- 📝 Создает и возвращает экземпляр `_ConsoleGauge`.
|
||||
- 📦 **superset_tool.utils.dataset_mapper** (`Module`)
|
||||
@@ -349,11 +380,13 @@
|
||||
- 🔗 DEPENDS_ON -> `psycopg2`
|
||||
- ℂ **DatasetMapper** (`Class`)
|
||||
- 📝 Класс для меппинга и обновления verbose_map в датасетах Superset.
|
||||
- ƒ **DatasetMapper.get_postgres_comments** (`Function`)
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Initializes the mapper.
|
||||
- ƒ **get_postgres_comments** (`Function`)
|
||||
- 📝 Извлекает комментарии к колонкам из системного каталога PostgreSQL.
|
||||
- ƒ **DatasetMapper.load_excel_mappings** (`Function`)
|
||||
- ƒ **load_excel_mappings** (`Function`)
|
||||
- 📝 Загружает меппинги 'column_name' -> 'column_comment' из XLSX файла.
|
||||
- ƒ **DatasetMapper.run_mapping** (`Function`)
|
||||
- ƒ **run_mapping** (`Function`)
|
||||
- 📝 Основная функция для выполнения меппинга и обновления verbose_map датасета в Superset.
|
||||
- 🔗 CALLS -> `self.get_postgres_comments`
|
||||
- 🔗 CALLS -> `self.load_excel_mappings`
|
||||
@@ -415,6 +448,20 @@
|
||||
- 📝 Generic request wrapper.
|
||||
- 📦 **api** (`Data`)
|
||||
- 📝 API client object with specific methods.
|
||||
- ƒ **selectPlugin** (`Function`)
|
||||
- 📝 Handles plugin selection and navigation.
|
||||
- ƒ **handleFormSubmit** (`Function`)
|
||||
- 📝 Handles task creation from dynamic form submission.
|
||||
- ƒ **load** (`Function`)
|
||||
- 📝 Loads initial plugin data for the dashboard.
|
||||
- ƒ **loadInitialData** (`Function`)
|
||||
- 📝 Loads tasks and environments on page initialization.
|
||||
- ƒ **refreshTasks** (`Function`)
|
||||
- 📝 Periodically refreshes the task list.
|
||||
- ƒ **handleSelectTask** (`Function`)
|
||||
- 📝 Updates the selected task ID when a task is clicked.
|
||||
- ƒ **handleRunBackup** (`Function`)
|
||||
- 📝 Triggers a manual backup task for the selected environment.
|
||||
- 🧩 **MigrationDashboard** (`Component`)
|
||||
- 📝 Main dashboard for configuring and starting migrations.
|
||||
- 🏗️ Layer: Page
|
||||
@@ -452,9 +499,25 @@
|
||||
- 🧩 **DebugPage** (`Component`)
|
||||
- 📝 Page for system diagnostics and debugging.
|
||||
- 🏗️ Layer: UI
|
||||
- ƒ **handleSaveGlobal** (`Function`)
|
||||
- 📝 Saves global application settings.
|
||||
- ƒ **handleAddOrUpdateEnv** (`Function`)
|
||||
- 📝 Adds a new environment or updates an existing one.
|
||||
- ƒ **handleDeleteEnv** (`Function`)
|
||||
- 📝 Deletes a Superset environment.
|
||||
- ƒ **handleTestEnv** (`Function`)
|
||||
- 📝 Tests the connection to a Superset environment.
|
||||
- ƒ **editEnv** (`Function`)
|
||||
- 📝 Populates the environment form for editing.
|
||||
- ƒ **resetEnvForm** (`Function`)
|
||||
- 📝 Resets the environment creation/edit form to default state.
|
||||
- ƒ **load** (`Function`)
|
||||
- 📝 Loads application settings and environment list.
|
||||
- 🧩 **ConnectionsSettingsPage** (`Component`)
|
||||
- 📝 Page for managing database connection configurations.
|
||||
- 🏗️ Layer: UI
|
||||
- ƒ **handleSuccess** (`Function`)
|
||||
- 📝 Refreshes the connection list after a successful creation.
|
||||
- 🧩 **Dashboard** (`Component`)
|
||||
- 📝 Displays the list of available plugins and allows selecting one.
|
||||
- 🏗️ Layer: UI
|
||||
@@ -479,6 +542,28 @@
|
||||
- 📝 Sets the form to edit an existing environment.
|
||||
- ƒ **resetEnvForm** (`Function`)
|
||||
- 📝 Resets the environment form.
|
||||
- ƒ **getConnections** (`Function`)
|
||||
- 📝 Fetch a list of saved connections.
|
||||
- ƒ **createConnection** (`Function`)
|
||||
- 📝 Create a new connection configuration.
|
||||
- ƒ **deleteConnection** (`Function`)
|
||||
- 📝 Delete a connection configuration.
|
||||
- ƒ **runTask** (`Function`)
|
||||
- 📝 Start a new task for a given plugin.
|
||||
- ƒ **getTaskStatus** (`Function`)
|
||||
- 📝 Fetch details for a specific task (to poll status or get result).
|
||||
- ƒ **getTasks** (`Function`)
|
||||
- 📝 Fetch a list of tasks with pagination and optional status filter.
|
||||
- ƒ **getTask** (`Function`)
|
||||
- 📝 Fetch details for a specific task.
|
||||
- ƒ **getTaskLogs** (`Function`)
|
||||
- 📝 Fetch logs for a specific task.
|
||||
- ƒ **resumeTask** (`Function`)
|
||||
- 📝 Resume a task that is awaiting input (e.g., passwords).
|
||||
- ƒ **resolveTask** (`Function`)
|
||||
- 📝 Resolve a task that is awaiting mapping.
|
||||
- ƒ **clearTasks** (`Function`)
|
||||
- 📝 Clear tasks based on status.
|
||||
- 🧩 **PasswordPrompt** (`Component`)
|
||||
- 📝 A modal component to prompt the user for database passwords when a migration task is paused.
|
||||
- 🏗️ Layer: UI
|
||||
@@ -595,6 +680,8 @@
|
||||
- 🏗️ Layer: UI
|
||||
- ƒ **handleSubmit** (`Function`)
|
||||
- 📝 Submits the connection form to the backend.
|
||||
- ƒ **resetForm** (`Function`)
|
||||
- 📝 Resets the connection form fields to their default values.
|
||||
- 🧩 **ConnectionList** (`Component`)
|
||||
- 📝 UI component for listing and deleting saved database connection configurations.
|
||||
- 🏗️ Layer: UI
|
||||
@@ -632,30 +719,46 @@
|
||||
- 🏗️ Layer: UI (API)
|
||||
- 📦 **App** (`Global`)
|
||||
- 📝 The global FastAPI application instance.
|
||||
- 📦 **WebSocketEndpoint** (`Endpoint`)
|
||||
- 📝 Provides a WebSocket endpoint for clients to connect to and receive real-time log entries for a specific task.
|
||||
- ƒ **startup_event** (`Function`)
|
||||
- 📝 Handles application startup tasks, such as starting the scheduler.
|
||||
- ƒ **shutdown_event** (`Function`)
|
||||
- 📝 Handles application shutdown tasks, such as stopping the scheduler.
|
||||
- ƒ **log_requests** (`Function`)
|
||||
- 📝 Middleware to log incoming HTTP requests and their response status.
|
||||
- ƒ **websocket_endpoint** (`Function`)
|
||||
- 📝 Provides a WebSocket endpoint for real-time log streaming of a task.
|
||||
- 📦 **StaticFiles** (`Mount`)
|
||||
- 📝 Mounts the frontend build directory to serve static assets.
|
||||
- 📦 **RootEndpoint** (`Endpoint`)
|
||||
- 📝 A simple root endpoint to confirm that the API is running.
|
||||
- ƒ **serve_spa** (`Function`)
|
||||
- 📝 Serves frontend static files or index.html for SPA routing.
|
||||
- ƒ **read_root** (`Function`)
|
||||
- 📝 A simple root endpoint to confirm that the API is running when frontend is missing.
|
||||
- 📦 **Dependencies** (`Module`)
|
||||
- 📝 Manages the creation and provision of shared application dependencies, such as the PluginLoader and TaskManager, to avoid circular imports.
|
||||
- 🏗️ Layer: Core
|
||||
- ƒ **get_config_manager** (`Function`)
|
||||
- 📝 Dependency injector for the ConfigManager.
|
||||
- ƒ **get_plugin_loader** (`Function`)
|
||||
- 📝 Dependency injector for the PluginLoader.
|
||||
- ƒ **get_task_manager** (`Function`)
|
||||
- 📝 Dependency injector for the TaskManager.
|
||||
- ƒ **get_scheduler_service** (`Function`)
|
||||
- 📝 Dependency injector for the SchedulerService.
|
||||
- 📦 **backend.src.core.superset_client** (`Module`)
|
||||
- 📝 Extends the base SupersetClient with database-specific metadata fetching.
|
||||
- 🏗️ Layer: Core
|
||||
- 🔗 INHERITS_FROM -> `superset_tool.client.SupersetClient`
|
||||
- ℂ **SupersetClient** (`Class`)
|
||||
- 📝 Extended SupersetClient for migration-specific operations.
|
||||
- ƒ **SupersetClient.get_databases_summary** (`Function`)
|
||||
- ƒ **get_databases_summary** (`Function`)
|
||||
- 📝 Fetch a summary of databases including uuid, name, and engine.
|
||||
- ƒ **SupersetClient.get_database_by_uuid** (`Function`)
|
||||
- ƒ **get_database_by_uuid** (`Function`)
|
||||
- 📝 Find a database by its UUID.
|
||||
- ƒ **SupersetClient.get_dashboards_summary** (`Function`)
|
||||
- ƒ **get_dashboards_summary** (`Function`)
|
||||
- 📝 Fetches dashboard metadata optimized for the grid.
|
||||
- ƒ **SupersetClient.get_dataset** (`Function`)
|
||||
- ƒ **get_dataset** (`Function`)
|
||||
- 📝 Fetch full dataset structure including columns and metrics.
|
||||
- ƒ **SupersetClient.update_dataset** (`Function`)
|
||||
- ƒ **update_dataset** (`Function`)
|
||||
- 📝 Update dataset metadata.
|
||||
- 📦 **ConfigManagerModule** (`Module`)
|
||||
- 📝 Manages application configuration, including loading/saving to JSON and CRUD for environments.
|
||||
@@ -693,15 +796,17 @@
|
||||
- 🏗️ Layer: Core
|
||||
- ℂ **SchedulerService** (`Class`)
|
||||
- 📝 Provides a service to manage scheduled backup tasks.
|
||||
- ƒ **SchedulerService.start** (`Function`)
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Initializes the scheduler service with task and config managers.
|
||||
- ƒ **start** (`Function`)
|
||||
- 📝 Starts the background scheduler and loads initial schedules.
|
||||
- ƒ **SchedulerService.stop** (`Function`)
|
||||
- ƒ **stop** (`Function`)
|
||||
- 📝 Stops the background scheduler.
|
||||
- ƒ **SchedulerService.load_schedules** (`Function`)
|
||||
- ƒ **load_schedules** (`Function`)
|
||||
- 📝 Loads backup schedules from configuration and registers them.
|
||||
- ƒ **SchedulerService.add_backup_job** (`Function`)
|
||||
- ƒ **add_backup_job** (`Function`)
|
||||
- 📝 Adds a scheduled backup job for an environment.
|
||||
- ƒ **SchedulerService._trigger_backup** (`Function`)
|
||||
- ƒ **_trigger_backup** (`Function`)
|
||||
- 📝 Triggered by the scheduler to start a backup task.
|
||||
- 📦 **ConfigModels** (`Module`)
|
||||
- 📝 Defines the data models for application configuration using Pydantic.
|
||||
@@ -739,32 +844,40 @@
|
||||
- 🏗️ Layer: Core
|
||||
- ℂ **BeliefFormatter** (`Class`)
|
||||
- 📝 Custom logging formatter that adds belief state prefixes to log messages.
|
||||
- ƒ **format** (`Function`)
|
||||
- 📝 Formats the log record, adding belief state context if available.
|
||||
- ℂ **LogEntry** (`Class`)
|
||||
- 📝 A Pydantic model representing a single, structured log entry. This is a re-definition for consistency, as it's also defined in task_manager.py.
|
||||
- ƒ **BeliefScope** (`Function`)
|
||||
- ƒ **belief_scope** (`Function`)
|
||||
- 📝 Context manager for structured Belief State logging.
|
||||
- ƒ **ConfigureLogger** (`Function`)
|
||||
- ƒ **configure_logger** (`Function`)
|
||||
- 📝 Configures the logger with the provided logging settings.
|
||||
- ℂ **WebSocketLogHandler** (`Class`)
|
||||
- 📝 A custom logging handler that captures log records into a buffer. It is designed to be extended for real-time log streaming over WebSockets.
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Initializes the handler with a fixed-capacity buffer.
|
||||
- ƒ **emit** (`Function`)
|
||||
- 📝 Captures a log record, formats it, and stores it in the buffer.
|
||||
- ƒ **get_recent_logs** (`Function`)
|
||||
- 📝 Returns a list of recent log entries from the buffer.
|
||||
- 📦 **Logger** (`Global`)
|
||||
- 📝 The global logger instance for the application, configured with both a console handler and the custom WebSocket handler.
|
||||
- ℂ **PluginLoader** (`Class`)
|
||||
- 📝 Scans a specified directory for Python modules, dynamically loads them, and registers any classes that are valid implementations of the PluginBase interface.
|
||||
- 🏗️ Layer: Core
|
||||
- ƒ **PluginLoader.__init__** (`Function`)
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Initializes the PluginLoader with a directory to scan.
|
||||
- ƒ **PluginLoader._load_plugins** (`Function`)
|
||||
- ƒ **_load_plugins** (`Function`)
|
||||
- 📝 Scans the plugin directory and loads all valid plugins.
|
||||
- ƒ **PluginLoader._load_module** (`Function`)
|
||||
- ƒ **_load_module** (`Function`)
|
||||
- 📝 Loads a single Python module and discovers PluginBase implementations.
|
||||
- ƒ **PluginLoader._register_plugin** (`Function`)
|
||||
- ƒ **_register_plugin** (`Function`)
|
||||
- 📝 Registers a PluginBase instance and its configuration.
|
||||
- ƒ **PluginLoader.get_plugin** (`Function`)
|
||||
- ƒ **get_plugin** (`Function`)
|
||||
- 📝 Retrieves a loaded plugin instance by its ID.
|
||||
- ƒ **PluginLoader.get_all_plugin_configs** (`Function`)
|
||||
- ƒ **get_all_plugin_configs** (`Function`)
|
||||
- 📝 Returns a list of all registered plugin configurations.
|
||||
- ƒ **PluginLoader.has_plugin** (`Function`)
|
||||
- ƒ **has_plugin** (`Function`)
|
||||
- 📝 Checks if a plugin with the given ID is registered.
|
||||
- 📦 **backend.src.core.migration_engine** (`Module`)
|
||||
- 📝 Handles the interception and transformation of Superset asset ZIP archives.
|
||||
@@ -772,13 +885,25 @@
|
||||
- 🔗 DEPENDS_ON -> `PyYAML`
|
||||
- ℂ **MigrationEngine** (`Class`)
|
||||
- 📝 Engine for transforming Superset export ZIPs.
|
||||
- ƒ **MigrationEngine.transform_zip** (`Function`)
|
||||
- ƒ **transform_zip** (`Function`)
|
||||
- 📝 Extracts ZIP, replaces database UUIDs in YAMLs, and re-packages.
|
||||
- ƒ **MigrationEngine._transform_yaml** (`Function`)
|
||||
- ƒ **_transform_yaml** (`Function`)
|
||||
- 📝 Replaces database_uuid in a single YAML file.
|
||||
- ℂ **PluginBase** (`Class`)
|
||||
- 📝 Defines the abstract base class that all plugins must implement to be recognized by the system. It enforces a common structure for plugin metadata and execution.
|
||||
- 🏗️ Layer: Core
|
||||
- ƒ **id** (`Function`)
|
||||
- 📝 Returns the unique identifier for the plugin.
|
||||
- ƒ **name** (`Function`)
|
||||
- 📝 Returns the human-readable name of the plugin.
|
||||
- ƒ **description** (`Function`)
|
||||
- 📝 Returns a brief description of the plugin.
|
||||
- ƒ **version** (`Function`)
|
||||
- 📝 Returns the version of the plugin.
|
||||
- ƒ **get_schema** (`Function`)
|
||||
- 📝 Returns the JSON schema for the plugin's input parameters.
|
||||
- ƒ **execute** (`Function`)
|
||||
- 📝 Executes the plugin's core logic.
|
||||
- ℂ **PluginConfig** (`Class`)
|
||||
- 📝 A Pydantic model used to represent the validated configuration and metadata of a loaded plugin. This object is what gets exposed to the API layer.
|
||||
- 🏗️ Layer: Core
|
||||
@@ -868,6 +993,8 @@
|
||||
- 📦 **AuthModule** (`Module`)
|
||||
- 📝 Implements ADFS authentication using Authlib for FastAPI. It provides a dependency to protect endpoints.
|
||||
- 🏗️ Layer: UI (API)
|
||||
- ƒ **get_current_user** (`Function`)
|
||||
- 📝 Dependency to get the current user from the ADFS token.
|
||||
- 📦 **ConnectionsRouter** (`Module`)
|
||||
- 📝 Defines the FastAPI router for managing external database connections.
|
||||
- 🏗️ Layer: UI (API)
|
||||
@@ -907,6 +1034,8 @@
|
||||
- 📦 **PluginsRouter** (`Module`)
|
||||
- 📝 Defines the FastAPI router for plugin-related endpoints, allowing clients to list available plugins.
|
||||
- 🏗️ Layer: UI (API)
|
||||
- ƒ **list_plugins** (`Function`)
|
||||
- 📝 Retrieve a list of all available plugins.
|
||||
- 📦 **backend.src.api.routes.mappings** (`Module`)
|
||||
- 📝 API endpoints for managing database mappings and getting suggestions.
|
||||
- 🏗️ Layer: API
|
||||
@@ -946,6 +1075,20 @@
|
||||
- 📦 **TasksRouter** (`Module`)
|
||||
- 📝 Defines the FastAPI router for task-related endpoints, allowing clients to create, list, and get the status of tasks.
|
||||
- 🏗️ Layer: UI (API)
|
||||
- ƒ **create_task** (`Function`)
|
||||
- 📝 Create and start a new task for a given plugin.
|
||||
- ƒ **list_tasks** (`Function`)
|
||||
- 📝 Retrieve a list of tasks with pagination and optional status filter.
|
||||
- ƒ **get_task** (`Function`)
|
||||
- 📝 Retrieve the details of a specific task.
|
||||
- ƒ **get_task_logs** (`Function`)
|
||||
- 📝 Retrieve logs for a specific task.
|
||||
- ƒ **resolve_task** (`Function`)
|
||||
- 📝 Resolve a task that is awaiting mapping.
|
||||
- ƒ **resume_task** (`Function`)
|
||||
- 📝 Resume a task that is awaiting input (e.g., passwords).
|
||||
- ƒ **clear_tasks** (`Function`)
|
||||
- 📝 Clear tasks matching the status filter.
|
||||
- 📦 **backend.src.models.task** (`Module`)
|
||||
- 📝 Defines the database schema for task execution records.
|
||||
- 🏗️ Layer: Domain
|
||||
@@ -984,11 +1127,11 @@
|
||||
- 🔗 DEPENDS_ON -> `backend.src.core.utils.matching`
|
||||
- ℂ **MappingService** (`Class`)
|
||||
- 📝 Service for handling database mapping logic.
|
||||
- ƒ **MappingService.__init__** (`Function`)
|
||||
- ƒ **__init__** (`Function`)
|
||||
- 📝 Initializes the mapping service with a config manager.
|
||||
- ƒ **MappingService._get_client** (`Function`)
|
||||
- ƒ **_get_client** (`Function`)
|
||||
- 📝 Helper to get an initialized SupersetClient for an environment.
|
||||
- ƒ **MappingService.get_suggestions** (`Function`)
|
||||
- ƒ **get_suggestions** (`Function`)
|
||||
- 📝 Fetches databases from both environments and returns fuzzy matching suggestions.
|
||||
- 📦 **BackupPlugin** (`Module`)
|
||||
- 📝 A plugin that provides functionality to back up Superset dashboards.
|
||||
@@ -997,38 +1140,74 @@
|
||||
- 🔗 DEPENDS_ON -> `superset_tool.utils`
|
||||
- ℂ **BackupPlugin** (`Class`)
|
||||
- 📝 Implementation of the backup plugin logic.
|
||||
- ƒ **id** (`Function`)
|
||||
- 📝 Returns the unique identifier for the backup plugin.
|
||||
- ƒ **name** (`Function`)
|
||||
- 📝 Returns the human-readable name of the backup plugin.
|
||||
- ƒ **description** (`Function`)
|
||||
- 📝 Returns a description of the backup plugin.
|
||||
- ƒ **version** (`Function`)
|
||||
- 📝 Returns the version of the backup plugin.
|
||||
- ƒ **get_schema** (`Function`)
|
||||
- 📝 Returns the JSON schema for backup plugin parameters.
|
||||
- ƒ **execute** (`Function`)
|
||||
- 📝 Executes the dashboard backup logic.
|
||||
- 📦 **DebugPluginModule** (`Module`)
|
||||
- 📝 Implements a plugin for system diagnostics and debugging Superset API responses.
|
||||
- 🏗️ Layer: Plugins
|
||||
- ℂ **DebugPlugin** (`Class`)
|
||||
- 📝 Plugin for system diagnostics and debugging.
|
||||
- ƒ **DebugPlugin.get_schema** (`Function`)
|
||||
- ƒ **id** (`Function`)
|
||||
- 📝 Returns the unique identifier for the debug plugin.
|
||||
- ƒ **name** (`Function`)
|
||||
- 📝 Returns the human-readable name of the debug plugin.
|
||||
- ƒ **description** (`Function`)
|
||||
- 📝 Returns a description of the debug plugin.
|
||||
- ƒ **version** (`Function`)
|
||||
- 📝 Returns the version of the debug plugin.
|
||||
- ƒ **get_schema** (`Function`)
|
||||
- 📝 Returns the JSON schema for the debug plugin parameters.
|
||||
- ƒ **DebugPlugin.execute** (`Function`)
|
||||
- ƒ **execute** (`Function`)
|
||||
- 📝 Executes the debug logic.
|
||||
- ƒ **DebugPlugin._test_db_api** (`Function`)
|
||||
- ƒ **_test_db_api** (`Function`)
|
||||
- 📝 Tests database API connectivity for source and target environments.
|
||||
- ƒ **DebugPlugin._get_dataset_structure** (`Function`)
|
||||
- ƒ **_get_dataset_structure** (`Function`)
|
||||
- 📝 Retrieves the structure of a dataset.
|
||||
- 📦 **SearchPluginModule** (`Module`)
|
||||
- 📝 Implements a plugin for searching text patterns across all datasets in a specific Superset environment.
|
||||
- 🏗️ Layer: Plugins
|
||||
- ℂ **SearchPlugin** (`Class`)
|
||||
- 📝 Plugin for searching text patterns in Superset datasets.
|
||||
- ƒ **SearchPlugin.get_schema** (`Function`)
|
||||
- ƒ **id** (`Function`)
|
||||
- 📝 Returns the unique identifier for the search plugin.
|
||||
- ƒ **name** (`Function`)
|
||||
- 📝 Returns the human-readable name of the search plugin.
|
||||
- ƒ **description** (`Function`)
|
||||
- 📝 Returns a description of the search plugin.
|
||||
- ƒ **version** (`Function`)
|
||||
- 📝 Returns the version of the search plugin.
|
||||
- ƒ **get_schema** (`Function`)
|
||||
- 📝 Returns the JSON schema for the search plugin parameters.
|
||||
- ƒ **SearchPlugin.execute** (`Function`)
|
||||
- ƒ **execute** (`Function`)
|
||||
- 📝 Executes the dataset search logic.
|
||||
- ƒ **SearchPlugin._get_context** (`Function`)
|
||||
- ƒ **_get_context** (`Function`)
|
||||
- 📝 Extracts a small context around the match for display.
|
||||
- 📦 **MapperPluginModule** (`Module`)
|
||||
- 📝 Implements a plugin for mapping dataset columns using external database connections or Excel files.
|
||||
- 🏗️ Layer: Plugins
|
||||
- ℂ **MapperPlugin** (`Class`)
|
||||
- 📝 Plugin for mapping dataset columns verbose names.
|
||||
- ƒ **MapperPlugin.get_schema** (`Function`)
|
||||
- ƒ **id** (`Function`)
|
||||
- 📝 Returns the unique identifier for the mapper plugin.
|
||||
- ƒ **name** (`Function`)
|
||||
- 📝 Returns the human-readable name of the mapper plugin.
|
||||
- ƒ **description** (`Function`)
|
||||
- 📝 Returns a description of the mapper plugin.
|
||||
- ƒ **version** (`Function`)
|
||||
- 📝 Returns the version of the mapper plugin.
|
||||
- ƒ **get_schema** (`Function`)
|
||||
- 📝 Returns the JSON schema for the mapper plugin parameters.
|
||||
- ƒ **MapperPlugin.execute** (`Function`)
|
||||
- ƒ **execute** (`Function`)
|
||||
- 📝 Executes the dataset mapping logic.
|
||||
- 📦 **MigrationPlugin** (`Module`)
|
||||
- 📝 A plugin that provides functionality to migrate Superset dashboards between environments.
|
||||
@@ -1037,5 +1216,25 @@
|
||||
- 🔗 DEPENDS_ON -> `superset_tool.utils`
|
||||
- ℂ **MigrationPlugin** (`Class`)
|
||||
- 📝 Implementation of the migration plugin logic.
|
||||
- 📦 **MigrationPlugin.execute** (`Action`)
|
||||
- 📝 Execute the migration logic with proper task logging.
|
||||
- ƒ **id** (`Function`)
|
||||
- 📝 Returns the unique identifier for the migration plugin.
|
||||
- ƒ **name** (`Function`)
|
||||
- 📝 Returns the human-readable name of the migration plugin.
|
||||
- ƒ **description** (`Function`)
|
||||
- 📝 Returns a description of the migration plugin.
|
||||
- ƒ **version** (`Function`)
|
||||
- 📝 Returns the version of the migration plugin.
|
||||
- ƒ **get_schema** (`Function`)
|
||||
- 📝 Returns the JSON schema for migration plugin parameters.
|
||||
- ƒ **execute** (`Function`)
|
||||
- 📝 Executes the dashboard migration logic.
|
||||
- ƒ **test_superset_config_url_normalization** (`Function`)
|
||||
- 📝 Tests that SupersetConfig correctly normalizes the base URL.
|
||||
- ƒ **test_superset_config_invalid_url** (`Function`)
|
||||
- 📝 Tests that SupersetConfig raises ValueError for invalid URLs.
|
||||
- ƒ **test_belief_scope_logs_entry_action_exit** (`Function`)
|
||||
- 📝 Test that belief_scope generates [ID][Entry], [ID][Action], and [ID][Exit] logs.
|
||||
- ƒ **test_belief_scope_error_handling** (`Function`)
|
||||
- 📝 Test that belief_scope logs Coherence:Failed on exception.
|
||||
- ƒ **test_belief_scope_success_coherence** (`Function`)
|
||||
- 📝 Test that belief_scope logs Coherence:OK on success.
|
||||
|
||||
Reference in New Issue
Block a user