edu-rdm-integration 3.11.2__py3-none-any.whl → 3.13.0__py3-none-any.whl

edu_rdm_integration/adapters/results.py

@@ -1,65 +0,0 @@
-from abc import (
-    ABCMeta,
-)
-
-from function_tools.results import (
-    BaseRunnableResult,
-)
-
-
-class WebEduRunnerResult(BaseRunnableResult, metaclass=ABCMeta):
-    """Базовый класс результатов работы исполнителей функций продуктов Образования.
-
-    Предоставляет базовую структуру для представления результатов выполнения
-    исполнителей (runners) в контексте образовательных продуктов. Наследует
-    функциональность BaseRunnableResult и адаптирует её для специфики
-    образовательной системы.
-
-    Основные возможности:
-    - Хранение результатов выполнения исполнителей
-    - Доступ к данным результата и метаданным
-    - Поддержка цепочки обработки результатов
-    - Интеграция с системой логирования
-
-    Note:
-        - Является абстрактным классом
-        - Требует реализации в конкретных классах результатов
-        - Поддерживает стандартные операции с результатами
-        - Интегрируется с системой обработки ошибок
-        - Обеспечивает единообразную обработку результатов
-
-    See Also:
-        - BaseRunnableResult: базовый класс для результатов исполнителей
-        - WebEduRunner: исполнитель функций образовательных продуктов
-        - WebEduFunctionResult: результаты функций образовательных продуктов
-    """
-
-
-class WebEduFunctionResult(BaseRunnableResult, metaclass=ABCMeta):
-    """Базовый класс результатов функций продуктов Образования.
-
-    Предоставляет базовую структуру для представления результатов выполнения
-    функций в контексте образовательных продуктов. Наследует функциональность
-    BaseRunnableResult и адаптирует её для специфики бизнес-функций
-    образовательной системы.
-
-    Основные возможности:
-    - Хранение результатов выполнения функций
-    - Структурированное представление данных
-    - Поддержка метаданных и контекста выполнения
-    - Валидация результатов бизнес-функций
-    - Интеграция с системой отчетности
-
-    Note:
-        - Является абстрактным классом
-        - Требует реализации в конкретных классах результатов
-        - Поддерживает различные типы данных результатов
-        - Учитывает бизнес-правила образовательной системы
-        - Интегрируется с системой аудита
-        - Обеспечивает прослеживаемость выполнения функций
-
-    See Also:
-        - BaseRunnableResult: базовый класс для результатов
-        - WebEduRunnerResult: результаты исполнителей
-        - WebEduResultPresenter: презентер результатов
-    """

edu_rdm_integration/adapters/runners.py

@@ -1,140 +0,0 @@
-"""Исполнители (runners) для функций интеграции с продуктами Образования.
-
-Этот модуль содержит классы исполнителей, которые отвечают за запуск и управление
-выполнением функций обработки данных. Исполнители обеспечивают:
-- Подготовку и валидацию входных данных
-- Управление жизненным циклом функций
-- Логирование процесса выполнения
-- Обработку результатов и ошибок
-"""
-
-from abc import (
-    ABCMeta,
-)
-
-from educommon import (
-    logger,
-)
-from function_tools.runners import (
-    BaseRunner,
-    GlobalHelperRunner,
-)
-
-from edu_rdm_integration.adapters.helpers import (
-    WebEduRunnerHelper,
-)
-from edu_rdm_integration.adapters.results import (
-    WebEduRunnerResult,
-)
-from edu_rdm_integration.adapters.validators import (
-    WebEduRunnerValidator,
-)
-from edu_rdm_integration.core.consts import (
-    LOGS_DELIMITER,
-)
-
-
-class WebEduRunner(BaseRunner, metaclass=ABCMeta):
-    """Базовый класс исполнителей функций продуктов Образования.
-
-    Предоставляет основную функциональность для запуска и управления
-    выполнением функций обработки данных. Включает:
-    - Подготовку и валидацию входных параметров
-    - Логирование процесса выполнения
-    - Обработку результатов и ошибок
-    - Управление очередью выполнения
-
-    Attributes:
-        helper (WebEduRunnerHelper): Помощник для вспомогательных операций
-        validator (WebEduRunnerValidator): Валидатор входных данных
-        result (WebEduRunnerResult): Объект для хранения результатов
-    """
-
-    def _prepare_helper_class(self) -> type[WebEduRunnerHelper]:
-        """Возвращает класс помощника исполнителя.
-
-        Returns:
-            type[WebEduRunnerHelper]: Класс помощника для вспомогательных операций
-            при выполнении функций
-        """
-        return WebEduRunnerHelper
-
-    def _prepare_validator_class(self) -> type[WebEduRunnerValidator]:
-        """Возвращает класс валидатора исполнителя.
-
-        Returns:
-            type[WebEduRunnerValidator]: Класс для валидации входных параметров
-            и проверки состояния исполнителя
-        """
-        return WebEduRunnerValidator
-
-    def _prepare_result_class(self) -> type[WebEduRunnerResult]:
-        """Возвращает класс результата исполнителя.
-
-        Returns:
-            type[WebEduRunnerResult]: Класс для хранения результатов выполнения
-            функций и возможных ошибок
-        """
-        return WebEduRunnerResult
-
-    def _prepare_runnable_before_enqueue(self, runnable, *args, **kwargs):
-        """Подготовка запускаемого объекта перед добавлением в очередь.
-
-        Выполняет базовую подготовку объекта и добавляет логирование
-        для отслеживания процесса выполнения.
-
-        Args:
-            runnable: Объект для выполнения
-            *args: Дополнительные позиционные аргументы
-            **kwargs: Дополнительные именованные аргументы
-        """
-        super()._prepare_runnable_before_enqueue(runnable, *args, **kwargs)
-
-        logger.info(f'{LOGS_DELIMITER * 2}enqueue {runnable.__class__.__name__}..')
-
-
-class WebEduGlobalHelperRunner(GlobalHelperRunner, metaclass=ABCMeta):
-    """Базовый класс исполнителей с глобальным помощником.
-
-    Расширяет функциональность WebEduRunner, добавляя поддержку
-    глобального помощника. Это позволяет:
-    - Использовать общие вспомогательные методы между разными исполнителями
-    - Кэшировать часто используемые данные
-    - Оптимизировать использование ресурсов
-
-    Note:
-        Глобальный помощник должен быть потокобезопасным, так как может
-        использоваться одновременно несколькими исполнителями.
-
-    Attributes:
-        helper (WebEduRunnerHelper): Глобальный помощник для всех исполнителей
-        validator (WebEduRunnerValidator): Валидатор входных данных
-        result (WebEduRunnerResult): Объект для хранения результатов
-    """
-
-    def _prepare_helper_class(self) -> type[WebEduRunnerHelper]:
-        """Возвращает класс глобального помощника.
-
-        Returns:
-            type[WebEduRunnerHelper]: Класс помощника, который будет использоваться
-            всеми исполнителями
-        """
-        return WebEduRunnerHelper
-
-    def _prepare_validator_class(self) -> type[WebEduRunnerValidator]:
-        """Возвращает класс валидатора исполнителя.
-
-        Returns:
-            type[WebEduRunnerValidator]: Класс для валидации входных параметров
-            и проверки состояния исполнителя
-        """
-        return WebEduRunnerValidator
-
-    def _prepare_result_class(self) -> type[WebEduRunnerResult]:
-        """Возвращает класс результата исполнителя.
-
-        Returns:
-            type[WebEduRunnerResult]: Класс для хранения результатов выполнения
-            функций и возможных ошибок
-        """
-        return WebEduRunnerResult

edu_rdm_integration/adapters/strategies.py

@@ -1,166 +0,0 @@
-"""Стратегии реализации функций для интеграции с продуктами Образования.
-
-Этот модуль содержит классы стратегий, определяющие способы реализации функций
-для работы с продуктами Образования. Стратегии определяют конфигурацию классов
-для различных компонентов системы: менеджеров, исполнителей, валидаторов и т.д.
-"""
-
-from abc import (
-    ABCMeta,
-)
-from typing import (
-    Optional,
-)
-
-from function_tools.strategies import (
-    FunctionImplementationStrategy,
-)
-
-from edu_rdm_integration.adapters.caches import (
-    WebEduFunctionCacheStorage,
-    WebEduRunnerCacheStorage,
-)
-from edu_rdm_integration.adapters.errors import (
-    WebEduError,
-)
-from edu_rdm_integration.adapters.functions import (
-    WebEduFunction,
-    WebEduLazySavingPredefinedQueueFunction,
-)
-from edu_rdm_integration.adapters.helpers import (
-    WebEduFunctionHelper,
-    WebEduRunnerHelper,
-)
-from edu_rdm_integration.adapters.managers import (
-    WebEduRunnerManager,
-)
-from edu_rdm_integration.adapters.presenters import (
-    WebEduResultPresenter,
-)
-from edu_rdm_integration.adapters.results import (
-    WebEduFunctionResult,
-    WebEduRunnerResult,
-)
-from edu_rdm_integration.adapters.runners import (
-    WebEduRunner,
-)
-from edu_rdm_integration.adapters.validators import (
-    WebEduFunctionValidator,
-    WebEduRunnerValidator,
-)
-
-
-class WebEduFunctionImplementationStrategy(FunctionImplementationStrategy, metaclass=ABCMeta):
-    """Базовая стратегия реализации функций для продуктов Образования.
-
-    Определяет основную конфигурацию классов для всех компонентов системы:
-    - Менеджеры для управления выполнением функций
-    - Исполнители (runners) для запуска функций
-    - Помощники (helpers) для вспомогательных операций
-    - Валидаторы для проверки данных
-    - Кэши для хранения промежуточных результатов
-    - Обработчики ошибок и результатов
-
-    Все методы в этом классе отвечают за установку конкретных реализаций
-    различных компонентов системы.
-    """
-
-    def _prepare_manager_class(self):
-        """Устанавливает класс менеджера для управления выполнением функций."""
-        self._manager_class = WebEduRunnerManager
-
-    def _prepare_runner_class(self):
-        """Устанавливает класс исполнителя для запуска функций."""
-        self._runner_class = WebEduRunner
-
-    def _prepare_function_class(self):
-        """Устанавливает базовый класс функции для обработки данных."""
-        self._function_class = WebEduFunction
-
-    def _prepare_runner_helper_class(self):
-        """Устанавливает класс помощника для исполнителя функций."""
-        self._runner_helper_class = WebEduRunnerHelper
-
-    def _prepare_function_helper_class(self):
-        """Устанавливает класс помощника для функций обработки данных."""
-        self._function_helper_class = WebEduFunctionHelper
-
-    def _prepare_runner_validator_class(self):
-        """Устанавливает класс валидатора для проверки параметров исполнителя."""
-        self._runner_validator_class = WebEduRunnerValidator
-
-    def _prepare_function_validator_class(self):
-        """Устанавливает класс валидатора для проверки данных функции."""
-        self._function_validator_class = WebEduFunctionValidator
-
-    def _prepare_runner_cache_storage_class(self):
-        """Устанавливает класс хранилища кэша для исполнителя."""
-        self._runner_cache_storage_class = WebEduRunnerCacheStorage
-
-    def _prepare_function_cache_storage_class(self):
-        """Устанавливает класс хранилища кэша для функции."""
-        self._function_cache_storage_class = WebEduFunctionCacheStorage
-
-    def _prepare_error_class(self):
-        """Устанавливает класс для обработки ошибок."""
-        self._error_class = WebEduError
-
-    def _prepare_runner_result_class(self):
-        """Устанавливает класс для хранения результатов работы исполнителя."""
-        self._runner_result_class = WebEduRunnerResult
-
-    def _prepare_function_result_class(self):
-        """Устанавливает класс для хранения результатов работы функции."""
-        self._function_result_class = WebEduFunctionResult
-
-    def _prepare_result_presenter_class(self):
-        """Устанавливает класс для представления результатов."""
-        self._result_presenter_class = WebEduResultPresenter
-
-
-class WebEduSyncBaseRunnerLazySavingPredefinedQueueFunctionImplementationStrategy(
-    WebEduFunctionImplementationStrategy, metaclass=ABCMeta
-):
-    """Стратегия создания функции с отложенным сохранением и предустановленной очередью.
-
-    Расширяет базовую стратегию, добавляя специфическую логику для:
-    - Отложенного сохранения данных (lazy saving)
-    - Работы с предустановленной очередью объектов
-    - Синхронного выполнения операций
-
-    Сохранение данных производится только после успешного выполнения всех операций
-    функции, что обеспечивает целостность данных и атомарность операций.
-    """
-
-    def _prepare_key(self) -> str:
-        """Возвращает уникальный идентификатор стратегии.
-
-        Returns:
-            str: Ключ для идентификации стратегии в системе
-        """
-        return 'WEB_EDU_SYNC_LAZY_SAVING_FUNCTION'
-
-    def _prepare_title(self) -> str:
-        """Возвращает название стратегии.
-
-        Returns:
-            str: Человекочитаемое описание стратегии
-        """
-        return (
-            'Стратегия создания функции с отложенным сохранением и предустановленной очередью объектов на сохранение '
-            'продуктов Образования. Сохранение производится после удачной работы функции'
-        )
-
-    @classmethod
-    def _prepare_function_template_name(cls) -> Optional[str]:
-        """Формирование названия шаблона создания функции.
-
-        Returns:
-            Optional[str]: Имя шаблона для создания функции или None,
-            если шаблон не требуется
-        """
-        return 'function_sync_template'
-
-    def _prepare_function_class(self):
-        """Устанавливает класс функции с поддержкой отложенного сохранения."""
-        self._function_class = WebEduLazySavingPredefinedQueueFunction

edu_rdm_integration/adapters/strings.py

@@ -1 +0,0 @@
-# В этом модуле должны располагаться все сообщения пользователю, сообщения для формирования логов

edu_rdm_integration/adapters/tests.py

@@ -1 +0,0 @@
-# Реализуйте свои unit-тесты здесь

edu_rdm_integration/adapters/validators.py

@@ -1,58 +0,0 @@
-"""Классы для валидации данных в системе интеграции.
-
-Этот модуль содержит базовые классы валидаторов, которые обеспечивают
-проверку корректности данных на разных уровнях системы:
-- Валидация входных параметров функций
-- Проверка состояния исполнителей
-- Валидация результатов обработки
-- Проверка бизнес-правил
-"""
-
-from abc import (
-    ABCMeta,
-)
-
-from function_tools.validators import (
-    BaseValidator,
-)
-
-
-class WebEduRunnerValidator(BaseValidator, metaclass=ABCMeta):
-    """Базовый класс для валидации исполнителей функций.
-
-    Предоставляет механизмы проверки:
-    - Корректности конфигурации исполнителя
-    - Доступности необходимых ресурсов
-    - Состояния исполнителя перед запуском
-    - Валидности результатов выполнения
-
-    Note:
-        Конкретные реализации должны определить специфичные
-        правила валидации для каждого типа исполнителя.
-
-    Attributes:
-        errors (list): Список обнаруженных ошибок
-        warnings (list): Список предупреждений
-    """
-
-
-class WebEduFunctionValidator(BaseValidator, metaclass=ABCMeta):
-    """Базовый класс для валидации функций обработки данных.
-
-    Предоставляет механизмы проверки:
-    - Входных параметров функции
-    - Формата данных
-    - Бизнес-правил
-    - Результатов обработки
-
-    Note:
-        При реализации валидаторов для конкретных функций следует:
-        - Определить специфичные правила проверки
-        - Добавить проверку бизнес-ограничений
-        - Реализовать валидацию форматов данных
-
-    Attributes:
-        errors (list): Список обнаруженных ошибок
-        warnings (list): Список предупреждений
-        context (dict): Контекст валидации
-    """