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

Документация по функциональным возможностям платформы Terminal

TerminalAdapter — это адаптер командной строки, где терминал представляет собой чат-сессию, предназначенную для быстрой локальной отладки модулей логики.


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

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

Базовая информация

  • Краткое описание платформы: интерфейс командной строки на локальной машине работает как чат-сессия, ввод stdin — это сообщения, ответы модулей напечатаны непосредственно в терминал
  • Название адаптера: TerminalAdapter
  • Идентификатор платформы: terminal
  • Дизайн на одну учетную запись (сценарий локальной отладки)
  • Требования к фреймворку: мягкая зависимость ErisPulse>=2.7.1 (проверка в режиме выполнения с подсказкой, не обязательна)

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

[Terminal]
bot_id = "terminal_bot"    # ID пользователя бота
bot_name = "TerminalBot"   # Псевдоним бота
user_id = "terminal_user"  # ID эмулируемого пользователя (пользователь терминала, с которым общается бот)
user_name = "User"         # Псевдоним эмулируемого пользователя
prompt = "> "              # Приглашение для ввода
reply_prefix = "[Bot] "    # Префикс строки ответа бота (оставьте пустым, чтобы не добавлять префикс)
echo_input = false         # Отображать ли ввод пользователя (включите для сценариев с вводом через конвейер)

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

  • Принадлежность задачи spawn_background: цикл чтения stdin теперь использует runtime.spawn_background
  • Мягкая зависимость от фреймворка: проверка наличия ErisPulse>=2.7.1 с выводом предупреждения при отсутствии; при запуске выводится лог версии

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

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

Дополнение message_id для событий сообщений

Верхнеуровневое стандартное поле message_id для событий сообщений stdin (создание uuid), модуль может стабильно ссылаться на сообщения терминала для ответа/удаления дубликатов.

Send наследует BaseAdapter.Send

Send наследует BaseAdapter.Send из фреймворка, стандартная цепочка декораторов (At / AtAll / Reply и т.д.) применяется, декорированные сегменты и текстовые сегменты отображаются вместе; сегмент node (объединённая пересылка) понижается до вывода в виде обычного текста (содержимое не теряется).

Дополнение стандартных мета-действий

Стандартные мета-действия уже дополнены, возвращается стандартный ответ:

Действие Содержимое data
get_status enabled (статус работы) / boot_time (временная метка запуска)
get_version impl (TerminalAdapter) / version / onebot_version
get_supported_actions Список поддерживаемых названий действий
from ErisPulse import sdk
terminal = sdk.adapter.get("terminal")

result = await terminal.Api.get_status()
result = await terminal.Api.get_version()
result = await terminal.Api.get_supported_actions()
result = await terminal.Api.get_self_info()    # user_id/user_name
result = await terminal.Api.get_user_info("terminal_user")
result = await terminal.Api.get_friend_list()

Исправление семантики понижения возможности delete_message

Терминал не поддерживает удаление: delete_message из "возврат успешного результата" исправлен на стандартную семантику понижения возможности — возвращается retcode=10002 (не поддерживаемое действие), модуль может использовать это для определения понижения.

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

retcode Смысл Описание
0 Успешно —
10002 Не поддерживается Операции в группе, удаление сообщений, не реализованные стандартные действия

Инструкция по использованию

# Модуль по-прежнему слушает сообщения
from ErisPulse.Core.Event import message

@message.on_message()
async def handle(event):
    if event.get("platform") == "terminal":
        await event.reply("Получено: " + event.get_text())
  • Текст, введённый в терминале, является пользовательским сообщением, поддерживается многострочный ввод (заканчивается пустой строкой)
  • Пример структуры события (сообщение stdin):
{
  "id": "<uuid>",
  "time": 1700000000,
  "message_id": "<uuid>",
  "type": "message",
  "detail_type": "private",
  "platform": "terminal",
  "self": {"platform": "terminal", "user_id": "terminal_bot", "user_name": "TerminalBot"},
  "user_id": "terminal_user",
  "message": [{"type": "text", "data": {"text": "Введённый текст"}}],
  "alt_message": "Введённый текст",
  "terminal_raw": {"text": "Введённый текст"},
  "terminal_raw_type": "stdin_line"
}
  • Пример отправки (можно использовать цепочку декораторов):
terminal = sdk.adapter.get("terminal")

await terminal.Send.To("private", "terminal_user").Text("Hello")
await terminal.Send.To("private", "terminal_user").At("terminal_user").Text("Сообщение с декораторами")
await terminal.Send.To("private", "terminal_user").Raw_ob12([
    {"type": "text", "data": {"text": "ОдинБот12 сегмент"}}
])
  • Подходит для быстрой проверки логики модуля на этапе разработки, не требует подключения к реальной платформе