简体中文 English 繁體中文 日本語 Русский
本文为静态镜像，内容以交互版为准 在交互式文档中心打开 →

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

Это руководство поможет вам разрабатывать пользовательские модули и адаптеры, расширяя возможности ErisPulse.

Содержание

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

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

Модели данных

  1. Слой моделей данных (ORM) - Декларативные модели, автоматическое создание таблиц и CRUD-операции

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

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

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

  1. Тестирование модулей (ErisPulse-Testing) - TestBot, фабрика событий и интерфейс утверждений
  2. Руководство по отладке модулей - Методы определения причин, по которым модуль не загружается, события не обрабатываются или команды не запускаются

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

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

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

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

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

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

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

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

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

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

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

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

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

epsdk run main.py --reload

Советы по отладке

Включите отладочное или трассировочное логирование в config/config.toml:

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

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

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

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