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

Документация по функциям платформы Sandbox

SandboxAdapter — это встроенный адаптер песочницы ErisPulse, предназначенный для локальной разработки и отладки модулей — позволяет симулировать отправку и получение сообщений без реальной платформы.


Информация о документации

  • Соответствующая версия модуля: 4.2.3
  • Ответственный: ErisPulse
  • Последнее обновление: 2026-11-10

Основная информация

  • Краткое описание платформы: Локальная среда песочницы, предоставляющая виртуальных пользователей/группы, веб-панель отладки и сохранение сообщений
  • Название адаптера: SandboxAdapter
  • Идентификатор платформы: sandbox
  • Дизайн с одной учетной записью (сценарий локальной отладки)
  • Требования к фреймворку: Опциональная зависимость ErisPulse>=2.7.1 (предупреждение при проверке в режиме выполнения, не обязательна)

Обновление парадигмы v5 (4.1.0)

  • Минимальный набор Api DSL: get_self_info / get_status / get_version / get_supported_actions
  • Принадлежность задачи spawn_background: задача с心跳 теперь использует runtime.spawn_background
  • Разрешённая зависимость: проверка на наличие ErisPulse>=2.7.1 и соответствующее уведомление
  • Обновление путей импорта до Core.Bases (BaseConfig)

Стандартизация выравнивания (4.2.3)

Структура ответа и коды ошибок соответствуют спецификации ответов API.

Методы отправки HTML

  • .Html(html: str) — отправка HTML-сообщения (отображается через канал HTML на веб-панели)
  • .HTML(html: str) — псевдоним .Html() (для согласования с названием стандартного метода Send)

Стандартизованные метадействия

Стандартизированные метадействия возвращают стандартный ответ:

Действие Содержимое data
get_self_info user_id (настроенный self_id) / user_name (sandbox)
get_status good (статус работы) / bots (список аккаунтов)
get_version impl (ErisPulse-SandboxAdapter) / version / onebot_version
get_supported_actions Список поддерживаемых действий
from ErisPulse import sdk
sandbox = sdk.adapter.get("sandbox")

result = await sandbox.Api.get_self_info()   # информация о боте-песочнице
result = await sandbox.Api.get_status()
result = await sandbox.Api.get_version()
result = await sandbox.Api.get_supported_actions()

Обработка событий запросов (заглушка запросов)

Песочница синтезирует события типа type="request" (запросы на добавление в друзья/в группу, request_id передаётся из симулированного события), модули могут одобрять или отклонять их стандартным способом (полная спецификация доступна в спецификации операций запросов):

from ErisPulse.Core.Event import request

@request.on_friend_request()
async def handle_friend_request(event):
    await event.approve()   # или event.reject()

DSL-заглушка адаптера для запросов — это имитационная заглушка: accept() / reject() проверяют request_id (в случае отсутствия возвращается стандартный код ошибки retcode=34001, относящийся к семейству ошибок запросов), после успешной проверки симулируется успешное одобрение и возвращается стандартный ответ, что облегчает тестирование процессов approve() / reject().

Спецификация кодов ошибок

retcode Смысл Описание
0 Успешно —
10002 Не поддерживается Платформа не имеет соответствующей функции
10003 Ошибка параметра Отсутствуют или неверные параметры
10006 Недопустимые данные сообщения Узел MergeForward не содержит действительного текстового содержимого
34001 Запрос не существует Request.accept()/reject() не содержит request_id (ошибка в семействе запросов)

Инструкция по настройке

[Sandbox]
self_id = "sandbox_bot"  # ID бота-песочницы
enable = true            # Включить или нет

Использование

  • Сэндбокс предоставляет виртуальных пользователей и группу, модули могут отправлять и получать сообщения, как и на настоящей платформе
  • Веб-панель отладки позволяет вручную отправлять сообщения и запускать логику обработки модуля
  • Данные сообщений сохраняются в постоянном хранилище (sdk.storage), после перезапуска можно восстановить

Поддерживаемые типы отправки сообщений

Все методы отправки реализованы с использованием цепочки вызовов (chain syntax), например:

from ErisPulse import sdk
sandbox = sdk.adapter.get("sandbox")

await sandbox.Send.To("private", "user1").Text("Hello")
await sandbox.Send.To("group", "group1").Markdown("**Жирный**")

Поддерживаемые типы отправки включают:

Метод Описание
.Text(text) Отправка текстового сообщения
.Image(file, summary=None) Отправка изображения
.Face(face_id) Отправка эмодзи
.Record(file, magic=False) Отправка аудиозаписи
.Voice(file) Отправка аудиосообщения (канал audio)
.Video(file) Отправка видео
.File(file, filename=None) Отправка файла
.Html(html) / .HTML(html) Отправка HTML-сообщения (второй — псевдоним)
.Markdown(markdown) Отправка сообщения в формате Markdown
.Json(json_data) Отправка JSON-карточки
.Xml(xml_data) Отправка XML-карточки
.Music(platform, id, title=None) Отправка сообщения с музыкой
.Share(url, title, content=None, image=None) Отправка ссылки на ресурс
.Location(lat, lon, title=None, content=None) Отправка сообщения с геолокацией
.Dice() Отправка сообщения с кубиком
.Rps() Отправка сообщения с игрой "камень, ножницы, бумага"
.Poke(user_id, type="poke") Отправка сообщения "пощёчина"
.Recall(message_id) Имитация отмены отправки сообщения
.MergeForward(nodes, title="Собранный чат") Отправка объединённого сообщения (рендерится как HTML-карточка <details>, отправляется через канал html), используется для проверки логики объединения сообщений модулям
.Raw_ob12(message) Отправка необработанного сообщения OneBot12 (список node автоматически маршрутизируется в объединённое сообщение, смешанный список node-сегментов понижается до обычного текста)

Декораторы At / AtAll / Reply предоставляются базовым классом SendDSL фреймворка.