Руководство для начинающих
Tip
Когда стоит прочитать эту статью: ваш робот уже запущен с помощью Быстрого старта за 5 минут, и вы хотите системно понять ключевые концепции фреймворка и в полной мере освоить его часто используемые возможности. Если робот ещё не запущен — сначала пройдите быстрый старт; если же нужно просто найти ответ на конкретный вопрос — переходите сразу к соответствующей отдельной статье.
После запуска робота этот раздел поможет вам системно разобраться в ключевых концепциях фреймворка и его часто используемых возможностях.
Путь обучения
Ниже представлены пять основных статей уровня L1, определённых на главной странице документации — прочитав их по порядку (примерно за 1–2 часа), вы сможете самостоятельно разрабатывать 90% функциональности:
| Шаг | Тема | Описание |
|---|---|---|
| 1 | Введение в разработку модулей | Создание независимых пакетов модулей, понимание структуры модулей и механизма регистрации |
| 2 | Базовые концепции | Понимание основной архитектуры ErisPulse и принципов проектирования модулей |
| 3 | Класс-обёртка Event | Освоение ответов, запросов и доступа к полям объекта события |
| 4 | Описание файлов конфигурации | Умение заполнять конфигурацию, понимание горячей перезагрузки и переопределения через переменные окружения |
| 5 | Перехват исключений | Знакомство с иерархией исключений фреймворка и написание устойчивых цепочек обработки |
В этом каталоге также есть несколько сопутствующих документов для ознакомления по мере необходимости:
| Документ | Когда читать |
|---|---|
| Создание первого бота | Хотите сначала написать встроенный обработчик, а затем изучить модульную разработку |
| Введение в обработку событий | Нужен быстрый справочник по способам обработки в зависимости от типа события (сообщения / команды / уведомления / запросы) |
| Примеры типовых задач | Нужен готовый полный код для работы с хранилищем, запланированными задачами и контролем прав доступа |
| Руководство по автодополнению в IDE | Хотите получить автодополнение в IDE для платформо-специфичных методов |
Выбор способа разработки
ErisPulse поддерживает два способа разработки:
| Способ | Сценарий применения | Описание |
|---|---|---|
| Встраиваемая разработка | Быстрое прототипирование, внутренние функции проекта | Написание обработчиков непосредственно в main.py, без необходимости создания отдельного модуля |
| Модульная разработка (рекомендуется) | Продуктовая среда, распространение функций | Создание отдельного пакета Python, который можно установить и использовать с помощью epsdk install |
Подробное сравнение и примеры обоих способов см. в разделах Создание первого бота и Введение в модульную разработку.
Обзор архитектуры
ErisPulse использует архитектуру, основанную на событиях, и состоит из следующих основных систем:
- Система адаптеров — взаимодействует с различными платформами, преобразуя события платформ в единый стандарт OneBot12
- Система событий — обрабатывает пять основных типов событий: сообщения, команды, уведомления, запросы и метасобытия
- Система модулей — расширяет функциональность с помощью независимых модулей, поддерживает управление зависимостями и ленивую загрузку
- Основные модули — предоставляют базовые возможности, такие как Storage (хранилище), Config (конфигурация), Logger (логирование), Router (маршрутизация)
Подробную диаграмму архитектуры и процесс инициализации см. в разделе Обзор архитектуры.
Дальнейшие шаги
Достаточно читать по порядку в соответствии с указанным выше учебным путём (пять основных статей уровня L1). Также можно сразу перейти к нужному разделу в зависимости от вашей цели:
- Хотите сначала попрактиковаться: начните с Создания первого бота, напишите первый обработчик команды
/hello, а затем перейдите к Введению в разработку модулей - Хотите сначала понять принципы: прочитайте Базовые концепции, чтобы понять, как взаимодействуют адаптеры / модули / события
- Хотите решить конкретную задачу: обратитесь к Примерам типичных задач — там есть готовый к копированию полный код по хранилищу, запланированным задачам и контролю доступа
- После прочтения пяти статей уровня L1: при необходимости изучайте Продвинутые темы; для сложных модулей начните с четырёх обязательных к прочтению статей уровня L2