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

Справочник API

Tip

Когда читать этот документ: когда вы пишете модуль или адаптер и вам нужно посмотреть примеры использования какого-либо основного модуля (Storage/Config/Logger/Router и т.д.), системы событий или API управления адаптерами — перейдите к соответствующему разделу из списка документов ниже. Если это не нужно — пропустите.

Этот каталог содержит справочную документацию по API фреймворка ErisPulse.

Список документов

Документ Описание
API ядра модулей Быстрая справочная информация по API Storage, Config, Logger, Adapter, Module, Lifecycle, Router, HTTP Client
API системы событий Справочная информация по API модулей событий Command, Message, Notice, Request, Meta
API системы адаптеров Справочная информация по API менеджера адаптеров, SendDSL, промежуточного ПО, управления состоянием Bot
Автоматически генерируемый API Полная документация API, автоматически сгенерированная из docstring исходного кода

Ручная документация API ориентирована на примеры использования и быстрый доступ к информации; автоматически сгенерированная документация API содержит полные сигнатуры классов/методов, обе документации дополняют друг друга.

Модули

Основные модули

Модуль Путь доступа Описание
sdk.storage sdk.storage Хранилище пар «ключ-значение» на базе SQLite + SQL цепочечный запрос
sdk.config sdk.config Управление конфигурацией в формате TOML
sdk.logger sdk.logger Модульная система логирования, поддержка под-логгеров
sdk.adapter sdk.adapter Управление адаптерами для различных платформ
sdk.module sdk.module Управление регистрацией, загрузкой и выгрузкой модулей
sdk.lifecycle sdk.lifecycle Управление событиями жизненного цикла
sdk.router sdk.router Управление маршрутизацией HTTP/WebSocket
sdk.client sdk.client Единый HTTP/WS клиент

Система событий

Модуль Путь доступа Описание
command ErisPulse.Core.Event.command Обработка команд (разбор префиксов, псевдонимы)
message ErisPulse.Core.Event.message События сообщений (личные сообщения, чаты, сообщения с упоминанием)
notice ErisPulse.Core.Event.notice События уведомлений (изменения друзей, участников групп)
request ErisPulse.Core.Event.request События запросов (запросы на добавление в друзья, приглашения в группы)
meta ErisPulse.Core.Event.meta Мета-события (подключение, отключение, сердцебиение)

Базовые классы

Базовый класс Путь доступа Описание
BaseModule ErisPulse.Core.Bases.module.BaseModule Базовый класс модуля (on_load/on_unload)
BaseAdapter ErisPulse.Core.Bases.adapter.BaseAdapter Базовый класс адаптера (start/shutdown/call_api)

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

Первое знакомство с фреймворком:

Углубление в зависимости от роли:

Как использовать конкретную подсистему:

  • Продвинутые темы — подробная документация по маршрутизации, HTTP-клиенту, SQL-конструктору и другим компонентам