Основные компоненты¶
LXMFBot¶
Основной класс бота, отвечающий за маршрутизацию сообщений, обработку команд и жизненный цикл бота.
from lxmfy import LXMFBot
bot = LXMFBot(
name="MyBot",
announce=600,
announce_immediately=True,
admins=set(),
hot_reloading=False,
rate_limit=5,
cooldown=60,
max_warnings=3,
warning_timeout=300,
command_prefix="/",
cogs_dir="cogs",
cogs_enabled=True,
permissions_enabled=False,
storage_type="json", # "json", "sqlite" или "memory"
storage_path="data",
first_message_enabled=True,
event_logging_enabled=True,
max_logged_events=1000,
event_middleware_enabled=True,
announce_enabled=True,
signature_verification_enabled=False,
require_message_signatures=False,
identity_pinning_enabled=False,
message_persistence_enabled=True,
dynamic_cogs_enabled=True,
external_cogs_enabled=True,
external_cogs_sandbox_enabled=True,
external_cogs_sandbox_type="auto", # "auto", "landlock", "bwrap", "firejail", "none"
external_cogs_timeout=30,
landlock_enabled=True,
nlp_enabled=False,
nlp_threshold=0.5,
link_support_enabled=False,
lxmf_commands_enabled=True,
message_queue_size=50,
reticulum_config_dir=None, # или LXMFY_RETICULUM_CONFIG_DIR / "~/.reticulum"
rrc_enabled=False,
rrc_hubs=[],
rrc_rooms=[],
rrc_nick=None,
rrc_dest_name="rrc.hub",
rrc_auto_reconnect=True,
rrc_persist_sessions=True,
)
Ключевые методы¶
get_landlock_status(): состояние доступности и активации песочницы Landlock LSM для процесса ботаrun(delay=10): запуск основного цикла ботаsend(destination, message, title="Reply", lxmf_fields=None, stamp_cost=None, opportunistic=None): отправить сообщение получателю, опционально с полями LXMF, переопределением стоимости штампа и opportunistic-отправкой (пробует прямую доставку, сразу откатывается на propagation, если настроено)send_with_attachment(destination, message, attachment, title="Reply", stamp_cost=None, opportunistic=None): отправить сообщение с вложениемreact(destination, message_hash, reaction): отправить реакцию на сообщение (поле LXMFFIELD_REACTION)command(name, description="No description provided", admin_only=False, threaded=False): декоратор регистрации команд.threaded=Trueзапускает обработчик команды в отдельном потоке. Команды поддерживают аннотации типов для автоматического преобразования аргументовintent(name, examples): декоратор регистрации обработчиков NLP-намеренийnlp.export_model(): экспорт обученной модели NLPnlp.import_model(model_data): импорт ранее экспортированной моделиrequest_link(destination_hash, callback=None, app_name="lxmf", *aspects): запрос RNS Link к получателю. Позволяет задать свойapp_nameиaspects(по умолчанию "lxmf" и "delivery")on_link(callback): регистрация обработчика входящих RNS Linkload_extension(name): загрузить модуль расширения кога по имени (например, "cogs.utility")reload_extension(name): перезагрузить модуль расширения когаadd_cog(cog_instance): добавить экземпляр класса кога в ботаremove_cog(cog_name): удалить ког из бота по имени классаon_first_message(): декоратор обработки первых сообщений от пользователейon_message(): декоратор обработки всех сообщений (вызывается до обработки команд)on_reaction(): декоратор обработки входящих реакций; обработчик получает(sender, reaction)с ключамиreaction_to,reaction_emoji,reaction_sendervalidate(): проверка конфигурации ботаconnect_rrc(hub_hash, rooms=None, nick=None, dest_name=None, auto_reconnect=None): подключение к RRC-хабу как клиентdisconnect_rrc(hub_hash=None): отключение одной или всех сессий RRC-хабовon_rrc(callback=None): декоратор или регистрация обработчика событий RRC (handler(event, client, payload))rrc: экземплярRRCManagerдля сессий с несколькими хабами
Структурированные команды через поля LXMF¶
Боты могут принимать команды, отправленные через FIELD_COMMANDS (0x09) LXMF, и автоматически отвечать с FIELD_RESULTS (0x0A). Это даёт структурированные запросы и ответы наряду с обычными текстовыми командами.
Входящие FIELD_COMMANDS разбираются и направляются через тот же реестр команд, что и текстовые, с общими проверками прав, разбором аргументов по аннотациям, потоками и middleware.
from lxmfy import LXMFBot, FIELD_COMMANDS, FIELD_RESULTS, pack_result, unpack_commands
bot = LXMFBot(name="FieldBot")
@bot.command(name="status", description="Return bot status")
def status_cmd(ctx):
# ctx.fields содержит исходный словарь полей LXMF
# ctx.request_id устанавливается автоматически, если команда его включала
ctx.reply("Bot is online")
# Отправка структурированной команды из другого клиента LXMF:
# lxm.fields[FIELD_COMMANDS] = {"command": "status", "args": [], "request_id": "abc123"}
# router.handle_outbound(lxm)
# Ответ бота автоматически включает FIELD_RESULTS с ответом и request_id.
Чтобы отключить обработку полевых команд, установите lxmf_commands_enabled=False в BotConfig.
Реакции¶
Реакции передаются полем FIELD_REACTION (0x40) LXMF поверх пустого сообщения. pack_reaction и unpack_reaction собирают и разбирают это поле.
from lxmfy import pack_reaction, unpack_reaction
# Отправка реакции на сообщение
bot.react(destination_hash, message_hash_hex, "\U0001F44D")
# Приём реакций
@bot.on_reaction()
def on_reaction(sender, reaction):
# reaction["reaction_to"] — hex-хэш целевого сообщения
# reaction["reaction_emoji"] — текст реакции (до 16 символов)
# reaction["reaction_sender"] — отправитель
print(f"{sender} reacted {reaction['reaction_emoji']} to {reaction['reaction_to']}")
return True
Текст реакции обрезается до 16 печатаемых символов. Исходное поле остаётся доступным в ctx.fields и msg.fields для совместимости.
Хранилище¶
Фреймворк предоставляет три бэкенда хранилища:
JSONStorage¶
SQLiteStorage¶
MemoryStorage¶
Команды¶
Регистрация и обработка команд:
@bot.command(name="hello", description="Says hello")
def hello(ctx):
ctx.reply(f"Hello {ctx.sender}!")
Аргументы с аннотациями типов¶
Команды автоматически разбирают и преобразуют аргументы на основе аннотаций типов в функции-обработчике.
@bot.command(name="add", description="Adds two numbers")
def add(ctx, a: int, b: int):
result = a + b
ctx.reply(f"The result is {result}")
Система помощи¶
Фреймворк включает интерактивный генератор помощи с категоризированными меню на основе метаданных когов и команд.
# Команда help регистрируется автоматически.
# Пользователи могут использовать '/help' или '/help <command>'
Потоковые команды¶
Для долгих или блокирующих операций, которые не взаимодействуют напрямую с Reticulum Network Stack, команды можно запускать в отдельном потоке, чтобы бот оставался отзывчивым.
import time
@bot.command(name="long_task", description="Performs a long-running task in a separate thread", threaded=True)
def long_task_command(ctx):
ctx.reply("Starting a long task... please wait.")
time.sleep(10) # Выполняется в отдельном потоке
ctx.reply("Long task completed!")
Потокобезопасность
Функции с threaded=True не должны напрямую взаимодействовать с
Reticulum Network Stack (RNS) или компонентами, зависящими от
lxmfy.transport.py, так как они в общем случае не потокобезопасны.
Используйте ctx.reply() для отправки сообщений пользователю из
потоковой команды.
События¶
Система событий для обработки различных событий бота:
@bot.events.on("message_received", EventPriority.HIGHEST)
def handle_message(event):
# Обработка события сообщения
pass
Тестирование¶
Тесты проекта включают сценарии надёжности и нагрузки в тестовом наборе репозитория. Используйте тест-раннер репозитория для их запуска.
Расширенный набор проверок надёжности¶
Фреймворк включает обширный набор автоматизированных тестов для суровых условий:
- Manifold Testing: проверка математической топологии векторного пространства намерений NLP.
- Chaos Engineering: симуляция битовой гнили, отказа SD-карты и порчи хранилища.
- Temporal Drift: проверка устойчивости к скачкам системных часов (±1 год).
- Leak Detection: долгосрочное отслеживание памяти, файловых дескрипторов и потоков.
Права доступа¶
Система прав для контроля доступа к возможностям бота:
from lxmfy import DefaultPerms
@bot.command(name="admin", description="Admin command", admin_only=True)
def admin_command(ctx):
if ctx.is_admin:
ctx.reply("Admin command executed")
Middleware¶
Система middleware для обработки сообщений и событий:
@bot.middleware.register(MiddlewareType.PRE_COMMAND)
def pre_command_middleware(ctx):
# Обработка до выполнения команды
pass
Вложения¶
Поддержка отправки файлов, изображений и аудио:
from lxmfy import Attachment, AttachmentType
attachment = Attachment(
type=AttachmentType.IMAGE,
name="image.jpg",
data=image_data,
format="jpg"
)
bot.send_with_attachment(destination, "Here's an image", attachment)
Внешний вид иконки (поле LXMF)¶
Боту можно назначить пользовательскую иконку, которую отображают совместимые клиенты LXMF. Используется LXMF.FIELD_ICON_APPEARANCE.
from lxmfy import IconAppearance, pack_icon_appearance_field
import LXMF # Требуется для LXMF.FIELD_ICON_APPEARANCE
# Определяем внешний вид иконки
icon_data = IconAppearance(
icon_name="smart_toy", # Имя из Material Symbols
fg_color=b'\xFF\xFF\xFF', # Белый передний план (3 байта)
bg_color=b'\x4A\x90\xE2' # Синий фон (3 байта)
)
# Упаковываем в формат поля LXMF
icon_lxmf_field = pack_icon_appearance_field(icon_data)
# Отправляем сообщение с этой иконкой
bot.send(
destination_hash_str,
"Hello from your friendly bot!",
title="Bot Message",
lxmf_fields=icon_lxmf_field
)
# Можно комбинировать с другими полями, например с вложениями:
# attachment_field = pack_attachment(some_attachment)
# combined_fields = {**icon_lxmf_field, **attachment_field}
# bot.send(destination, "Message with icon and attachment", lxmf_fields=combined_fields)
Планировщик¶
Система планирования задач:
@bot.scheduler.schedule(name="daily_task", cron_expr="0 0 * * *")
def daily_task():
# Выполняется ежедневно в полночь
pass
Подписи¶
LXMFy предоставляет настройки для встроенной криптографической подписи и проверки сообщений LXMF:
from lxmfy import LXMFBot
bot = LXMFBot(
name="SecureBot",
signature_verification_enabled=True, # Включить проверку подписей
require_message_signatures=False # True — отклонять неподписанные сообщения
)
Обработка подписей
LXMF автоматически выполняет все криптографические операции подписи и
проверки с идентификаторами RNS. SignatureManager в LXMFy - это
слой конфигурации, который:
- Управляет тем, применять ли проверку подписей
- Определяет политику для неподписанных сообщений (принимать или отклонять)
- Интегрируется с системой прав (например, обход проверки для доверенных пользователей)
Сами криптографические операции выполняет LXMF/RNS, а не LXMFy.
Песочница Landlock LSM¶
На ядрах Linux с поддержкой Landlock (5.13+) LXMFy может ограничивать доступ к файловой системе для процесса бота и для внешних скриптовых когов.
Песочница процесса бота
Когда landlock_enabled=True (по умолчанию) и бот не запущен в test_mode, бот вызывает apply_landlock_sandbox() при инициализации. Системные каталоги доступны только для чтения; хранилище бота, конфигурация, коги, конфигурация Reticulum и временные пути остаются записываемыми.
bot = LXMFBot(
name="SecureBot",
landlock_enabled=True,
)
status = bot.get_landlock_status()
# ключи status: landlock_kernel_supported, landlock_requested,
# landlock_auto_enabled, landlock_disabled_by_env, landlock_active
Переопределение через окружение
LXMFY_LANDLOCK=0: отключить Landlock даже на поддерживаемых ядрахLXMFY_LANDLOCK=1: попытаться применить Landlock в Linux независимо от автоопределения- не задано: следовать
landlock_enabledи автоопределению ядра
Песочница внешних когов
Скриптовые коги используют external_cogs_sandbox_type. В режиме auto предпочитается Landlock, так как ему не нужны внешние инструменты. Полный список вариантов песочницы — в руководстве Создание ботов.
Закрепление идентификатора¶
LXMFy поддерживает опциональное закрепление идентификатора (pinning) для защиты от подмены при ротации или компрометации идентификатора. Когда включено, бот «закрепляет» LXMF-адрес за первым увиденным открытым ключом.
Методы SignatureManager¶
SignatureManager доступен как bot.signature_manager, когда signature_verification_enabled=True:
should_verify_message(sender): определить, нужно ли проверять сообщение от данного отправителяhandle_unsigned_message(sender, message_hash): обработать сообщения без валидной подписи согласно политике
Как работают подписи LXMF¶
LXMF автоматически подписывает все исходящие сообщения идентификатором RNS отправителя во время операции pack(). При получении сообщений LXMF проверяет подписи и предоставляет:
message.signature_validated: булево значение валидности подписиmessage.unverified_reason: код причины при неудачной проверке (например,SIGNATURE_INVALID,SOURCE_UNKNOWN)
LXMFy использует эти встроенные свойства LXMF для применения политики подписей бота.
Доставка сообщений¶
LXMFy предоставляет расширенные возможности доставки, включая узлы распространения и автоматические повторы:
Узлы распространения¶
Отправка сообщений через конкретные узлы распространения для повышения надёжности в сети Reticulum:
# Настройте узел распространения один раз на уровне конфигурации/времени выполнения
bot.set_propagation_node("<propagation_node_hash>")
# Отправка с настроенным поведением доставки
bot.send(
destination_hash,
"Message content"
)
# Хэш узла распространения должен быть валидным узлом распространения LXMF
# в сети Reticulum
Автоматические повторы¶
Настройка автоматических повторных попыток для неудачных прямых доставок:
bot = LXMFBot(
name="ReliableBot",
direct_delivery_retries=5, # Повторять прямую доставку до 5 раз
propagation_fallback_enabled=True
)
bot.send(destination_hash, "Important message")
# direct_delivery_retries по умолчанию равно 3
# Логика повторов автоматически обрабатывает обратные вызовы доставки
Система повторов отслеживает попытки доставки по каждому получателю и автоматически повторяет неудачные доставки. Успешные доставки сбрасывают счётчик повторов для этого получателя.
Персистентность сообщений¶
Исходящие сообщения можно сохранять на диск, чтобы они доставлялись даже после перезапуска бота. Персистентность включена по умолчанию. Очередь исходящих в памяти ограничена (message_queue_size, по умолчанию 50) и при переполнении отбрасывает самое старое сообщение. Невалидные хэши получателей не восстанавливаются.
Обработчики сообщений¶
LXMFy предоставляет декораторы для обработки разных типов входящих сообщений:
Обработчик первого сообщения¶
Обработка первого сообщения от каждого пользователя:
@bot.on_first_message()
def welcome_user(sender, message):
content = message.content.decode("utf-8")
bot.send(sender, f"Welcome! You said: {content}")
return True # Верните True, чтобы остановить дальнейшую обработку
Общий обработчик сообщений¶
Обработка всех входящих сообщений до обработки команд:
@bot.on_message()
def handle_all_messages(sender, message):
content = message.content.decode("utf-8").strip()
# Своя логика здесь
if content.startswith("echo:"):
bot.send(sender, content[5:])
return True # Остановить дальнейшую обработку
return False # Перейти к обработке команд
Обработчики сообщений вызываются в таком порядке: 1. обработчик первого сообщения (если это первое сообщение от отправителя) 2. общие обработчики (зарегистрированные через on_message()) 3. обработка команд (если сообщение начинается с префикса команды)
Reticulum Relay Chat (RRC)¶
Боты могут подключаться к хабам RRC по RNS Link с конвертами CBOR. Пакет: lxmfy.rrc.
Опции BotConfig¶
rrc_enabled(bool, по умолчаниюFalse): подключать настроенные хабы при запускеrrc_hubs(список hex-хэшей): хэши получателей хабовrrc_rooms(список строк): комнаты для авто-join после WELCOMErrc_nick(строка или None): никнейм в HELLO и сообщениях комнатrrc_dest_name(строка, по умолчанию"rrc.hub"): имя получателя для построения destination хабаrrc_auto_reconnect(bool, по умолчаниюTrue): переподключение после потери linkrrc_persist_sessions(bool, по умолчаниюTrue): сохранять хабы и комнаты между перезапускамиreticulum_config_dir(строка или None): каталог конфигурации Reticulum. Также задаётся черезLXMFY_RETICULUM_CONFIG_DIR. Используйте ту же конфигурацию, что у MeshChatX (часто~/.reticulum), чтобы анонсы хаба были видны.
Пример¶
from lxmfy import LXMFBot, RRCMessage
bot = LXMFBot(
name="RoomBot",
reticulum_config_dir="~/.reticulum",
rrc_enabled=True,
rrc_hubs=["664fc0e8d2e448658e37bb3f34e6c88f"],
rrc_rooms=["general"],
rrc_nick="RoomBot",
)
@bot.on_rrc
def on_rrc(event, client, payload):
if event == "msg" and isinstance(payload, RRCMessage) and payload.mention:
client.send_message(payload.room, f"Hi {payload.nick}")
# API времени выполнения
# bot.connect_rrc(hub_hash, rooms=["general"])
# bot.rrc.send_message("general", "hello")
# bot.rrc.send_notice("general", "notice")
# bot.rrc.send_action("general", "waves")
# bot.rrc.join("ops")
# bot.rrc.part("ops")
# bot.rrc.status()
# bot.disconnect_rrc()
Экспортируемые типы¶
RRCClient: сессия с одним хабомRRCManager: менеджер нескольких хабов (bot.rrc)RRCMessage: данные события комнаты (kind,room,text,nick,src,mention, ...)RRC_VERSION: константа версии проводного протокола
Типичные события, передаваемые обработчикам @bot.on_rrc: status, welcome, joined, parted, msg, notice, action, motd, error и rtt.
Шаблоны¶
Фреймворк включает несколько готовых шаблонов ботов:
EchoBot¶
Простой echo-бот, повторяющий сообщения:
NoteBot¶
Бот для заметок с хранилищем JSON:
ReminderBot¶
Бот-напоминалка с хранилищем SQLite:
RRCBot¶
RRC-бот для комнат: подключается к настроенным хабам и отвечает на @упоминания. По умолчанию хаб 664fc0e8d2e448658e37bb3f34e6c88f, комната #general и ~/.reticulum, если доступен.
from lxmfy.templates import RRCBot
bot = RRCBot(
hubs=["664fc0e8d2e448658e37bb3f34e6c88f"],
rooms=["general"],
nick="RRCBot",
reticulum_config_dir="~/.reticulum",
)
bot.run()
Инструменты CLI¶
Фреймворк предоставляет инструменты командной строки для управления ботами:
# Создать нового бота
lxmfy create mybot
# Создать бота из шаблона
lxmfy create --template echo mybot
lxmfy create --template rrc my_rrc_bot
# Запустить шаблонного бота
lxmfy run echo
lxmfy run rrc
# Проверить проверку подписей сообщением
lxmfy signatures test
# Включить проверку подписей
lxmfy signatures enable
# Отключить проверку подписей
lxmfy signatures disable
Обработка ошибок¶
Перехватывайте завершение работы и ошибки выполнения вокруг bot.run():
try:
bot.run()
except KeyboardInterrupt:
bot.cleanup()
except Exception as e:
logger.error(f"Error running bot: {str(e)}")
Справочник модулей¶
Генерируется из строк документации исходного кода.
Bases: AnnounceMixin, DispatchMixin, CogMixin, InboundMixin, OutboundMixin, LinkMixin, RRCMixin, PropagationMixin
Main bot class for handling LXMF messages and commands.
This class manages the bot's lifecycle, including: - Message routing and delivery - Command registration and execution - Cog (extension) loading and management - Spam protection - Admin privileges
Source code in lxmfy/core.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 | |
__init__(name=None, **kwargs)
¶
Initialize a new LXMFBot instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str | None
|
Optional bot name, same as the name config key. |
None
|
**kwargs
|
Any
|
Override default configuration settings |
{}
|
Source code in lxmfy/core.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | |
cleanup()
¶
Clean up resources.
Source code in lxmfy/core.py
diagnose_connectivity(destination=None, *, request_path=False, wait=0.0)
¶
Run a connectivity doctor report for this bot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination
|
str | None
|
Optional peer hash to include in send diagnosis. |
None
|
request_path
|
bool
|
Request a path when probing destination. |
False
|
wait
|
float
|
Seconds to wait for path discovery. |
0.0
|
Returns:
| Type | Description |
|---|---|
dict
|
Structured doctor report dict. |
Source code in lxmfy/core.py
diagnose_destination(destination, *, request_path=False, wait=0.0)
¶
Probe path and identity for a destination hash.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination
|
str
|
Hex destination hash. |
required |
request_path
|
bool
|
Whether to request a path if missing. |
False
|
wait
|
float
|
Seconds to wait for a path after requesting. |
0.0
|
Returns:
| Type | Description |
|---|---|
dict
|
Dict describing identity/path status and hints. |
Source code in lxmfy/core.py
get_debugger()
¶
get_landlock_status()
¶
Return Landlock LSM sandbox availability and activation state.
on_delivery_event(callback=None)
¶
Subscribe to the outbound delivery event stream.
Usable as bot.on_delivery_event(fn) or as a decorator @bot.on_delivery_event(). Subscribers receive event dicts with ts, stage (queued, deferred, dispatched, delivered, failed, cancelled, dropped), and destination/message_id/hash/reason fields when available.
Source code in lxmfy/core.py
request_page(destination_hash, page_path, field_data=None)
¶
Request a page from a destination.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination_hash
|
str
|
The destination hash. |
required |
page_path
|
str
|
The path to the page. |
required |
field_data
|
dict | None
|
Optional field data to send with the request. |
None
|
Returns:
| Type | Description |
|---|---|
dict
|
The response from the destination. |
Source code in lxmfy/core.py
run(delay=10)
¶
Run the bot
Source code in lxmfy/core.py
Configuration settings for LXMFBot.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the bot. Defaults to "LXMFBot". |
announce |
int
|
The announce interval in seconds. Defaults to 600. |
announce_immediately |
bool
|
Whether to announce immediately on startup. Defaults to True. |
admins |
set
|
A set of admin identity hashes. Defaults to an empty set. |
hot_reloading |
bool
|
Whether to enable hot reloading of cogs. Defaults to False. |
rate_limit |
int
|
The maximum number of messages allowed per cooldown period. Defaults to 5. |
cooldown |
int
|
The cooldown period in seconds. Defaults to 60. |
max_warnings |
int
|
The maximum number of spam warnings before action is taken. Defaults to 3. |
warning_timeout |
int
|
The duration in seconds for which a spam warning is active. Defaults to 300. |
command_prefix |
str
|
The prefix for bot commands. Defaults to "/". |
cogs_dir |
str
|
The directory to load cogs from. Defaults to "cogs". |
cogs_enabled |
bool
|
Whether to enable cogs. Defaults to True. |
permissions_enabled |
bool
|
Whether to enable the permission system. Defaults to False. |
storage_type |
str
|
The type of storage to use ("json" or "sqlite"). Defaults to "json". |
storage_path |
str
|
The path to the storage file or directory. Defaults to "data". |
first_message_enabled |
bool
|
Whether to enable first message handling. Defaults to True. |
event_logging_enabled |
bool
|
Whether to enable event logging. Defaults to True. |
max_logged_events |
int
|
The maximum number of events to log. Defaults to 1000. |
event_middleware_enabled |
bool
|
Whether to enable event middleware. Defaults to True. |
announce_enabled |
bool
|
Whether to enable bot announcements. Defaults to True. |
signature_verification_enabled |
bool
|
Whether to enable cryptographic signature verification for incoming messages. Defaults to False. |
require_message_signatures |
bool
|
Whether to reject unsigned messages when signature verification is enabled. Defaults to False. |
require_stamps |
bool
|
Whether to reject messages with invalid stamps. Defaults to False. |
request_unknown_identities |
bool
|
Whether to request unknown identities from the network when a message is received from an unknown source. Defaults to False. |
stamp_cost |
int
|
Stamp cost required for messages to this bot. Outbound cost still comes from the peer announce unless send() overrides it. None disables inbound stamps. Defaults to None. |
include_tickets |
bool
|
Include reply tickets on outbound messages so peers that require stamps can answer without stamp generation. Defaults to True. |
direct_delivery_retries |
int
|
Number of times to retry direct delivery before falling back to propagation. Defaults to 3. |
propagation_fallback_enabled |
bool
|
Whether to use propagation nodes as fallback after direct delivery fails. Defaults to True. |
propagation_node |
str
|
The destination hash of the outbound propagation node. If None and autopeer_propagation is True, automatically discovers nodes. Defaults to None. |
autopeer_propagation |
bool
|
Whether to automatically discover and peer with propagation nodes from announces. Defaults to False. |
autopeer_maxdepth |
int
|
Maximum hop depth for auto-peering with propagation nodes. None = no limit. Defaults to 4. |
enable_propagation_node |
bool
|
Whether to run this bot as a propagation node. Defaults to False. |
message_storage_limit_mb |
float
|
Maximum storage for propagation node messages in megabytes. Only applies when enable_propagation_node is True. Defaults to 500 MB. |
config_path |
str
|
The path to the bot configuration directory. If None, defaults to "config" in the current working directory. Defaults to None. |
reticulum_config_dir |
str
|
The Reticulum config directory used for RNS shared instance/auth state. If None, uses LXMFY_RETICULUM_CONFIG_DIR when set, otherwise discovers the user/system Reticulum config (/etc/reticulum, ~/.config/reticulum, ~/.reticulum), and only then falls back to config_path. Isolated bot configs force share_instance=No to avoid RPC digest rejection with NomadNet/Columba. |
test_mode |
bool
|
Whether to run in test mode (skips RNS initialization). Defaults to False. |
log_level |
str or int or None
|
Logging level for lxmfy's own logger ("DEBUG", "INFO", "WARNING", ...). None leaves logging untouched. Defaults to "INFO". |
loglevel |
int
|
RNS log level (0-7) passed to RNS.Reticulum. None uses the Reticulum config file setting. Defaults to None. |
pending_sends_enabled |
bool
|
Hold outbound messages when the destination identity is not yet known, retrying on announces and periodic sweeps. Defaults to True. |
pending_sends_max |
int
|
Maximum deferred messages kept for unknown destinations. Oldest are dropped beyond this. Defaults to 200. |
pending_sends_ttl |
int
|
Seconds a deferred message is kept before being dropped. Defaults to 604800 (7 days). |
pending_sends_retry |
int
|
Minimum seconds between deferred-send sweeps in run(). Defaults to 300. |
announce_display_name_file |
str
|
Optional filename under config_path whose UTF-8 contents override the bot display name for LXMF delivery announces. If unset, |
Source code in lxmfy/config.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | |
__post_init__()
¶
Post-initialization to ensure admins is a set.
Source code in lxmfy/config.py
__str__()
¶
Return a string representation of the BotConfig object.
Source code in lxmfy/config.py
Represents a generic attachment.
Attributes:
| Name | Type | Description |
|---|---|---|
type |
AttachmentType
|
The type of the attachment (AttachmentType). |
name |
str
|
The name of the attachment. |
data |
bytes
|
The binary data of the attachment. |
format |
str | None
|
Optional format specifier (e.g., "png" for images). |
Source code in lxmfy/attachments.py
Bases: IntEnum
Enumerates the different types of attachments supported.
FILE: Represents a generic file attachment. IMAGE: Represents an image attachment. AUDIO: Represents an audio attachment.
Source code in lxmfy/attachments.py
Bases: Flag
Default permission set
Source code in lxmfy/permissions.py
Manages permissions, roles, and user assignments
Source code in lxmfy/permissions.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | |
assign_role(user, role_name)
¶
Assign a role to a user
Source code in lxmfy/permissions.py
create_role(name, permissions, priority=0, description=None)
¶
Create a new role
Source code in lxmfy/permissions.py
delete_role(name)
¶
Delete a role
Source code in lxmfy/permissions.py
get_user_permissions(user)
¶
Get combined permissions for a user
Source code in lxmfy/permissions.py
has_permission(user, permission)
¶
Check if user has specific permission
load_data()
¶
Load permission data from storage
Source code in lxmfy/permissions.py
remove_role(user, role_name)
¶
Remove a role from a user
Source code in lxmfy/permissions.py
save_data()
¶
Save permission data to storage
Source code in lxmfy/permissions.py
Manages scheduled tasks and background processes.
Source code in lxmfy/scheduler.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
__init__(bot)
¶
Initialize the TaskScheduler.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
Any
|
The bot instance. |
required |
Source code in lxmfy/scheduler.py
add_task(name, callback, cron_expr)
¶
Add a scheduled task.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the task. |
required |
callback
|
Callable
|
The function to execute when the task runs. |
required |
cron_expr
|
str
|
A cron-style expression defining when the task should run. |
required |
Source code in lxmfy/scheduler.py
remove_task(name)
¶
Remove a scheduled task.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the task to remove. |
required |
schedule(name, cron_expr)
¶
Decorator to schedule a task.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the task. |
required |
cron_expr
|
str
|
The cron expression for the task. |
required |
Source code in lxmfy/scheduler.py
start()
¶
A scheduled task with cron-style timing.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the task. |
callback |
Callable
|
The function to execute when the task runs. |
cron_expr |
str
|
A cron-style expression defining when the task should run (min hour day month weekday). |
last_run |
Optional[datetime]
|
The last time the task was run. |
enabled |
bool
|
Whether the task is currently enabled. |
Source code in lxmfy/scheduler.py
should_run(current_time)
¶
Check if the task should run at the given time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
current_time
|
datetime
|
The current datetime. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
True if the task should run, False otherwise. |
Source code in lxmfy/scheduler.py
Facade for the underlying storage backend.
Source code in lxmfy/storage.py
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 | |
__init__(backend)
¶
Initialize a new Storage instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
backend
|
StorageBackend
|
The storage backend to use. |
required |
delete(key)
¶
exists(key)
¶
Check if a key exists in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to check. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the key exists, False otherwise. |
get(key, default=None)
¶
Retrieve a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to retrieve. |
required |
default
|
Any
|
The default value to return if the key is not found. |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
The value associated with the key, or the default value if not found. |
Source code in lxmfy/storage.py
get_role_data(role_name)
¶
Helper method for permission system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_name
|
str
|
The name of the role. |
required |
Returns:
| Type | Description |
|---|---|
dict
|
The role data. |
get_user_roles(user_hash)
¶
Helper method for permission system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_hash
|
str
|
The hash of the user. |
required |
Returns:
| Type | Description |
|---|---|
list[str]
|
The list of roles for the user. |
Source code in lxmfy/storage.py
scan(prefix)
¶
Scan for keys with a given prefix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prefix
|
str
|
The prefix to scan for. |
required |
Returns:
| Type | Description |
|---|---|
list
|
A list of keys that start with the prefix. |
set(key, value)
¶
Store a value in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to store the value under. |
required |
value
|
Any
|
The value to store. |
required |
set_role_data(role_name, data)
¶
Helper method for permission system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_name
|
str
|
The name of the role. |
required |
data
|
dict
|
The role data. |
required |
set_user_roles(user_hash, roles)
¶
Helper method for permission system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_hash
|
str
|
The hash of the user. |
required |
roles
|
list[str]
|
The list of roles for the user. |
required |
Bases: StorageBackend
JSON file-based storage backend.
Source code in lxmfy/storage.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | |
__init__(directory)
¶
Initialize a new JSONStorage instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
directory
|
str
|
The directory to store the JSON files in. |
required |
Source code in lxmfy/storage.py
delete(key)
¶
Delete a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to delete. |
required |
Source code in lxmfy/storage.py
exists(key)
¶
Check if a key exists in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to check. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the key exists, False otherwise. |
get(key, default=None)
¶
Retrieve a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to retrieve. |
required |
default
|
Any
|
The default value to return if the key is not found. |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
The value associated with the key, or the default value if not found. |
Source code in lxmfy/storage.py
scan(prefix)
¶
Scan for keys with a given prefix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prefix
|
str
|
The prefix to scan for. |
required |
Returns:
| Type | Description |
|---|---|
list
|
A list of keys that start with the prefix. |
Source code in lxmfy/storage.py
set(key, value)
¶
Store a value in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to store the value under. |
required |
value
|
Any
|
The value to store. |
required |
Source code in lxmfy/storage.py
Bases: StorageBackend
SQLite database storage backend.
Source code in lxmfy/storage.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 | |
__init__(database_path)
¶
Initialize a new SQLiteStorage instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
database_path
|
str
|
The path to the SQLite database file. |
required |
Source code in lxmfy/storage.py
delete(key)
¶
Delete a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to delete. |
required |
Source code in lxmfy/storage.py
exists(key)
¶
Check if a key exists in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to check. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the key exists, False otherwise. |
Source code in lxmfy/storage.py
get(key, default=None)
¶
Retrieve a value from storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to retrieve. |
required |
default
|
Any
|
The default value to return if the key is not found. |
None
|
Returns:
| Type | Description |
|---|---|
Any
|
The value associated with the key, or the default value if not found. |
Source code in lxmfy/storage.py
scan(prefix)
¶
Scan for keys with a given prefix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prefix
|
str
|
The prefix to scan for. |
required |
Returns:
| Type | Description |
|---|---|
list
|
A list of keys that start with the prefix. |
Source code in lxmfy/storage.py
set(key, value)
¶
Store a value in storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The key to store the value under. |
required |
value
|
Any
|
The value to store. |
required |