ErisPulse ErisPulse
Открыть интерактивную версию →
Разделы страницы
Статическое зеркало — интерактивная версия является основной Открыть интерактивную версию →

Руководство для разработчиков

Tip

Когда читать этот документ: когда вы готовитесь разрабатывать расширения для ErisPulse — добавлять боту новые функции (модули) или подключать новые платформы (адаптеры). Если вы просто хотите пользоваться ботом, пропустите этот документ и переходите сразу к Быстрому старту.

Здесь вы найдёте свой путь разработки: разработка модулей позволяет расширять функциональность бота с помощью команд и обработчиков сообщений; разработка адаптеров позволяет подключить бота к новым платформам обмена сообщениями. Оба пути охватывают полный процесс — от создания проекта до тестирования и публикации.

Содержание

Разработка модулей

  1. Введение в разработку модулей - Создание первого модуля
  2. Основные концепции модулей - Ключевые концепции и архитектура модулей
  3. Подробное описание класса-обёртки Event - Полное описание объекта Event
  4. Лучшие практики разработки модулей - Рекомендации по разработке качественных модулей
  5. Слой моделей данных (ORM) - Продвинутая разработка модулей: декларативные модели, автоматическое создание таблиц и CRUD-операции

Разработка адаптеров

  1. Введение в разработку адаптеров - Создание первого адаптера
  2. Основные концепции адаптеров - Ключевые концепции адаптеров (включая два варианта написания start() и базовые классы режимов подключения PollingAdapter / WebhookAdapter)
  3. Подробное описание SendDSL - Полное описание DSL для отправки сообщений Send
  4. Конвертеры событий - Реализация конвертеров событий
  5. Лучшие практики разработки адаптеров - Рекомендации по разработке качественных адаптеров

Тестирование и отладка

  1. Тестирование модулей (ErisPulse-Testing) - TestBot, фабрика событий и интерфейс утверждений

Общие стандарты

  1. Конфигурация и метаданные UI - Декларативная конфигурация: widget / условное отображение / формат значений / контракт совместимости (общий для адаптеров и модулей)

Руководство по публикации

Подготовка к разработке

Прежде чем приступить к разработке, убедитесь, что вы:

  1. Прочитали Основные понятия
  2. Ознакомились с Обработкой событий
  3. Установили среду разработки (Python >= 3.10)
  4. Установили ErisPulse SDK

Выбор типа разработки

Выберите подходящий тип разработки в зависимости от ваших потребностей:

Тип разработки Сценарии использования Руководство по началу работы
Разработка модуля Расширение функциональности бота, реализация бизнес-логики, предоставление команд и обработки сообщений Введение в разработку модулей
Разработка адаптера Подключение к новой платформе сообщений, реализация межплатформенной связи, предоставление функций, специфичных для платформы Введение в разработку адаптеров

Если вы хотите расширить функциональность бота (например, добавить команды или обрабатывать сообщения), выберите разработку модуля. Если вам нужно подключить бота к новой платформе, выберите разработку адаптера.

Инструменты разработки

Шаблоны проектов

ErisPulse предоставляет примеры проектов в качестве справочного материала:

Режим разработки

Для разработки используйте режим горячей перезагрузки, при котором изменения в коде автоматически перезагружаются:

epsdk run main.py --reload

Техники отладки

В файле config/config.toml включите уровни логирования DEBUG или TRACE:

[ErisPulse.logger]
# DEBUG: Вывод информации о загрузке модулей, регистрации маршрутов и других отладочных данных
# TRACE: Самый низкий уровень, вывод подробных внутренних процессов фреймворка, таких как распределение событий, запись в хранилище и ленивая загрузка
level = "DEBUG"

Публикация вашего модуля

Полный процесс публикации описан в Руководстве по публикации и магазину модулей, включая шаги публикации в PyPI и процесс отправки в магазин модулей ErisPulse.

Связанные документы