edu-function-tools 0.1.0__tar.gz

edu_function_tools-0.1.0/CHANGELOG.md

@@ -0,0 +1,39 @@
+# История изменений
+
+Все изменения проекта должны быть отражены в этом файле.
+
+Формат основан на [Keep a Changelog](http://keepachangelog.com/)
+и проект следует [Семантическому версионированию](http://semver.org/).
+
+## [x.y.z] - гггг-мм-дд
+
+Здесь должно быть расширенное описание того, что было сделано, какие есть планы у команды по дальнейшему развитию.
+Желательно будущие цели привязывать к конкретным задачам. Т.е. на каждую цель нужно поставить отдельную задачу и
+отразить ее номер здесь.
+
+### Добавлено
+
+- [ПРОЕКТ-ZZZZ](https://jira.bars.group/browse/ПРОЕКТ-ZZZZ)
+  PATCH Название задачи или изменения.
+
+- [ПРОЕКТ-YYYY](https://jira.bars.group/browse/ПРОЕКТ-YYYY)
+  MINOR Название задачи или изменения.
+
+- [ПРОЕКТ-XXXX](https://jira.bars.group/browse/ПРОЕКТ-XXXX)
+  MAJOR Название задачи или изменения.
+
+### Изменено
+
+### Исправлено
+
+### Удалено
+
+
+## [0.1.0] - 2025-07-03
+
+Выполнен перенос адаптированных компонентов function-tools из edu-rdm-integration.
+
+### Добавлено
+
+- [EDUDEVOPS-91](https://jira.bars.group/browse/EDUDEVOPS-91)
+  MINOR Перенос адаптированных компонентов function-tools для проектов "Образования" из edu-rdm-integration.

edu_function_tools-0.1.0/LICENSE

@@ -0,0 +1,30 @@
+Copyright © 2022 ЗАО “БАРС Груп”
+
+Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем
+именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное
+право на использование, копирование, изменение, добавление, публикацию, распространение, сублицензирование и/или продажу копий
+Программного Обеспечения, также как и лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих
+условий:
+
+Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного
+Программного Обеспечения.
+
+ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ,
+НО НЕ ОГРАНИЧИВАЯСЬ ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ ПРАВ.
+НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО ИСКАМ О ВОЗМЕЩЕНИИ УЩЕРБА, УБЫТКОВ ИЛИ ДРУГИХ ТРЕБОВАНИЙ
+ПО ДЕЙСТВУЮЩИМ КОНТРАКТАМ, ДЕЛИКТАМ ИЛИ ИНОМУ, ВОЗНИКШИМ ИЗ, ИМЕЮЩИМ ПРИЧИНОЙ ИЛИ СВЯЗАННЫМ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ
+ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫМИ ДЕЙСТВИЯМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.
+
+Copyright © 2022 BARS Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
+(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

edu_function_tools-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+graft src
+
+global-exclude *.pyc
+global-exclude __pycache__
+
+include LICENSE
+include CHANGELOG.md
+include README.md

edu_function_tools-0.1.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: edu-function-tools
+Version: 0.1.0
+Summary: Компоненты для адаптации библиотеки function-tools
+Author-email: BARS Group <education_dev@bars.group>
+Project-URL: Homepage, https://stash.bars-open.ru/projects/EDUBASE/repos/edu-function-tools/browse
+Project-URL: Repository, https://stash.bars-open.ru/scm/edubase/edu-function-tools.git
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Django :: 2.2
+Classifier: Framework :: Django :: 3.0
+Classifier: Framework :: Django :: 3.1
+Classifier: Framework :: Django :: 3.2
+Classifier: Intended Audience :: Developers
+Classifier: Environment :: Web Environment
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: transliterate<2
+Requires-Dist: Django<3.3,>=3.1
+Requires-Dist: celery<5.3,>=4.4.7
+Requires-Dist: asyncpg==0.23.0
+Requires-Dist: educommon<4,>=3.11.0
+Requires-Dist: function-tools<1,>=0.9.0
+Requires-Dist: m3-db-utils<1,>=0.3.10
+Requires-Dist: m3-django-compat<2,>=1.10.2
+Requires-Dist: uploader-client<1,>=0.2.3
+Provides-Extra: dev
+Requires-Dist: isort==5.12.0; extra == "dev"
+Requires-Dist: ruff==0.6.9; extra == "dev"
+Requires-Dist: flake8<7,>=4.0.1; extra == "dev"
+Requires-Dist: pytest<8,>=3.2.5; extra == "dev"
+Requires-Dist: pytest-cov<5; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx<7.5,>=7; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints<2.5,>=2; extra == "docs"
+Requires-Dist: myst-parser<3.2,>=3; extra == "docs"
+Requires-Dist: sphinx_design<0.7,>=0.6; extra == "docs"
+Dynamic: license-file
+
+# Компоненты адаптации пакета function-tools для продуктов "Образования".
+
+Пакет содержит адаптированные компоненты function-tools для продуктов Образования.
+
+## Требования к окружению
+
+Для работы требуется Python >=3.9. Версии всех применяемых пакетов уточнены в pyproject.toml.

edu_function_tools-0.1.0/README.md

@@ -0,0 +1,7 @@
+# Компоненты адаптации пакета function-tools для продуктов "Образования".
+
+Пакет содержит адаптированные компоненты function-tools для продуктов Образования.
+
+## Требования к окружению
+
+Для работы требуется Python >=3.9. Версии всех применяемых пакетов уточнены в pyproject.toml.

edu_function_tools-0.1.0/pyproject.toml

@@ -0,0 +1,133 @@
+[build-system]
+requires = [
+    'packaging>=24,<25',
+    'wheel>=0.45,<0.46',
+    'setuptools>=77,<78',
+    'setuptools-git-versioning>=2,<3',
+]
+
+build-backend = 'setuptools.build_meta'
+
+[project]
+name = 'edu-function-tools'
+description = 'Компоненты для адаптации библиотеки function-tools'
+license-files = ['LICENSE']
+authors = [
+  {name = 'BARS Group', email = 'education_dev@bars.group'},
+]
+readme = 'README.md'
+requires-python = '>=3.9'
+dependencies = [
+    'transliterate<2',
+    'Django>=3.1,<3.3',
+    'celery>=4.4.7,<5.3',
+    'asyncpg==0.23.0',
+    'educommon>=3.11.0,<4',
+    'function-tools>=0.9.0,<1',
+    'm3-db-utils>=0.3.10,<1',
+    'm3-django-compat>=1.10.2,<2',
+    'uploader-client>=0.2.3,<1',
+]
+classifiers=[
+    'Development Status :: 5 - Production/Stable',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Framework :: Django :: 2.2',
+    'Framework :: Django :: 3.0',
+    'Framework :: Django :: 3.1',
+    'Framework :: Django :: 3.2',
+    'Intended Audience :: Developers',
+    'Environment :: Web Environment',
+]
+dynamic = ['version']
+
+[project.urls]
+Homepage = 'https://stash.bars-open.ru/projects/EDUBASE/repos/edu-function-tools/browse'
+Repository = 'https://stash.bars-open.ru/scm/edubase/edu-function-tools.git'
+
+[project.optional-dependencies]
+dev = [
+    'isort==5.12.0',
+    'ruff==0.6.9',
+    'flake8>=4.0.1,<7',
+    'pytest>=3.2.5,<8',
+    'pytest-cov<5',
+]
+docs = [
+    'sphinx>=7,<7.5',
+    'sphinx-autodoc-typehints>=2,<2.5',
+    'myst-parser>=3,<3.2',
+    'sphinx_design>=0.6,<0.7',
+]
+
+[tool.setuptools.packages.find]
+where = ['src']
+
+[tool.setuptools.package-data]
+edu_rdm_integration = ['*.py-tpl', '*.js']
+
+[tool.setuptools.exclude-package-data]
+edu_function_tools = ['tests', 'tests.*']
+
+[tool.setuptools-git-versioning]
+enabled = true
+
+[tool.ruff]
+line-length = 120
+indent-width = 4
+
+target-version = 'py312'
+
+[tool.ruff.format]
+quote-style = 'single'
+indent-style = 'space'
+docstring-code-format = true
+
+[tool.flake8]
+max-line-length = 120
+ignore = [
+    # Missing docstring in public module
+    'D100',
+    # Missing docstring in public package
+    'D104',
+    # Missing docstring in public nested class
+    'D106',
+    # Missing docstring in __init__
+    'D107',
+    # One-line docstring should fit on one line with quotes
+    'D200',
+    # Line break before binary operator
+    'W503',
+    # use of assert detected (useless with pytest)
+    'S101',
+]
+per-file-ignores = [
+  # variable '...' in class scope should not be mixedCase
+  # В SOAP моделях могут использоваться имена с различным написанием
+  'wsmodel.py:N815',
+  # function name '...' should be lowercase
+  # SOAP методы могут именоваться разными способами
+  'wsapi.py:N802,N815',
+]
+exclude = [
+  'venv',
+]
+max-complexity = 10
+
+[tool.pylint]
+score = 'no'
+msg-template = '{path}:{line} {msg} ({symbol})'
+disable = 'all'
+enable = [
+    'import-error',
+    'no-name-in-module',
+    'undefined-variable',
+    'undefined-all-variable',
+]
+
+extension-pkg-whitelist = [
+    'lxml',
+]

edu_function_tools-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

edu_function_tools-0.1.0/src/edu_function_tools/__init__.py

@@ -0,0 +1 @@
+default_app_config = 'edu_function_tools.apps.EduFunctionToolsConfig'

edu_function_tools-0.1.0/src/edu_function_tools/apps.py

@@ -0,0 +1,26 @@
+from django.apps import (
+    AppConfig,
+)
+
+
+class EduFunctionToolsConfig(AppConfig):
+    """Конфигурация приложения для интеграции с function_tools.
+    
+    Определяет основные параметры Django-приложения, которое
+    обеспечивает работу с библиотекой function_tools в контексте
+    продуктов Образования.
+    
+    Attributes:
+        name (str): Полное имя приложения в системе Django
+        verbose_name (str): Человекочитаемое название приложения
+        label (str): Уникальная метка приложения для Django
+        
+    Note:
+        Приложение автоматически регистрируется в Django при старте
+        и обеспечивает всю необходимую инфраструктуру для работы
+        с function_tools.
+    """
+
+    name = 'edu_function_tools.function_tools'
+    verbose_name = 'Приложение для работы с function_tools'
+    label = 'web_edu_function_tools'

edu_function_tools-0.1.0/src/edu_function_tools/caches.py

@@ -0,0 +1,56 @@
+from abc import (
+    ABCMeta,
+)
+
+from function_tools.caches import (
+    CacheStorage,
+    EntityCache,
+    PatchedGlobalCacheStorage,
+    PeriodicalEntityCache,
+)
+
+
+class EduEntityCache(EntityCache, metaclass=ABCMeta):
+    """Базовый класс кэша для сущностей продуктов Образования.
+    
+    Предоставляет механизм кэширования отдельных сущностей системы.
+    Используется для:
+    - Хранения часто запрашиваемых объектов
+    - Снижения нагрузки на базу данных
+    - Ускорения доступа к данным
+    
+    Note:
+        Конкретные реализации должны определить специфику кэширования
+        для каждого типа сущности.
+    """
+
+
+class EduPeriodicalEntityCache(PeriodicalEntityCache, metaclass=ABCMeta):
+    """Базовый класс периодического кеша продуктов Образования.
+
+    Кеш создается для определенной модели с указанием двух дат, на которые
+    должны быть собраны кеши актуальных объектов модели.
+    """
+
+
+class EduRunnerCacheStorage(CacheStorage, metaclass=ABCMeta):
+    """Базовый класс кешей помощников ранеров функций продуктов Образования."""
+
+
+class EduFunctionCacheStorage(CacheStorage, metaclass=ABCMeta):
+    """Базовый класс кешей функций продуктов Образования."""
+
+
+class EduFunctionPatchedGlobalCacheStorage(PatchedGlobalCacheStorage, metaclass=ABCMeta):
+    """Базовый класс глобального хранилища кэша с поддержкой патчинга.
+    
+    Расширяет стандартное хранилище кэша, добавляя возможность
+    модификации данных через механизм патчинга. Это позволяет:
+    - Обновлять кэшированные данные без полной перезагрузки
+    - Синхронизировать кэш между разными компонентами
+    - Эффективно управлять общими данными
+    
+    Note:
+        Патчинг должен использоваться с осторожностью, чтобы избежать
+        несогласованности данных между разными частями системы.
+    """

edu_function_tools-0.1.0/src/edu_function_tools/consts.py

@@ -0,0 +1 @@
+# Модуль должен содержать константы

edu_function_tools-0.1.0/src/edu_function_tools/enums.py

@@ -0,0 +1 @@
+# Модуль предназначен для размещения перечислений

edu_function_tools-0.1.0/src/edu_function_tools/errors.py

@@ -0,0 +1,24 @@
+from abc import (
+    ABCMeta,
+)
+
+from function_tools.errors import (
+    BaseError,
+)
+
+
+class EduError(BaseError, metaclass=ABCMeta):
+    """Базовый класс для ошибок в системе интеграции с продуктами Образования.
+    
+    Предоставляет основную функциональность для обработки ошибок:
+    - Форматирование сообщений об ошибках
+    - Сохранение контекста возникновения ошибки
+    - Классификация типов ошибок
+    - Механизм обработки вложенных ошибок
+        
+    Note:
+        При создании конкретных типов ошибок рекомендуется:
+        - Определять специфичные коды ошибок
+        - Предоставлять информативные сообщения
+        - Включать контекстную информацию в details
+    """

edu_function_tools-0.1.0/src/edu_function_tools/functions.py

@@ -0,0 +1,99 @@
+"""Базовые классы функций для интеграции с продуктами Образования.
+
+Этот модуль содержит базовые классы функций, которые используются для создания
+конкретных реализаций функций обработки данных в системе. Модуль предоставляет
+различные варианты базовых классов с разными стратегиями сохранения данных
+и управления очередями объектов.
+"""
+
+from abc import (
+    ABCMeta,
+)
+
+from function_tools.functions import (
+    BaseFunction,
+    LazySavingPredefinedQueueFunction,
+    LazySavingPredefinedQueueGlobalHelperFunction,
+)
+
+from edu_function_tools.helpers import (
+    EduFunctionHelper,
+)
+from edu_function_tools.results import (
+    EduFunctionResult,
+)
+from edu_function_tools.validators import (
+    EduFunctionValidator,
+)
+
+
+class EduFunction(BaseFunction, metaclass=ABCMeta):
+    """Базовый класс для создания функций продуктов Образования.
+    
+    Предоставляет основной интерфейс для создания функций обработки данных.
+    Наследуется от BaseFunction и добавляет специфичную для продуктов
+    Образования функциональность.
+    
+    Note:
+        Этот класс является абстрактным и должен быть расширен конкретными
+        реализациями функций.
+    """
+
+
+class EduLazySavingPredefinedQueueFunction(LazySavingPredefinedQueueFunction, metaclass=ABCMeta):
+    """Базовый класс для создания функций с отложенным сохранением.
+    
+    Реализует паттерн отложенного сохранения (lazy saving) с предустановленной
+    очередью объектов. Это позволяет:
+    - Накапливать объекты для сохранения в течение выполнения функции
+    - Сохранять все объекты атомарно после успешного выполнения всех операций
+    - Откатывать все изменения в случае ошибки
+    - Оптимизировать производительность за счет пакетного сохранения
+    
+    Attributes:
+        helper (EduFunctionHelper): Помощник функции для вспомогательных операций
+        validator (EduFunctionValidator): Валидатор для проверки данных
+        result (EduFunctionResult): Объект для хранения результатов работы
+    """
+
+    def _prepare_helper_class(self) -> type[EduFunctionHelper]:
+        """Возвращает класс помощника функции.
+        
+        Returns:
+            type[EduFunctionHelper]: Класс помощника для работы с данными
+        """
+        return EduFunctionHelper
+
+    def _prepare_validator_class(self) -> type[EduFunctionValidator]:
+        """Возвращает класс валидатора функции.
+        
+        Returns:
+            type[EduFunctionValidator]: Класс для валидации входных данных
+        """
+        return EduFunctionValidator
+
+    def _prepare_result_class(self) -> type[EduFunctionResult]:
+        """Возвращает класс результата функции.
+        
+        Returns:
+            type[EduFunctionResult]: Класс для хранения результатов выполнения
+        """
+        return EduFunctionResult
+
+
+class EduLazySavingPredefinedQueueGlobalHelperFunction(
+    LazySavingPredefinedQueueGlobalHelperFunction,
+    metaclass=ABCMeta,
+):
+    """Базовый класс для создания функций с глобальным помощником.
+    
+    Расширяет функциональность EduLazySavingPredefinedQueueFunction,
+    добавляя поддержку глобального помощника. Это позволяет:
+    - Использовать общие вспомогательные методы между разными функциями
+    - Кэшировать часто используемые данные на уровне всего приложения
+    - Оптимизировать использование ресурсов при массовой обработке данных
+    
+    Note:
+        Глобальный помощник должен быть потокобезопасным, так как может
+        использоваться одновременно несколькими функциями.
+    """

edu_function_tools-0.1.0/src/edu_function_tools/helpers.py

@@ -0,0 +1,63 @@
+from abc import (
+    ABCMeta,
+)
+
+from function_tools.helpers import (
+    BaseFunctionHelper,
+    BaseRunnerHelper,
+)
+
+from edu_function_tools.caches import (
+    EduFunctionCacheStorage,
+    EduRunnerCacheStorage,
+)
+
+
+class EduRunnerHelper(BaseRunnerHelper, metaclass=ABCMeta):
+    """Базовый класс помощников для исполнителей функций.
+    
+    Предоставляет вспомогательную функциональность для исполнителей,
+    включая:
+    - Кэширование данных исполнителя
+    - Общие утилиты для работы с функциями
+    - Доступ к разделяемым ресурсам
+    
+    Attributes:
+        cache (EduRunnerCacheStorage): Хранилище кэша для исполнителя
+    """
+
+    def _prepare_cache_class(self) -> type[EduRunnerCacheStorage]:
+        """Возвращает класс хранилища кэша для исполнителя.
+        
+        Returns:
+            type[EduRunnerCacheStorage]: Класс для кэширования данных
+            исполнителя
+        """
+        return EduRunnerCacheStorage
+
+
+class EduFunctionHelper(BaseFunctionHelper, metaclass=ABCMeta):
+    """Базовый класс помощников для функций обработки данных.
+    
+    Предоставляет вспомогательную функциональность для функций,
+    включая:
+    - Кэширование данных функции
+    - Общие утилиты для обработки данных
+    - Доступ к разделяемым ресурсам
+    
+    Note:
+        Каждая конкретная функция может расширить этот класс,
+        добавив специфичные для неё вспомогательные методы.
+    
+    Attributes:
+        cache (EduFunctionCacheStorage): Хранилище кэша для функции
+    """
+
+    def _prepare_cache_class(self) -> type[EduFunctionCacheStorage]:
+        """Возвращает класс хранилища кэша для функции.
+        
+        Returns:
+            type[EduFunctionCacheStorage]: Класс для кэширования данных
+            функции
+        """
+        return EduFunctionCacheStorage

edu_function_tools-0.1.0/src/edu_function_tools/managers.py

@@ -0,0 +1,61 @@
+from abc import (
+    ABCMeta,
+)
+
+from function_tools.managers import (
+    RunnerManager,
+)
+
+from edu_function_tools.runners import (
+    EduRunner,
+)
+
+
+class EduRunnerManager(RunnerManager, metaclass=ABCMeta):
+    """Базовый класс менеджеров исполнителей функций продуктов Образования.
+
+    Предоставляет базовую функциональность для управления исполнителями
+    (runners) функций в контексте образовательных продуктов. Наследует
+    возможности RunnerManager и адаптирует их для специфики образовательной
+    системы.
+
+    Основные возможности:
+    - Создание и инициализация исполнителей функций
+    - Управление жизненным циклом исполнителей
+    - Конфигурация исполнителей для образовательных задач
+    - Интеграция с системой образовательных продуктов
+
+    Note:
+        - Является абстрактным классом
+        - Требует реализации в конкретных менеджерах
+        - Использует EduRunner как базовый класс исполнителей
+        - Интегрируется с другими компонентами системы образования
+        - Обеспечивает единообразное управление исполнителями
+
+    See Also:
+        - RunnerManager: базовый класс для управления исполнителями
+        - EduRunner: базовый класс исполнителей
+        - EduRunnerCacheStorage: хранилище кеша для исполнителей
+    """
+
+    @classmethod
+    def _prepare_runner_class(cls) -> type[EduRunner]:
+        """Возвращает класс исполнителя для образовательных функций.
+
+        Определяет EduRunner как базовый класс для всех исполнителей
+        в системе образовательных продуктов. Этот метод вызывается при
+        создании новых исполнителей.
+
+        Returns:
+            type[EduRunner]: Класс исполнителя EduRunner
+
+        Note:
+            - Метод является частью инициализации исполнителей
+            - Переопределяет метод базового класса RunnerManager
+            - Гарантирует использование правильного типа исполнителя
+            - Может быть переопределен в наследниках для специфических исполнителей
+
+        See Also:
+            - EduRunner: базовый класс исполнителей
+        """
+        return EduRunner

edu_function_tools-0.1.0/src/edu_function_tools/presenters.py

@@ -0,0 +1,37 @@
+from abc import (
+    ABCMeta,
+)
+
+from function_tools.presenters import (
+    ResultPresenter,
+)
+
+
+class EduResultPresenter(ResultPresenter, metaclass=ABCMeta):
+    """Базовый класс презентеров результатов работы функций продуктов Образования.
+
+    Предоставляет базовую функциональность для форматирования и представления
+    результатов выполнения функций в контексте образовательных продуктов.
+    Наследует возможности ResultPresenter и адаптирует их для специфики
+    образовательной системы.
+
+    Основные возможности:
+    - Форматирование результатов выполнения функций
+    - Адаптация данных для различных потребителей
+    - Поддержка различных форматов вывода
+    - Интеграция с системой отчетности
+
+    Note:
+        - Является абстрактным классом
+        - Требует реализации в конкретных презентерах
+        - Поддерживает различные форматы представления данных
+        - Учитывает специфику образовательных данных
+        - Интегрируется с другими компонентами системы
+        - Обеспечивает единообразное представление результатов
+
+
+    See Also:
+        - ResultPresenter: базовый класс для презентеров результатов
+        - EduRunner: исполнитель функций образовательных продуктов
+        - EduRunnerManager: менеджер исполнителей функций
+    """

edu_function_tools-0.1.0/src/edu_function_tools/receivers.py

@@ -0,0 +1,35 @@
+from sys import (
+    stdout,
+)
+
+
+def m3_edu_function_tools_after_migrate_receiver(sender, **kwargs):
+    """Обработчик сигнала, выполняющийся после применения миграций.
+    
+    Автоматически регистрирует сущности в системе после успешного
+    выполнения миграций базы данных. Это обеспечивает:
+    - Синхронизацию моделей с системой регистрации
+    - Корректную инициализацию новых сущностей
+    - Обновление существующих регистраций
+    
+    Args:
+        sender: Отправитель сигнала (обычно приложение Django)
+        **kwargs: Дополнительные параметры сигнала
+        
+    Note:
+        В случае возникновения ошибок при регистрации, они будут
+        перехвачены и залогированы, но не будут прерывать процесс
+        миграции.
+    """
+    from function_tools.management.commands.register_entities import (
+        EntityRegistrar,
+    )
+
+    try:
+        registrar = EntityRegistrar(logger=stdout)
+        registrar.run()
+    except Exception as e:
+        stdout.write(
+            f'Register function_tools_entities exception. ----- START IGNORING EXCEPTION\n{e}\n----- '
+            f'FINISH IGNORING EXCEPTION\n'
+        )

edu_function_tools-0.1.0/src/edu_function_tools/results.py

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

edu_function_tools-0.1.0/src/edu_function_tools/runners.py

@@ -0,0 +1,140 @@
+"""Исполнители (runners) для функций интеграции с продуктами Образования.
+
+Этот модуль содержит классы исполнителей, которые отвечают за запуск и управление
+выполнением функций обработки данных. Исполнители обеспечивают:
+- Подготовку и валидацию входных данных
+- Управление жизненным циклом функций
+- Логирование процесса выполнения
+- Обработку результатов и ошибок
+"""
+
+from abc import (
+    ABCMeta,
+)
+
+from educommon import (
+    logger,
+)
+from function_tools.runners import (
+    BaseRunner,
+    GlobalHelperRunner,
+)
+
+from edu_function_tools.helpers import (
+    EduRunnerHelper,
+)
+from edu_function_tools.results import (
+    EduRunnerResult,
+)
+from edu_function_tools.validators import (
+    EduRunnerValidator,
+)
+from edu_rdm_integration.core.consts import (
+    LOGS_DELIMITER,
+)
+
+
+class EduRunner(BaseRunner, metaclass=ABCMeta):
+    """Базовый класс исполнителей функций продуктов Образования.
+    
+    Предоставляет основную функциональность для запуска и управления
+    выполнением функций обработки данных. Включает:
+    - Подготовку и валидацию входных параметров
+    - Логирование процесса выполнения
+    - Обработку результатов и ошибок
+    - Управление очередью выполнения
+    
+    Attributes:
+        helper (EduRunnerHelper): Помощник для вспомогательных операций
+        validator (EduRunnerValidator): Валидатор входных данных
+        result (EduRunnerResult): Объект для хранения результатов
+    """
+
+    def _prepare_helper_class(self) -> type[EduRunnerHelper]:
+        """Возвращает класс помощника исполнителя.
+        
+        Returns:
+            type[EduRunnerHelper]: Класс помощника для вспомогательных операций
+            при выполнении функций
+        """
+        return EduRunnerHelper
+
+    def _prepare_validator_class(self) -> type[EduRunnerValidator]:
+        """Возвращает класс валидатора исполнителя.
+        
+        Returns:
+            type[EduRunnerValidator]: Класс для валидации входных параметров
+            и проверки состояния исполнителя
+        """
+        return EduRunnerValidator
+
+    def _prepare_result_class(self) -> type[EduRunnerResult]:
+        """Возвращает класс результата исполнителя.
+        
+        Returns:
+            type[EduRunnerResult]: Класс для хранения результатов выполнения
+            функций и возможных ошибок
+        """
+        return EduRunnerResult
+
+    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 EduGlobalHelperRunner(GlobalHelperRunner, metaclass=ABCMeta):
+    """Базовый класс исполнителей с глобальным помощником.
+    
+    Расширяет функциональность EduRunner, добавляя поддержку
+    глобального помощника. Это позволяет:
+    - Использовать общие вспомогательные методы между разными исполнителями
+    - Кэшировать часто используемые данные
+    - Оптимизировать использование ресурсов
+    
+    Note:
+        Глобальный помощник должен быть потокобезопасным, так как может
+        использоваться одновременно несколькими исполнителями.
+    
+    Attributes:
+        helper (EduRunnerHelper): Глобальный помощник для всех исполнителей
+        validator (EduRunnerValidator): Валидатор входных данных
+        result (EduRunnerResult): Объект для хранения результатов
+    """
+
+    def _prepare_helper_class(self) -> type[EduRunnerHelper]:
+        """Возвращает класс глобального помощника.
+        
+        Returns:
+            type[EduRunnerHelper]: Класс помощника, который будет использоваться
+            всеми исполнителями
+        """
+        return EduRunnerHelper
+
+    def _prepare_validator_class(self) -> type[EduRunnerValidator]:
+        """Возвращает класс валидатора исполнителя.
+        
+        Returns:
+            type[EduRunnerValidator]: Класс для валидации входных параметров
+            и проверки состояния исполнителя
+        """
+        return EduRunnerValidator
+
+    def _prepare_result_class(self) -> type[EduRunnerResult]:
+        """Возвращает класс результата исполнителя.
+        
+        Returns:
+            type[EduRunnerResult]: Класс для хранения результатов выполнения
+            функций и возможных ошибок
+        """
+        return EduRunnerResult

edu_function_tools-0.1.0/src/edu_function_tools/strategies.py

@@ -0,0 +1,166 @@
+"""Стратегии реализации функций для интеграции с продуктами Образования.
+
+Этот модуль содержит классы стратегий, определяющие способы реализации функций
+для работы с продуктами Образования. Стратегии определяют конфигурацию классов
+для различных компонентов системы: менеджеров, исполнителей, валидаторов и т.д.
+"""
+
+from abc import (
+    ABCMeta,
+)
+from typing import (
+    Optional,
+)
+
+from function_tools.strategies import (
+    FunctionImplementationStrategy,
+)
+
+from edu_function_tools.caches import (
+    EduFunctionCacheStorage,
+    EduRunnerCacheStorage,
+)
+from edu_function_tools.errors import (
+    EduError,
+)
+from edu_function_tools.functions import (
+    EduFunction,
+    EduLazySavingPredefinedQueueFunction,
+)
+from edu_function_tools.helpers import (
+    EduFunctionHelper,
+    EduRunnerHelper,
+)
+from edu_function_tools.managers import (
+    EduRunnerManager,
+)
+from edu_function_tools.presenters import (
+    EduResultPresenter,
+)
+from edu_function_tools.results import (
+    EduFunctionResult,
+    EduRunnerResult,
+)
+from edu_function_tools.runners import (
+    EduRunner,
+)
+from edu_function_tools.validators import (
+    EduFunctionValidator,
+    EduRunnerValidator,
+)
+
+
+class EduFunctionImplementationStrategy(FunctionImplementationStrategy, metaclass=ABCMeta):
+    """Базовая стратегия реализации функций для продуктов Образования.
+    
+    Определяет основную конфигурацию классов для всех компонентов системы:
+    - Менеджеры для управления выполнением функций
+    - Исполнители (runners) для запуска функций
+    - Помощники (helpers) для вспомогательных операций
+    - Валидаторы для проверки данных
+    - Кэши для хранения промежуточных результатов
+    - Обработчики ошибок и результатов
+    
+    Все методы в этом классе отвечают за установку конкретных реализаций
+    различных компонентов системы.
+    """
+
+    def _prepare_manager_class(self):
+        """Устанавливает класс менеджера для управления выполнением функций."""
+        self._manager_class = EduRunnerManager
+
+    def _prepare_runner_class(self):
+        """Устанавливает класс исполнителя для запуска функций."""
+        self._runner_class = EduRunner
+
+    def _prepare_function_class(self):
+        """Устанавливает базовый класс функции для обработки данных."""
+        self._function_class = EduFunction
+
+    def _prepare_runner_helper_class(self):
+        """Устанавливает класс помощника для исполнителя функций."""
+        self._runner_helper_class = EduRunnerHelper
+
+    def _prepare_function_helper_class(self):
+        """Устанавливает класс помощника для функций обработки данных."""
+        self._function_helper_class = EduFunctionHelper
+
+    def _prepare_runner_validator_class(self):
+        """Устанавливает класс валидатора для проверки параметров исполнителя."""
+        self._runner_validator_class = EduRunnerValidator
+
+    def _prepare_function_validator_class(self):
+        """Устанавливает класс валидатора для проверки данных функции."""
+        self._function_validator_class = EduFunctionValidator
+
+    def _prepare_runner_cache_storage_class(self):
+        """Устанавливает класс хранилища кэша для исполнителя."""
+        self._runner_cache_storage_class = EduRunnerCacheStorage
+
+    def _prepare_function_cache_storage_class(self):
+        """Устанавливает класс хранилища кэша для функции."""
+        self._function_cache_storage_class = EduFunctionCacheStorage
+
+    def _prepare_error_class(self):
+        """Устанавливает класс для обработки ошибок."""
+        self._error_class = EduError
+
+    def _prepare_runner_result_class(self):
+        """Устанавливает класс для хранения результатов работы исполнителя."""
+        self._runner_result_class = EduRunnerResult
+
+    def _prepare_function_result_class(self):
+        """Устанавливает класс для хранения результатов работы функции."""
+        self._function_result_class = EduFunctionResult
+
+    def _prepare_result_presenter_class(self):
+        """Устанавливает класс для представления результатов."""
+        self._result_presenter_class = EduResultPresenter
+
+
+class EduSyncBaseRunnerLazySavingPredefinedQueueFunctionImplementationStrategy(
+    EduFunctionImplementationStrategy, 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 = EduLazySavingPredefinedQueueFunction

edu_function_tools-0.1.0/src/edu_function_tools/strings.py

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

edu_function_tools-0.1.0/src/edu_function_tools/tests.py

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

edu_function_tools-0.1.0/src/edu_function_tools/validators.py

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

edu_function_tools-0.1.0/src/edu_function_tools.egg-info/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: edu-function-tools
+Version: 0.1.0
+Summary: Компоненты для адаптации библиотеки function-tools
+Author-email: BARS Group <education_dev@bars.group>
+Project-URL: Homepage, https://stash.bars-open.ru/projects/EDUBASE/repos/edu-function-tools/browse
+Project-URL: Repository, https://stash.bars-open.ru/scm/edubase/edu-function-tools.git
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Django :: 2.2
+Classifier: Framework :: Django :: 3.0
+Classifier: Framework :: Django :: 3.1
+Classifier: Framework :: Django :: 3.2
+Classifier: Intended Audience :: Developers
+Classifier: Environment :: Web Environment
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: transliterate<2
+Requires-Dist: Django<3.3,>=3.1
+Requires-Dist: celery<5.3,>=4.4.7
+Requires-Dist: asyncpg==0.23.0
+Requires-Dist: educommon<4,>=3.11.0
+Requires-Dist: function-tools<1,>=0.9.0
+Requires-Dist: m3-db-utils<1,>=0.3.10
+Requires-Dist: m3-django-compat<2,>=1.10.2
+Requires-Dist: uploader-client<1,>=0.2.3
+Provides-Extra: dev
+Requires-Dist: isort==5.12.0; extra == "dev"
+Requires-Dist: ruff==0.6.9; extra == "dev"
+Requires-Dist: flake8<7,>=4.0.1; extra == "dev"
+Requires-Dist: pytest<8,>=3.2.5; extra == "dev"
+Requires-Dist: pytest-cov<5; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx<7.5,>=7; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints<2.5,>=2; extra == "docs"
+Requires-Dist: myst-parser<3.2,>=3; extra == "docs"
+Requires-Dist: sphinx_design<0.7,>=0.6; extra == "docs"
+Dynamic: license-file
+
+# Компоненты адаптации пакета function-tools для продуктов "Образования".
+
+Пакет содержит адаптированные компоненты function-tools для продуктов Образования.
+
+## Требования к окружению
+
+Для работы требуется Python >=3.9. Версии всех применяемых пакетов уточнены в pyproject.toml.

edu_function_tools-0.1.0/src/edu_function_tools.egg-info/SOURCES.txt

@@ -0,0 +1,27 @@
+CHANGELOG.md
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+src/edu_function_tools/__init__.py
+src/edu_function_tools/apps.py
+src/edu_function_tools/caches.py
+src/edu_function_tools/consts.py
+src/edu_function_tools/enums.py
+src/edu_function_tools/errors.py
+src/edu_function_tools/functions.py
+src/edu_function_tools/helpers.py
+src/edu_function_tools/managers.py
+src/edu_function_tools/presenters.py
+src/edu_function_tools/receivers.py
+src/edu_function_tools/results.py
+src/edu_function_tools/runners.py
+src/edu_function_tools/strategies.py
+src/edu_function_tools/strings.py
+src/edu_function_tools/tests.py
+src/edu_function_tools/validators.py
+src/edu_function_tools.egg-info/PKG-INFO
+src/edu_function_tools.egg-info/SOURCES.txt
+src/edu_function_tools.egg-info/dependency_links.txt
+src/edu_function_tools.egg-info/requires.txt
+src/edu_function_tools.egg-info/top_level.txt

edu_function_tools-0.1.0/src/edu_function_tools.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

edu_function_tools-0.1.0/src/edu_function_tools.egg-info/requires.txt

@@ -0,0 +1,22 @@
+transliterate<2
+Django<3.3,>=3.1
+celery<5.3,>=4.4.7
+asyncpg==0.23.0
+educommon<4,>=3.11.0
+function-tools<1,>=0.9.0
+m3-db-utils<1,>=0.3.10
+m3-django-compat<2,>=1.10.2
+uploader-client<1,>=0.2.3
+
+[dev]
+isort==5.12.0
+ruff==0.6.9
+flake8<7,>=4.0.1
+pytest<8,>=3.2.5
+pytest-cov<5
+
+[docs]
+sphinx<7.5,>=7
+sphinx-autodoc-typehints<2.5,>=2
+myst-parser<3.2,>=3
+sphinx_design<0.7,>=0.6

edu_function_tools-0.1.0/src/edu_function_tools.egg-info/top_level.txt

@@ -0,0 +1 @@
+edu_function_tools