Главная
» Как сделать
»
Создайте эхо-бота на основе матрицы на Python с помощью библиотеки Simple-Matrix-Bot-Lib.
Создайте эхо-бота на основе матрицы на Python с помощью библиотеки Simple-Matrix-Bot-Lib.
По состоянию на 10 октября 2026 года, в PyPI указана версия Simple-Matrix-Bot-Lib 2.13.1, выпущенная 29 марта 2026 года. Для работы пакета требуется Python 3.9 или более поздняя версия, но поддержка Python 3.9 прекращена; используйте поддерживаемую версию Python, которую поддерживает данный пакет. В документации проекта по-прежнему указана версия 2.11.0 и указано, что она больше не поддерживается, поэтому данное руководство следует текущему примеру PyPI для API бота и использует более старое руководство только для четко обозначенных примечаний по конфигурации. Проверьте версию пакета и метаданные на PyPI . Ознакомьтесь со статусом документации проекта .
Наиболее быстрая и надежная конфигурация включает выделенного пользователя Matrix, виртуальную среду Python и небольшого эхо-бота, который отвечает !echoв тестовой комнате. Пример приведен для незашифрованной комнаты; для зашифрованных комнат требуется дополнительная настройка.
Что вам понадобится перед установкой библиотеки?
Создайте или запросите обычную учетную запись на домашнем сервере, которая будет запускать бота. Присвойте ей уникальное имя пользователя, например echo_bot, ; ей не требуются права администратора домашнего сервера. Регистрация может быть отключена или ограничена этим сервером, поэтому следуйте его политике создания учетных записей. Приглашайте учетную запись только в закрытую тестовую комнату, где ей разрешено отправлять сообщения.
Используйте Python 3.11 или другую поддерживаемую в настоящее время ветку Python. Хотя метаданные пакета по-прежнему допускают Python 3.9, Python.org указывает на окончание поддержки этой ветки 31 октября 2025 года, поэтому минимальная версия пакета не является хорошей рекомендацией для развертывания. Уведомление Python.org о поддержке Python 3.9 .
Как установить Simple-Matrix-Bot-Lib?
Выполните эти команды из новой папки проекта. Виртуальная среда позволяет отделить пакеты этого бота от других проектов Python. Указание версии позволяет воспроизвести пример на последней проверенной для этой статьи версии; при обновлении проверьте текущую версию PyPI и ее примечания по совместимости.
В Windows PowerShell активируйте среду с помощью команды .venv\Scripts\Activate.ps1вместо sourceкоманды. Затем создайте файл с именем bot.py. На странице проекта PyPI описаны имя пакета и команда установки, а в опубликованном примере используются Creds, Bot, обработчик сообщений и MessageMatch. См. текущий пример использования PyPI .
В терминале отображается изолированная среда и закрепленные команды установки пакетов для проекта бота.
Как подключить аккаунт бота и добавить команду?
Сохраните следующий код как bot.py. Он запрашивает пароль бота при запуске, поэтому пароль не записывается в исходный файл. Для развертывания сервиса в автоматическом режиме считывайте секрет из менеджера секретов вашей операционной системы или защищенной переменной среды вместо того, чтобы жестко прописывать его. Рассматривайте любое хранилище сессий или токенов доступа, созданное библиотекой, как учетные данные: храните его в закрытом доступе и вне системы контроля версий.
import getpass
import simplematrixbotlib as botlib
creds = botlib.Creds(
homeserver="https://matrix.example.org",
username="echo_bot",
password=getpass.getpass("Bot password: "),
)
bot = botlib.Bot(creds)
PREFIX = "!"
@bot.listener.on_message_event
async def echo(room, message):
match = botlib.MessageMatch(room, message, bot, PREFIX)
if (match.is_not_from_this_bot()
and match.prefix()
and match.command("echo")):
text = " ".join(match.args())
reply = text or "Usage: !echo <text>"
await bot.api.send_text_message(room.room_id, reply)
bot.run()
Замените пример URL домашнего сервера на базовый URL вашего сервера и используйте имя пользователя и пароль учетной записи бота. Слушатель получает сообщения из комнаты; MessageMatchон гарантирует, что игнорирует собственные сообщения и обрабатывает только !echoкоманду. Вызов API отправляет оставшиеся слова обратно в ту же комнату. Эти имена и вызовы методов соответствуют опубликованному в PyPI примеру библиотеки. Сравните с быстрым стартом Simple-Matrix-Bot-Lib .
Блок учетных данных использует выделенную учетную запись и запрашивает ее пароль вместо того, чтобы помещать секретный ключ в файл.Обработчик игнорирует собственные сообщения бота, сопоставляет их с командой !echo и отправляет свои аргументы обратно в комнату.
Как запустить бота и убедиться, что он работает?
В активированной виртуальной среде выполните следующую команду:
python bot.py
Введите пароль от учетной записи бота, когда появится соответствующий запрос. В тестовой комнате отправьте !echo hello. Работающий базовый бот ответит hello. Если он молчит, подтвердите, что учетная запись бота присоединилась к этой комнате, у пользователя есть разрешение на отправку сообщений, URL-адрес домашнего сервера указан правильно, и сообщение начинается с точного !префикса. Продолжайте процесс; закрытие терминала останавливает это простое развертывание в фоновом режиме.
В примере диалога в комнате показаны ожидаемые запрос и ответ на команду echo; это иллюстрация, а не результат реального тестирования.
В примере не обрабатываются сообщения из комнат, зашифрованные сквозным шифрованием. Библиотека заявляет о поддержке сквозного шифрования, но её текущее руководство помечено как версия 2.11.0 и может быть устаревшим; в этом руководстве описаны дополнительные matrix-nio[e2e]зависимости и Config.encryption_enabledнастройка. Перед включением шифрования подтвердите точные шаги установки и проверки для устанавливаемой вами версии. В более старой документации также описана настройка join_on_invite; приглашайте бота только в те комнаты, к которым он должен иметь доступ, и отметьте эту настройку, если ваша система должна контролировать автоматическое присоединение к комнатам. Ознакомьтесь с руководством по сквозному шифрованию и настройке библиотеки .
Настройка завершена, когда бот остается авторизованным, является участником тестовой комнаты и отвечает !echo helloс помощью команды hello`.`. Для использования в производственной среде запустите его под управлением менеджера процессов и защитите его пароль и данные сессии.