Руководство для разработчиков
Tip
Когда читать этот документ: когда вы готовитесь разрабатывать расширения для ErisPulse — добавлять боту новые функции (модули) или подключать новые платформы (адаптеры). Если вы просто хотите пользоваться ботом, пропустите этот документ и переходите сразу к Быстрому старту.
Здесь вы найдёте свой путь разработки: разработка модулей позволяет расширять функциональность бота с помощью команд и обработчиков сообщений; разработка адаптеров позволяет подключить бота к новым платформам обмена сообщениями. Оба пути охватывают полный процесс — от создания проекта до тестирования и публикации.
Содержание
Разработка модулей
- Введение в разработку модулей - Создание первого модуля
- Основные концепции модулей - Ключевые концепции и архитектура модулей
- Подробное описание класса-обёртки Event - Полное описание объекта Event
- Лучшие практики разработки модулей - Рекомендации по разработке качественных модулей
- Слой моделей данных (ORM) - Продвинутая разработка модулей: декларативные модели, автоматическое создание таблиц и CRUD-операции
Разработка адаптеров
- Введение в разработку адаптеров - Создание первого адаптера
- Основные концепции адаптеров - Ключевые концепции адаптеров (включая два варианта написания start() и базовые классы режимов подключения PollingAdapter / WebhookAdapter)
- Подробное описание SendDSL - Полное описание DSL для отправки сообщений Send
- Конвертеры событий - Реализация конвертеров событий
- Лучшие практики разработки адаптеров - Рекомендации по разработке качественных адаптеров
Тестирование и отладка
- Тестирование модулей (ErisPulse-Testing) - TestBot, фабрика событий и интерфейс утверждений
Общие стандарты
- Конфигурация и метаданные UI - Декларативная конфигурация: widget / условное отображение / формат значений / контракт совместимости (общий для адаптеров и модулей)
Руководство по публикации
- Руководство по публикации и магазину модулей - Публикация ваших работ в PyPI и магазине модулей ErisPulse
Подготовка к разработке
Прежде чем приступить к разработке, убедитесь, что вы:
- Прочитали Основные понятия
- Ознакомились с Обработкой событий
- Установили среду разработки (Python >= 3.10)
- Установили ErisPulse SDK
Выбор типа разработки
Выберите подходящий тип разработки в зависимости от ваших потребностей:
| Тип разработки | Сценарии использования | Руководство по началу работы |
|---|---|---|
| Разработка модуля | Расширение функциональности бота, реализация бизнес-логики, предоставление команд и обработки сообщений | Введение в разработку модулей |
| Разработка адаптера | Подключение к новой платформе сообщений, реализация межплатформенной связи, предоставление функций, специфичных для платформы | Введение в разработку адаптеров |
Если вы хотите расширить функциональность бота (например, добавить команды или обрабатывать сообщения), выберите разработку модуля. Если вам нужно подключить бота к новой платформе, выберите разработку адаптера.
Инструменты разработки
Шаблоны проектов
ErisPulse предоставляет примеры проектов в качестве справочного материала:
- Пример модуля - полная структура проекта модуля (команды / конфигурация / ORM / внедрение зависимостей)
- Пример веб-возможностей - маршрутизатор декораторов / промежуточные обработчики / WebSocket хуки / escape hatch router.app
- Продвинутый пример взаимодействия - транзакции сообщений и подтверждения / совместные уникальные и транзакции ORM / утверждение запросов / цепочка отправки
- Пример управления эксплуатацией - принадлежность потоковых задач / отложенные задачи / проверка памяти / переключатели конфиденциальности
- Пример адаптера - полная структура проекта адаптера (дополнительно доступны варианты опроса / вебхуков)
Режим разработки
Для разработки используйте режим горячей перезагрузки, при котором изменения в коде автоматически перезагружаются:
epsdk run main.py --reload
Техники отладки
В файле config/config.toml включите уровни логирования DEBUG или TRACE:
[ErisPulse.logger]
# DEBUG: Вывод информации о загрузке модулей, регистрации маршрутов и других отладочных данных
# TRACE: Самый низкий уровень, вывод подробных внутренних процессов фреймворка, таких как распределение событий, запись в хранилище и ленивая загрузка
level = "DEBUG"
Публикация вашего модуля
Полный процесс публикации описан в Руководстве по публикации и магазину модулей, включая шаги публикации в PyPI и процесс отправки в магазин модулей ErisPulse.
Связанные документы
- Стандарты - Технические стандарты для обеспечения совместимости
- Руководство по функциям платформы - Ознакомьтесь с особенностями адаптеров для различных платформ