核心组件¶
LXMFBot¶
主机器人类,负责消息路由、命令处理和机器人生命周期管理。
from lxmfy import LXMFBot
bot = LXMFBot(
name="MyBot",
command_prefix="/",
admins=set(),
config_path=None, # 默认为工作目录下的 "config"
reticulum_config_dir=None, # 或 LXMFY_RETICULUM_CONFIG_DIR / "~/.reticulum"
test_mode=False, # 跳过 RNS 启动,用于测试
log_level="INFO", # lxmfy 日志级别,None 则不动日志配置
loglevel=None, # RNS 日志级别 0-7,None 使用 reticulum 配置
# Announce
announce=600,
announce_immediately=True,
announce_enabled=True,
announce_display_name_file=None, # config_path 下覆盖 announced 显示名的文件
# (默认文件: bot_display_name.txt)
# 反垃圾保护
rate_limit=5,
cooldown=60,
max_warnings=3,
warning_timeout=300,
# Cogs
cogs_dir="cogs",
cogs_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,
hot_reloading=False,
# 存储, 事件, 权限
storage_type="json", # "json", "sqlite", "msgpack" 或 "memory"
storage_path="data",
permissions_enabled=False,
first_message_enabled=True,
event_logging_enabled=True,
max_logged_events=1000,
event_middleware_enabled=True,
# 安全
signature_verification_enabled=False,
require_message_signatures=False,
require_stamps=False, # 拒绝 stamp 无效的消息
request_unknown_identities=False, # 向网络请求发送者身份
stamp_cost=None, # 入站 stamp 成本, None 表示关闭
include_tickets=True, # 为出站消息附带回复 ticket
identity_pinning_enabled=False,
landlock_enabled=True,
# 可选功能
nlp_enabled=False,
nlp_threshold=0.5,
link_support_enabled=False,
lxmf_commands_enabled=True,
# 投递
message_persistence_enabled=True,
message_queue_size=50,
opportunistic_sending=True,
direct_delivery_retries=3,
propagation_fallback_enabled=True,
propagation_node=None, # 出站传播节点的 hash
autopeer_propagation=False, # 从 announce 中发现传播节点
autopeer_maxdepth=4, # 自动发现的最大 hop 深度, None = 不限
enable_propagation_node=False, # 将本 bot 作为传播节点运行
message_storage_limit_mb=500, # 节点存储上限, 仅节点模式
# 延迟发送
pending_sends_enabled=True, # 为未知目的地保留发送
pending_sends_max=200,
pending_sends_ttl=604800, # 7 天
pending_sends_retry=300, # 重试扫描间隔秒数
# RRC
rrc_enabled=False,
rrc_hubs=[],
rrc_rooms=[],
rrc_nick=None,
rrc_dest_name="rrc.hub",
rrc_auto_reconnect=True,
rrc_persist_sessions=True,
)
所有这些选项都是 BotConfig 的字段。LXMFBot(**kwargs) 会透传
每个关键字参数, 因此 bot.config 包含解析后的值。
主要方法¶
run(delay=10): 启动 bot 的主循环cleanup(): 持久化队列, 取消对话, 关闭调度器, 路由器和 RNS。 退出run()时自动调用。send(destination, message, title="Reply", lxmf_fields=None, stamp_cost=None, opportunistic=None, method=None, include_ticket=None, defer=None, reply_to=None, quote=None, thread=None): 向目的地发送消息。stamp_cost覆盖此消息的出站成本,opportunistic覆盖opportunistic_sending,include_ticket覆盖include_tickets,defer覆盖pending_sends_enabled。reply_to,quote和thread设置回复 threading 字段。send_with_attachment(destination, message, attachment, title="Reply", stamp_cost=None, opportunistic=None): 发送带附件的消息command(name, description="No description provided", admin_only=False, permissions=None, usage=None, examples=None, category=None, aliases=None, threaded=False, rate_limit=None): 注册命令的装饰器。permissions覆盖DefaultPerms门槛 (admin_only时为ALL, 否则为USE_COMMANDS),threaded在工作线程中执行回调,rate_limit限制每个发送者在 cooldown 窗口内的调用次数,usage,examples,category,aliases提供给帮助系统。命令支持类型注解参数的自动转换。intent(name, examples): 注册 NLP intent 处理器的装饰器。nlp.export_model(): 导出训练好的 NLP 模型数据。nlp.import_model(model_data): 导入先前导出的 NLP 模型数据。request_link(destination_hash, callback=None, app_name="lxmf", *aspects): 向目的地请求 RNS link。允许自定义app_name和aspects(默认为 "lxmf" 和 "delivery")。on_link(callback): 注册入站 RNS link 的处理器。load_extension(name): 按名称加载 cog 扩展模块 (例如 "cogs.utility")。reload_extension(name): 重新加载 cog 扩展模块。add_cog(cog_instance): 向 bot 添加 cog 类实例。remove_cog(cog_name): 按类名移除 cog。on_first_message(): 处理用户首条消息的装饰器on_message(): 处理所有消息的装饰器 (在命令处理之前调用)received(function): 注册一个回调, 对每条走完流水线但未被 命令或 intent 消费的入站消息, 以消息上下文调用on_reaction(): 处理入站回应的装饰器。处理器接收(sender, reaction), 其中 reaction 带有reaction_to,reaction_emoji和reaction_sender键react(destination, message_hash, reaction): 通过 LXMF 字段FIELD_REACTION对消息发送回应validate(): 对 bot 配置执行校验检查get_landlock_status(): 返回 bot 进程 Landlock LSM 沙箱的 可用性与启用状态diagnose_destination(destination, request_path=False, wait=0.0): 探测目标 hash 的身份与路径状态diagnose_connectivity(destination=None, request_path=False, wait=0.0): 执行完整 doctor 报告并以 dict 返回get_debugger(): 返回绑定到本 bot 的Debuggerset_propagation_node(node_hash): 固定出站传播节点get_propagation_node_status(): 已配置, 已发现以及当前使用的 出站传播节点状态set_message_storage_limit(megabytes): 作为传播节点运行时的 存储上限get_propagation_storage_stats(): 节点存储用量, 或解释不可用 原因的 dictconnect_rrc(hub_hash, rooms=None, nick=None, dest_name=None, auto_reconnect=None): 以客户端身份连接 RRC hubdisconnect_rrc(hub_hash=None): 断开一个或全部 RRC hub 会话on_rrc(callback=None): RRC 事件的装饰器或处理器注册 (handler(event, client, payload))on_delivery_event(callback=None): 订阅出站投递事件流, 可作 装饰器或直接调用
属性¶
config: 解析后的BotConfigcommands,cogs: 命令与 cog 注册表storage: 当前存储后端scheduler: 用于类 cron 任务的TaskSchedulerevents: 事件处理器与 dispatch 的EventManagermiddleware: 命令中间件的MiddlewareManagerpermissions: 角色与标志位的PermissionManagerspam_protection: 速率限制, 警告和封禁的SpamProtectionsignature_manager: 签名策略层nlp: intent 分类器 (仅在nlp_enabled时匹配)delivery:DeliveryTracker, 出站事件流conversations:msg.ask问题的ConversationManagerrrc: 多 hub 会话的RRCManager, 在启用 RRC 或运行connect_rrc()之前为Nonelocal: bot 的RNS.Destination(其 LXMF 地址为bot.local.hash)
Announce 显示名¶
对端看到的名字来自 name, 但 announce 存在两个覆盖途径。若设置
了 announce_display_name_file 且该文件存在于 config_path 下,
其内容优先。否则, 若存在 config_path 下的
bot_display_name.txt 则读取它。两种情况下, 赋值
bot.name = "New Name" 都会在运行时重新同步 announced 显示名。
这样运营者可以不改代码就重命名 bot, 且 announced 名字可以与 配置中的内部名不同。
通过 LXMF 字段实现结构化命令¶
机器人可以接收通过 LXMF FIELD_COMMANDS(0x09)发送的命令,
并自动以 FIELD_RESULTS(0x0A)回复。这让结构化请求/响应
工作流可以与普通文本命令并存。
传入的 FIELD_COMMANDS 会被解析并路由到与文本命令相同的命令
注册表,共享权限检查、类型注解参数解析、线程化和中间件。
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 字段字典
# 如果命令带有 request_id,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。
要禁用字段命令处理,在 BotConfig 中设置
lxmf_commands_enabled=False。
回应¶
回应以 LXMF FIELD_REACTION(0x40)字段的形式承载在一条
其余部分为空的消息上。pack_reaction 和 unpack_reaction
用于构造和解析该字段。
from lxmfy import pack_reaction, unpack_reaction
# 对一条消息发送回应
bot.react(destination_hash, message_hash_hex, "thumbs up emoji")
# 接收回应
@bot.on_reaction()
def on_reaction(sender, reaction):
# reaction["reaction_to"] - 目标消息的十六进制哈希
# 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 中访问以保持兼容。
回复 Threading¶
回复可以携带 LXMF 字段 FIELD_REPLY_TO (0x30),
FIELD_REPLY_QUOTE (0x31) 和 FIELD_THREAD (0x08)。渲染
thread 的客户端, 如 MeshChatX 和 Sideband, 会将其显示为真正的
引用回复, 而不是平铺消息。
msg.reply() 自动 threading: 将 FIELD_REPLY_TO 设为入站消息的
hash, FIELD_THREAD 设为会话根。
@bot.command("status")
def status(msg):
msg.reply("all systems nominal") # threaded 回复
msg.reply("flat", reply_to=None) # 退出 threading
msg.reply("noted", quote=True) # 引用入站文本
对于并非回复的发送, 显式传入字段:
入站回复会解析到消息上下文上:
@bot.command("ctx")
def ctx_cmd(msg):
msg.reply_to # 此消息回复的 hex hash, 或 None
msg.reply_quote # 回复携带的引用文本, 或 None
msg.thread # thread 根的 hex hash, 或 None
pack_reply(message_hash, quote=..., thread=...) 和
unpack_reply(fields) 已导出, 供手动处理字段使用。
对话¶
命令可以向发送者提问, 并把其下一条消息当作回答, 而不是作为 命令分发:
@bot.command("report")
def report(msg):
title = msg.ask("Report title?", timeout=300)
if title is None:
msg.reply("Timed out.")
return
body = msg.ask("Describe the issue.", timeout=600)
if body is None:
msg.reply("Timed out.")
return
msg.reply(f"Filed: {title.content}")
msg.ask(prompt, timeout=..., validator=...) 阻塞处理器, 直到
回答到达, 超时触发或对话被取消。它返回一个 Answer, 带有
content, fields, hash, sender 和 reply(text) 快捷方法。
验证器会拒绝不合格的回答并重新提问:
num = msg.ask(
"Pick a number",
validator=lambda a: None if a.content.isdigit() else "Digits only",
)
在异步命令处理器中使用 await msg.ask_async(...)。对于较长的
等待, 或可能同时存在大量对话的情况, 使用回调风格, 避免线程
被挂起:
msg.ask(
"Send the log file",
on_answer=lambda ans: ans.reply("received"),
on_timeout=lambda sender: bot.send(sender, "Too slow."),
timeout=3600,
)
注意:
- 在问题等待期间发送已注册的命令会取消该问题并执行命令。 用户始终有退出途径。
bot.conversations.pending_count()和bot.conversations.cancel(sender)为诊断和管理工具开放了 注册表。- 注册表上限为 1024 个待回答问题。满了之后
ask返回None。 - 阻塞式
ask会挂起处理该消息的投递线程。对直接投递是安全 的, 但从传播节点同步大批量消息的 bot 应优先使用on_answer回调。
存储¶
框架提供三种存储后端:
JSONStorage¶
SQLiteStorage¶
MsgPackStorage¶
MemoryStorage¶
命令¶
命令注册和处理:
@bot.command(name="hello", description="Says hello")
def hello(ctx):
ctx.reply(f"Hello {ctx.sender}!")
帮助元数据和访问控制来自装饰器的额外 kwargs:
from lxmfy import DefaultPerms
@bot.command(
name="purge",
description="Clear stored data",
permissions=DefaultPerms.MANAGE_MESSAGES,
usage="/purge <key>",
examples=["/purge cache"],
category="Admin",
aliases=["clear"],
)
def purge(ctx, key: str):
bot.storage.delete(key)
ctx.reply(f"Deleted {key}")
permissions 覆盖默认门槛: 普通命令为 USE_COMMANDS,
admin_only 为 ALL。category 在 /help 输出中对命令分组。
aliases 只是帮助元数据: 别名会展示给用户, 但不会注册到分发,
所以 /clear 不会执行 purge, 除非你再注册一个同名命令。
类型注解参数¶
命令会根据回调函数中的类型注解自动解析和转换参数。
@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}")
单命令速率限制¶
限制同一发送者在全局 cooldown 窗口内调用某命令的次数。达到
上限时仅拒绝本次调用, 不会产生警告或封禁。
与全局速率限制一样需要 permissions_enabled=True。拥有 admin
角色或 BYPASS_SPAM 的用户会跳过检查。
反垃圾保护¶
bot.spam_protection 执行全局限制: 发送者在每个 cooldown
窗口内最多发送 rate_limit 条消息。超限会增加一次警告并拒绝
该消息。达到 max_warnings 后发送者被封禁。警告在
warning_timeout 秒无违规后过期。
垃圾检查在 message_received 事件内运行, 需要
permissions_enabled=True。
bot = LXMFBot(
name="GuardedBot",
permissions_enabled=True,
rate_limit=5, # 每个 cooldown 窗口的消息数
cooldown=60, # 窗口时长 (秒)
max_warnings=3, # 封禁前的警告次数
warning_timeout=300, # 警告重置前的秒数
)
# 手动解除封禁
bot.spam_protection.unban(sender_hash)
警告, 封禁和计数器持久化在配置的存储后端中, 因此封禁在重启后
仍然有效。拥有 BYPASS_SPAM 的发送者永远不会被限速或封禁。
@bot.command 上的单命令 rate_limit 更温和: 仅拒绝调用, 从
不警告或封禁。
帮助系统¶
框架内置交互式帮助生成器,基于 Cog 和 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 事件的事件系统:
@bot.events.on("message_received", EventPriority.HIGHEST)
def handle_message(event):
# event.data 携带负载, 如 sender 和 message
event.cancel() # 停止后续处理器和其余处理
处理器按 EventPriority 顺序运行: HIGHEST, HIGH, NORMAL,
LOW。垃圾检查本身是一个 HIGHEST 的 message_received
处理器, 因此取消该事件就是限速器丢弃消息的机制。
分发你自己的事件:
event_logging_enabled, max_logged_events 和
event_middleware_enabled 存在于 BotConfig, 但未接线: 事件不
会写入存储, bot.events.use() 是空实现。请将其视为保留项。
测试¶
lxmfy.testing.TestBot 是为测试预配置的 LXMFBot。不启动任何
Reticulum 实例。入站消息会走真实的接收流水线 (中间件, 垃圾检
查, 权限, 分发), 出站发送被捕获以供断言。
from lxmfy import TestBot
def test_ping():
with TestBot() as bot:
@bot.command("ping")
def ping(msg):
msg.reply("pong")
sent = bot.receive("/ping", sender="alice")
assert sent[0].content == "pong"
assert sent[0].destination == bot.sender_hex("alice")
bot.receive(content, sender=..., fields=..., message_hash=...)注入一条消息并返回产生的SentMessage对象。发送者是命名 的:"alice"映射到一个稳定的假 hash, 或直接传入 hex 目标 hash。bot.drain()取出排队的出站消息。bot.outbox累积所有已发 送内容。bot.last_sent(sender=...)获取最近一条。bot.wait_sent(n, timeout=...)等待线程化命令。bot.receive_later(content, sender=..., delay=...)从 daemon 线程回应阻塞式msg.ask调用。fake_message(content, source_hash=..., ...)构造一条入站消息, 用于直接驱动bot._message_received。
SentMessage 封装每条捕获的出站消息: destination (hex),
content, title, fields, method, include_ticket,
stamp_cost 和 raw (底层对象)。
仓库的测试套件还包括可靠性和压力场景。使用仓库的测试运行器 执行。
高级可靠性测试套件¶
框架包含一套针对严苛环境的大规模自动化测试:
- 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")
通过 permissions_enabled=True 启用。DefaultPerms
标志位:
USE_BOT,SEND_MESSAGES,USE_COMMANDS: 基础访问MANAGE_MESSAGES,MANAGE_COMMANDS,MANAGE_USERS: 高级BYPASS_RATELIMIT,BYPASS_SPAM,VIEW_ADMIN_COMMANDS: 特殊VIEW_EVENTS,MANAGE_EVENTS,BYPASS_EVENT_CHECKS: 事件系统NONE,ALL: 快捷方式
bot.permissions 管理角色与指派:
bot.permissions.create_role("moderator", DefaultPerms.MANAGE_MESSAGES | DefaultPerms.BYPASS_SPAM)
bot.permissions.assign_role(user_hash, "moderator")
bot.permissions.remove_role(user_hash, "moderator")
bot.permissions.has_permission(user_hash, DefaultPerms.USE_COMMANDS)
角色与指派持久化在配置的存储后端中。存在两个不可删除的内置
角色: user (默认) 和 admin, 后者自动授予 admins 中的每个
hash。
中间件¶
用于处理消息和事件的中间件系统:
from lxmfy import MiddlewareType
@bot.middleware.register(MiddlewareType.PRE_COMMAND)
def pre_command_middleware(ctx):
# ctx 封装消息上下文, ctx.cancelled 会丢弃它
if "spamword" in ctx.data.content:
ctx.cancel()
流水线中有三个点会执行中间件:
PRE_COMMAND: 在命令分发之前, 垃圾检查之后。若链条返回None, 消息被完全丢弃。POST_COMMAND: 在命令回调之后 (包括线程化命令, 它们在工作 线程中触发)。PRE_EVENT: 在message_received事件分发之前。
POST_EVENT, REQUEST 和 RESPONSE 存在于 MiddlewareType,
但目前流水线中没有任何环节执行它们。
附件¶
支持发送文件、图片和音频:
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)
调度器¶
任务调度系统:
签名¶
LXMFy 为 LXMF 内置的加密消息签名与校验提供配置选项:
from lxmfy import LXMFBot
bot = LXMFBot(
name="SecureBot",
signature_verification_enabled=True, # 启用签名检查
require_message_signatures=False # 设为 True 可拒绝未签名消息
)
签名处理
LXMF 使用 RNS 身份自动处理所有加密签名和校验。LXMFy 的
SignatureManager 是一个配置层,负责:
- 控制是否强制执行签名校验
- 确定对未签名消息的策略(接受或拒绝)
- 与权限系统集成(例如可信用户可跳过校验)
实际的加密操作由 LXMF/RNS 执行,而不是 LXMFy。
Landlock LSM 沙箱¶
在支持 Landlock 的 Linux 内核(5.13+)上,LXMFy 可以限制 机器人进程和外部脚本 Cog 的文件系统访问。
机器人进程沙箱
当 landlock_enabled=True(默认)且未运行于 test_mode 时,
机器人会在初始化期间调用 apply_landlock_sandbox()。系统目录
为只读;机器人存储、配置、Cog、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:即使内核支持也禁用 LandlockLXMFY_LANDLOCK=1:在 Linux 上无论自动检测结果如何都尝试 Landlock- 未设置:遵循
landlock_enabled和内核自动检测
外部 Cog 沙箱
脚本 Cog 使用 external_cogs_sandbox_type。在 auto 模式下
优先使用 Landlock(若可用),因为它不需要外部工具。完整的
沙箱选项列表见创建机器人指南。
身份固定¶
LXMFy 支持可选的身份固定,防止身份被轮换或泄露后遭到冒充。 启用后,机器人会把一个 LXMF 地址“固定”到首次见到的公钥。
SignatureManager 方法¶
当 signature_verification_enabled=True 时,可通过
bot.signature_manager 访问 SignatureManager:
should_verify_message(sender):判断来自给定发送者的消息 是否应校验handle_unsigned_message(sender, message_hash):按策略处理 缺少有效签名的消息
LXMF 签名的工作原理¶
LXMF 在 pack() 操作期间使用发送者的 RNS 身份自动为所有出站
消息签名。接收消息时,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"
)
# 传播节点哈希应该是 Reticulum 网络上
# 一个有效的 LXMF 传播节点
也可以在构造时用 propagation_node="<hash>" 固定节点,
或让 bot 自行发现节点:
bot = LXMFBot(
name="AutoBot",
autopeer_propagation=True, # 从 announce 中学习节点
autopeer_maxdepth=4, # 忽略深度超过 4 跳的节点
)
bot.get_propagation_node_status() 报告手动节点, 发现的节点以及
当前使用的出站节点。
自动重试¶
为失败的直接投递配置自动重试次数:
bot = LXMFBot(
name="ReliableBot",
direct_delivery_retries=5, # 直接投递最多重试 5 次
propagation_fallback_enabled=True
)
bot.send(destination_hash, "Important message")
# direct_delivery_retries 默认为 3
# 重试逻辑会自动处理投递回调
重试系统会跟踪每个目标的投递尝试次数,并自动重试失败的投递。 投递成功后会重置该目标的重试计数器。
延迟发送¶
向节点尚未听闻其身份的目的地发送通常会直接失败。在
pending_sends_enabled (默认) 下, 消息会被保留在存储中, 并在
目的地 announce 时或周期性扫描时自动发出。
bot = LXMFBot(
pending_sends_enabled=True,
pending_sends_max=200, # 超过此数后最旧的保留消息被丢弃
pending_sends_ttl=604800, # 保留消息 7 天后过期
pending_sends_retry=300, # run() 中扫描间隔秒数
)
# 单次发送覆盖
bot.send(dest, "hold this", defer=True)
bot.send(dest, "send or drop", defer=False)
被保留的发送在管理命令 /queue 中显示为 held (unknown
peers), 并在投递跟踪器中产生 deferred 事件。
消息持久化¶
出站消息可以持久化到磁盘,确保机器人重启后仍能送达。持久化
默认开启。内存出站队列有上限(message_queue_size,默认 50),
满了之后会丢弃最旧的消息。无效的目标哈希不会被恢复。
Stamps 与 tickets¶
Stamp 成本让发送者在消息被接受前支付 proof-of-work, 从而抑制 不受欢迎的流量。LXMFy 暴露了该机制的两端。
bot = LXMFBot(
stamp_cost=16, # 要求此入站 stamp 成本
require_stamps=True, # 拒绝 stamp 无效的消息
include_tickets=True, # 允许对端回复而无需生成 stamp
)
stamp_cost是入站要求。发送的出站成本仍来自对端的 announce, 除非向bot.send()传入stamp_cost=。include_tickets(默认 True) 为出站消息附带回复 ticket, 使 要求 stamp 的对端可以免费回复。可用include_ticket=按发送 覆盖。request_unknown_identities=True在收到未知来源的消息时向 网络请求发送者身份, 帮助 stamp 和签名校验解析身份而不是盲目 失败。
运行时控制在 《路由器控制》 一节:
set_inbound_stamp_cost, enforce_stamps, ignore_stamps,
generate_ticket 以及 ticket 检查方法。
作为传播节点运行¶
一个 bot 可以同时充当 LXMF 传播节点, 为离线的对端存储消息:
bot = LXMFBot(
enable_propagation_node=True,
message_storage_limit_mb=500,
)
bot.set_message_storage_limit(750)
stats = bot.get_propagation_storage_stats()
get_propagation_node_status() 对两种角色都有效: 报告本 bot
使用的出站节点以及它自身是否作为节点服务。相关控制:
announce_propagation_node() 对外宣传该节点,
set_retain_on_node() 在节点上保留已投递消息,
allow_control_identity() / disallow_control_identity() 管理
哪些身份可以使用节点的控制通道。
投递事件¶
bot.delivery 记录一个有界的出站生命周期事件流, 无需读日志
即可观察消息流。阶段: queued, deferred, dispatched,
delivered, failed, cancelled, dropped。最近的一段会持久
化到存储并在启动时恢复。
@bot.on_delivery_event()
def watch(event):
print(event["stage"], event.get("destination"), event.get("reason"))
# 或直接检查
recent = bot.delivery.recent(20)
failures = bot.delivery.recent(stage="failed")
to_peer = bot.delivery.recent(destination="aa11bb...")
每个事件是一个 dict, 含 ts, stage 以及可选的 destination,
message_id, hash, method, attempts, reason, title。
管理员有 /delivery [limit] 命令, 可在聊天中渲染同一时间线,
lxmfy debug 在发送流水线检查中显示投递时间线摘要。
内置管理命令¶
这些命令自动注册, 并在启用权限时要求发送者在 admins 中:
| 命令 | 作用 |
|---|---|
/queue |
显示路由器出站队列, 内部队列和保留的发送 |
/cancel <id|all> |
取消待投递的出站消息 |
/inbox [cancel <hash|all>] |
列出或取消活跃的入站传输 |
/delivery [n] |
显示最近 n 条投递事件 (默认 15, 最多 50) |
/loadext <name> |
加载一个 cog 扩展 |
/reloadext <name> |
重新加载已加载的 cog 扩展 |
路由器控制¶
对底层 LXMRouter 的轻封装, 覆盖发送者控制, ticket, 出站队列
管理和传播节点同步。所有方法接受 hex 字符串形式的目标 hash,
在路由器未运行时 (例如 test_mode) 返回 False。
发送者控制 (入站)
ignore_destination(destination)/unignore_destination(destination)/is_ignored(destination): 丢弃来自某发送者的入站消息allow_destination(destination)/disallow_destination(destination): 路由器处于 allow-list 模式时的白名单管理prioritise_destination(destination)/unprioritise_destination(destination): 优先发送者名单set_inbound_stamp_cost(stamp_cost): 对入站消息要求 stamp 成本 (None清除)enforce_stamps()/ignore_stamps(): 入站 stamp 强制开关
Tickets
generate_ticket(destination, expiry=None): 为发送者签发入站 stamp ticketget_inbound_tickets(destination): 为发送者持有的 ticketget_outbound_ticket(destination)/get_outbound_ticket_expiry(destination)/get_outbound_stamp_cost(destination): 从网络学到的出站 ticket 状态
出站队列
outbound_queue(): 待投递出站消息的快照get_outbound_progress(lxm_hash): 某消息 hash 的投递进度或Nonecancel_outbound(message_id): 在投递前移除排队消息delivery_link_available(destination): 是否存在指向目标的活跃 RNS link
入站队列
has_message(message_hash): 入站 LXM hash 是否已投递inbound_count(): 进行中的活跃入站资源传输数inbound_transfers(): 每个传输的快照, 含 hash, 大小, 进度和 状态cancel_inbound(resource_hash): 中止一个活跃的入站传输cancel_all_inbound(): 中止所有活跃的入站传输, 返回取消数量
对端发现
本节点听闻过的目的地的 announce 元数据:
get_peer_app_data(destination): 原始 announced app_data 字节get_peer_lxmf_data(destination): 解码后的 LXMF announce 元 数据 (display_name,stamp_cost,capabilities), 对端未 announce 有效 LXMF 数据时为Noneget_peer_announce(destination): 完整 announce 记录, 含 hops, received_at, interface 和 app_datalist_peer_announces(limit=100): 所有听闻的 announce, 最新者 在前
传播
sync_propagation_node(max_messages=None): 从配置的传播节点拉 取消息cancel_propagation_sync(): 停止进行中的同步get_propagation_stats(): 节点传输状态与限制, 或Noneset_retain_on_node(retain): 在节点上保留已投递消息announce_propagation_node(): 将本节点 announce 为传播节点allow_control_identity(destination)/disallow_control_identity(destination): 传播控制通道白名单
导入
ingest_lxm_uri(uri): 将lxm://URI 消息导入入站队列
诊断¶
当消息不通时, 调试器会检查整条链路而不是靠猜: Reticulum 配置, 共享实例状态, 接口, 身份, announce 行为, 投递配置和发送流水 线。
lxmfy debug # 完整 doctor 报告, 保存到文件
lxmfy debug probe <hash> --request-path --wait 30
lxmfy debug send <hash> # 跟踪一次测试发送
lxmfy debug receive # 检查接收就绪状态
lxmfy debug compare <hash_a> <hash_b>
lxmfy debug tips # 常见故障的修复建议
报告默认做了隐私脱敏: home 路径和 hash 会被截断。--json 输出
机器可读结果, -o FILE 写出报告, --no-save 跳过文件,
--no-privacy 保留完整值供本地使用, --no-color 或 NO_COLOR
关闭 ANSI 输出。
同样的检查也可以在代码中调用:
report = bot.diagnose_connectivity() # doctor 报告的 dict
probe = bot.diagnose_destination( # 身份与路径探测
"<peer_hash>", request_path=True, wait=30,
)
debugger = bot.get_debugger() # 完整 API
checks = debugger.check_send_pipeline()
verdict = debugger.run_doctor(destination)
lxmfy/debugger.py 还导出了独立的 diagnose_destination(hash,
...) 帮助函数, 以及报告类型 CheckResult, DestinationProbe,
DoctorReport 和 MessageDebugger, 供自建工具使用。
消息处理器¶
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. 命令处理(如果消息以命令前缀开头)
兜底回调¶
bot.received(fn) 注册一个回调, 在流水线末尾处理未被任何其他
环节消费的消息: 没有首条消息处理器, 没有返回 True 的
on_message 处理器, 也没有匹配的命令或 NLP intent。回调收到
与命令相同的消息上下文, 包括 msg.sender, msg.content,
msg.reply() 等。
可作为自由文本输入的兜底处理。
Reticulum Relay Chat (RRC)¶
机器人可以通过 RNS Link 以 CBOR 封包加入
RRC hub。包:lxmfy.rrc。
BotConfig 选项¶
rrc_enabled(bool,默认False):启动时连接已配置的 hubrrc_hubs(十六进制哈希列表):hub 目标哈希rrc_rooms(str 列表):WELCOME 之后自动加入的房间rrc_nick(str 或 None):HELLO 和房间消息中的昵称rrc_dest_name(str,默认"rrc.hub"):用于构造 hub 目标的目标名称rrc_auto_reconnect(bool,默认True):link 断开后自动 重连rrc_persist_sessions(bool,默认True):跨重启持久化 hub 和房间reticulum_config_dir(str 或 None):Reticulum 配置目录。 也可用LXMFY_RETICULUM_CONFIG_DIR设置。使用与 MeshChatX 相同的配置(通常是~/.reticulum),这样 hub 的 announce 才可见。
示例¶
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:单 hub 会话RRCManager:多 hub 管理器(bot.rrc)RRCMessage:房间事件负载(kind、room、text、nick、src、mention等)RRC_VERSION:线路协议版本常量DEFAULT_DEST_NAME: 默认 hub 目标名 ("rrc.hub")make_envelope,encode_envelope,decode_envelope,validate_envelope,normalize_room: 供直接与 hub 通信的工具 使用的 wire 格式帮助函数
传给 @bot.on_rrc 处理器的常见事件包括 status、welcome、
joined、parted、msg、notice、action、motd、
error 和 rtt。
模板¶
框架包含若干可直接使用的机器人模板:
EchoBot¶
简单的 echo 机器人,复述收到的消息:
NoteBot¶
使用 JSON 存储的笔记机器人:
ReminderBot¶
使用 SQLite 存储的提醒机器人:
RRCBot¶
RRC 房间机器人,加入配置的 hub 并回复 @提及。默认 hub 为
664fc0e8d2e448658e37bb3f34e6c88f,房间为 #general,并在
可用时使用 ~/.reticulum。
from lxmfy.templates import RRCBot
bot = RRCBot(
hubs=["664fc0e8d2e448658e37bb3f34e6c88f"],
rooms=["general"],
nick="RRCBot",
reticulum_config_dir="~/.reticulum",
)
bot.run()
CLI 工具¶
框架提供了用于 bot 管理的命令行工具。不带参数运行 lxmfy 会
打开交互式菜单。
# 交互式 scaffold 完整项目
lxmfy init mybot # 项目目录, bot.py, cogs/, README
lxmfy init --here --yes # 当前目录, 接受全部默认值
# 创建单个 bot 文件
lxmfy create mybot
lxmfy create --template echo mybot
lxmfy create --template rrc my_rrc_bot
lxmfy create mybot --no-cogs # 跳过 cogs 包
lxmfy create --output dir/bot.py --name MyBot
# 运行模板 bot
lxmfy run echo
lxmfy run rrc
lxmfy run reminder --name "MyReminder"
# 诊断连通性 (见诊断一节)
lxmfy debug
lxmfy debug probe <hash> --request-path --wait 30
# 用一条消息测试签名校验
lxmfy signatures test
# 启用签名校验
lxmfy signatures enable
# 禁用签名校验
lxmfy signatures disable
lxmfy init 会询问项目名称, 模板, 存储后端, 命令前缀和 admin
hash。每个问题都可以改用 flag: --dir, --bot-name,
--template, --storage, --prefix, --admins, --no-cogs,
--force, --yes。在非 TTY 的 stdin 上则直接采用默认值。
create 和 run 的模板: basic, echo, reminder, note,
cogtest, rrc。
错误处理¶
在 bot.run() 周围捕获关停和运行时故障:
try:
bot.run()
except KeyboardInterrupt:
bot.cleanup()
except Exception as e:
logger.error(f"Error running bot: {str(e)}")
模块参考¶
由源码 docstring 生成。
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 530 531 | |
__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 313 314 | |
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", "sqlite", "msgpack", or "memory"). 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
A decorator class for bot commands.
This class is used to mark methods as bot commands and provide metadata about the command such as its name, description, and permission requirements.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the command |
description |
str
|
A description of what the command does |
admin_only |
bool
|
Whether the command is restricted to admin users |
callback |
callable
|
The function that implements the command |
Source code in lxmfy/commands.py
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 | |
__call__(func)
¶
Decorate a function as a command.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
func
|
callable
|
The function to be decorated |
required |
Returns:
| Name | Type | Description |
|---|---|---|
callable |
The decorated function |
__get__(obj, objtype=None)
¶
Support instance methods in command definitions.
This method enables the command decorator to work with instance methods by properly binding the method to the instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obj
|
The instance that the command is bound to |
required | |
objtype
|
The type of the instance |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
Command |
A new Command instance bound to the object |
Source code in lxmfy/commands.py
__init__(name, description='No description provided', admin_only=False, permissions=None, usage=None, examples=None, category=None, aliases=None, threaded=False, rate_limit=None)
¶
Initialize a new Command.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
The name of the command |
required |
description
|
str
|
Description of the command. Defaults to "No description provided" |
'No description provided'
|
admin_only
|
bool
|
Whether the command requires admin privileges. Defaults to False |
False
|
rate_limit
|
int
|
Max invocations per sender per cooldown window for this command. None disables the per-command limit; the global message rate limit still applies. |
None
|
Source code in lxmfy/commands.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
Data class representing an event.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the event. |
data |
dict
|
A dictionary containing event-specific data. |
cancelled |
bool
|
A flag indicating whether the event has been cancelled. |
Source code in lxmfy/events.py
__eq__(other)
¶
Compares this event to another object for equality.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
other
|
Any
|
The object to compare to. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
True if the other object is an Event instance and has the same name, False otherwise. |
Source code in lxmfy/events.py
__hash__()
¶
Returns the hash value of the event based on its name.
Returns:
| Name | Type | Description |
|---|---|---|
int |
Hash value of the event name. |
Manages event registration, dispatching, and logging.
Source code in lxmfy/events.py
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 | |
__init__(storage)
¶
Initializes the EventManager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
storage
|
The storage object used for logging events. |
required |
dispatch(event)
¶
Dispatches an event to all registered handlers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event
|
Event
|
The event to dispatch. |
required |
Source code in lxmfy/events.py
on(event_name, priority=EventPriority.NORMAL)
¶
Registers an event handler for a specific event.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event_name
|
str
|
The name of the event to handle. |
required |
priority
|
EventPriority
|
The priority of the event handler (default: EventPriority.NORMAL). |
NORMAL
|
Returns:
| Name | Type | Description |
|---|---|---|
Callable |
A decorator that registers the decorated function as an event handler. |
Source code in lxmfy/events.py
use(middleware)
¶
Adds middleware to the event pipeline.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
middleware
|
Callable
|
The middleware function to add. |
required |
Bases: Enum
Enumeration of event priority levels.
Members
HIGHEST: Highest priority. HIGH: High priority. NORMAL: Normal priority. LOW: Low priority.
Source code in lxmfy/events.py
Manages middleware registration and execution
Source code in lxmfy/middleware.py
execute(mw_type, data)
¶
Execute middleware chain for given type
Source code in lxmfy/middleware.py
register(middleware_type, func=None)
¶
Register a middleware function
Source code in lxmfy/middleware.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
Default help formatter for commands.
Source code in lxmfy/help.py
format_all_commands(categories)
staticmethod
¶
Format the complete help listing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
categories
|
dict
|
A dictionary where keys are category names and values are lists of command objects. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
A formatted string containing help information for all commands. |
Source code in lxmfy/help.py
format_category(category, commands)
staticmethod
¶
Format a category of commands.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
category
|
str
|
The name of the category. |
required |
commands
|
list
|
A list of command objects in the category. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
A formatted string containing the category's help information. |
Source code in lxmfy/help.py
format_command(command)
staticmethod
¶
Format a single command's help.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
command
|
The command object to format. |
required |
Returns:
| Type | Description |
|---|---|
str
|
A formatted string containing the command's help information. |
Source code in lxmfy/help.py
A system for providing help information about available commands.
Source code in lxmfy/help.py
__init__(bot, formatter=None)
¶
Initialize the HelpSystem.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bot
|
LXMFBot
|
The bot instance. |
required |
formatter
|
HelpFormatter | None
|
An optional help formatter. Defaults to HelpFormatter. |
None
|
Source code in lxmfy/help.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
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 | |
__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
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 | |
__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
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 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 | |
__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 |
Source code in lxmfy/storage.py
Bases: StorageBackend
In-memory storage backend.
Source code in lxmfy/storage.py
Bases: StorageBackend
MsgPack file-based storage backend.
Uses the msgpack implementation vendored with RNS
(RNS.vendor.umsgpack), so no extra dependency is needed. Stores
each key in its own {key}.msgpack file, mirroring JSONStorage.
Source code in lxmfy/storage.py
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 | |
__init__(directory)
¶
Initialize a new MsgPackStorage instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
directory
|
str
|
The directory to store the msgpack 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
Tracks pending questions per sender and resolves them on reply.
Source code in lxmfy/conversations.py
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 | |
ask(sender, prompt, *, timeout=DEFAULT_TIMEOUT, title=None, validator=None)
¶
Send a prompt and block until the sender replies.
Returns an Answer with content, fields, and hash, or None on
timeout or cancellation. In async command handlers use
await msg.ask_async(...) instead. For long waits prefer the
callback style with on_answer so no thread stays parked.
Source code in lxmfy/conversations.py
ask_async(sender, prompt, *, timeout=DEFAULT_TIMEOUT, title=None, validator=None)
async
¶
Send a prompt and await the sender's reply.
Same contract as ask, for async command handlers.
Source code in lxmfy/conversations.py
ask_callback(sender, prompt, on_answer, *, timeout=DEFAULT_TIMEOUT, title=None, validator=None, on_timeout=None)
¶
Send a prompt and invoke on_answer(answer) when the reply arrives.
Non-blocking. on_timeout(sender) fires if the sender never answers. Returns False when the pending limit is reached.
Source code in lxmfy/conversations.py
cancel(sender)
¶
cancel_all()
¶
has_pending(sender)
¶
pending_count()
¶
pending_senders()
¶
resolve(sender, message)
¶
Feed an inbound message to a pending question.
Returns True when the message was consumed as an answer. When a validator rejects the answer the question stays pending.
Source code in lxmfy/conversations.py
The message that answered a pending question.
Source code in lxmfy/conversations.py
reply(text, **kwargs)
¶
Reply to the sender who answered, threading to their message.
Bounded delivery event stream with subscribers and persistence.
Source code in lxmfy/delivery.py
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 143 144 145 146 | |
__init__(storage=None, maxlen=500)
¶
Initialize the tracker.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
storage
|
Optional Storage facade for persisting the recent tail of the stream. Pass None to keep events in memory. |
None
|
|
maxlen
|
int
|
Maximum in-memory events retained. |
500
|
Source code in lxmfy/delivery.py
load_persisted()
¶
Restore the persisted tail into memory at startup.
Source code in lxmfy/delivery.py
recent(limit=None, *, stage=None, destination=None)
¶
Return the most recent events, oldest first.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
limit
|
int | None
|
Maximum events returned, counted from the newest. |
None
|
stage
|
str | None
|
Optional stage filter. |
None
|
destination
|
str | None
|
Optional exact destination filter. |
None
|
Source code in lxmfy/delivery.py
record(stage, **fields)
¶
Append a delivery event and notify subscribers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
stage
|
str
|
One of STAGES. |
required |
**fields
|
Optional event fields: destination, message_id, hash, method, attempts, reason, title. |
{}
|
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
The recorded event dict. |
Source code in lxmfy/delivery.py
subscribe(callback)
¶
unsubscribe(callback)
¶
Remove a subscriber. Returns True when it was registered.
Bases: LXMFBot
LXMFBot preconfigured for tests, with message injection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Bot name. |
'TestBot'
|
**overrides
|
Any LXMFBot/BotConfig keyword. Test-friendly defaults apply unless overridden. |
{}
|
Source code in lxmfy/testing.py
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 | |
close()
¶
drain()
¶
Pop all queued outbound messages and append them to outbox.
Source code in lxmfy/testing.py
last_sent(sender=None)
¶
Most recent outbound message, optionally filtered by sender.
Source code in lxmfy/testing.py
receive(content, *, sender='alice', title=None, fields=None, message_hash=None)
¶
Inject an inbound message through the real receive pipeline.
Returns the outbound messages produced while handling it. For threaded commands use wait_sent after receive.
Source code in lxmfy/testing.py
receive_later(content, *, sender='alice', delay=0.05, **kwargs)
¶
Deliver an inbound message on a daemon thread after a delay.
Used to answer blocking msg.ask calls inside command handlers.
Source code in lxmfy/testing.py
sender_hash(sender='alice')
¶
Stable source hash for a named fake sender.
Accepts a name (mapped to a fixed random hash per bot) or a hex destination hash.
Source code in lxmfy/testing.py
sender_hex(sender='alice')
¶
wait_sent(count=1, timeout=5.0)
¶
Wait until at least count new outbound messages are queued.
Source code in lxmfy/testing.py
An outbound message captured from the bot queue.
Source code in lxmfy/testing.py
Diagnose LXMF send/receive connectivity problems.
Source code in lxmfy/debugger.py
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 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 | |
__init__(*, reticulum_config_dir=None, config_path=None, bot=None, privacy=True)
¶
Create a debugger.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reticulum_config_dir
|
str | None
|
Explicit Reticulum config directory. |
None
|
config_path
|
str | None
|
Bot config directory (identity, announce state). |
None
|
bot
|
Any | None
|
Optional running LXMFBot instance to introspect. |
None
|
privacy
|
bool
|
Redact paths/hashes in reports (default True). |
True
|
Source code in lxmfy/debugger.py
check_announce(*, try_announce=False)
¶
Announce configuration and optional live announce test.
Source code in lxmfy/debugger.py
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 | |
check_bot_identity()
¶
Report bot delivery destination if available.
Source code in lxmfy/debugger.py
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 | |
check_delivery_config()
¶
Report effective delivery knobs (bot config or framework defaults).
Source code in lxmfy/debugger.py
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 | |
check_delivery_timeline(limit=10)
¶
Render recent delivery events from the live bot or disk.
Source code in lxmfy/debugger.py
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 | |
check_disk_permissions()
¶
Verify config, storage, and Reticulum dirs are usable.
Source code in lxmfy/debugger.py
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 | |
check_environment()
¶
OS, Python, and package versions.
Source code in lxmfy/debugger.py
check_instance()
¶
Shared RNS instance vs owned/isolated bot config.
Source code in lxmfy/debugger.py
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 | |
check_interfaces()
¶
Report Reticulum interface status (no hostnames/IPs).
Source code in lxmfy/debugger.py
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 | |
check_send_pipeline()
¶
Internal reasons messages would or would not leave the bot.
Source code in lxmfy/debugger.py
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 | |
check_storage_history()
¶
Read delivery_attempts / persisted_queue from disk without a live bot.
Source code in lxmfy/debugger.py
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 | |
compare_destinations(left, right, *, request_path=False, wait=0.0)
¶
Compare path/identity status for two destination hashes.
Source code in lxmfy/debugger.py
diagnose_receive()
¶
Explain why peers may not be able to reach this bot.
Source code in lxmfy/debugger.py
diagnose_send(destination, *, probe=None)
¶
Explain why sending to a destination may fail.
Source code in lxmfy/debugger.py
1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 | |
ensure_reticulum(loglevel=None)
¶
Initialize Reticulum if needed.
Source code in lxmfy/debugger.py
format_report_text(report)
¶
Format a plain-text privacy-friendly report for files/sharing.
Source code in lxmfy/debugger.py
2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 | |
print_probe(probe, *, as_json=False)
¶
Print a destination probe result.
Source code in lxmfy/debugger.py
print_report(report, *, as_json=False)
¶
Print a doctor report to the terminal.
Source code in lxmfy/debugger.py
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 | |
probe_destination(destination, *, request_path=False, wait=0.0)
¶
Probe path and identity knowledge for a destination.
Source code in lxmfy/debugger.py
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 | |
run_doctor(destination=None, *, request_path=False, wait=0.0, try_announce=False)
¶
Run a full connectivity doctor report.
Source code in lxmfy/debugger.py
save_report(report, path=None, *, as_json=False)
¶
Write report to a file and return the path used.
Source code in lxmfy/debugger.py
Full connectivity doctor report.
Source code in lxmfy/debugger.py
Path/identity probe for a destination hash.
Source code in lxmfy/debugger.py
Client session for a single RRC hub destination.
Source code in lxmfy/rrc/client.py
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 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 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 | |
connected
property
¶
True when the session is welcomed and the link is active.
connect()
¶
Begin connecting to the hub in a background thread.
Source code in lxmfy/rrc/client.py
disconnect()
¶
Tear down the session and cancel reconnect.
Source code in lxmfy/rrc/client.py
join(room, key=None)
¶
Request membership in a room. Returns the normalized room name.
Source code in lxmfy/rrc/client.py
part(room)
¶
Leave a room. Returns the normalized room name.
Source code in lxmfy/rrc/client.py
ping()
¶
Send a PING and return the correlation body.
Source code in lxmfy/rrc/client.py
send_action(room, text)
¶
send_command(text, room=None)
¶
Send a slash command as a MSG body.
Source code in lxmfy/rrc/client.py
send_message(room, text)
¶
send_notice(room, text)
¶
set_auto_join(rooms)
¶
Configure rooms to join automatically after WELCOME.
set_nick(nick)
¶
Set the advisory nickname used on outgoing envelopes.
Source code in lxmfy/rrc/client.py
status_dict()
¶
Return a serializable status snapshot.
Source code in lxmfy/rrc/client.py
Owns RRCClient sessions and fans events out to bot handlers.
Source code in lxmfy/rrc/manager.py
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 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 | |
connect(hub_hash, rooms=None, nick=None, dest_name=None, auto_reconnect=None)
¶
Connect to an RRC hub. Returns the client session.
Source code in lxmfy/rrc/manager.py
disconnect(hub_hash=None)
¶
Disconnect one hub, or all hubs when hub_hash is None.
Source code in lxmfy/rrc/manager.py
get(hub_hash)
¶
Return a connected client for a hub hash, if present.
Source code in lxmfy/rrc/manager.py
join(room, hub_hash=None)
¶
Join a room on the first connected hub, or a specific hub.
Source code in lxmfy/rrc/manager.py
on_event(callback)
¶
part(room, hub_hash=None)
¶
Part a room on the first connected hub, or a specific hub.
Source code in lxmfy/rrc/manager.py
restore_sessions()
¶
Restore persisted hub sessions. Returns number of hubs reconnected.
Source code in lxmfy/rrc/manager.py
save_sessions()
¶
Persist hub hashes, rooms, and nick for crash recovery.
Source code in lxmfy/rrc/manager.py
send_action(room, text, hub_hash=None)
¶
Send an ACTION on the first connected hub, or a specific hub.
Source code in lxmfy/rrc/manager.py
send_message(room, text, hub_hash=None)
¶
Send a MSG on the first connected hub, or a specific hub.
Source code in lxmfy/rrc/manager.py
send_notice(room, text, hub_hash=None)
¶
Send a NOTICE on the first connected hub, or a specific hub.
Source code in lxmfy/rrc/manager.py
shutdown()
¶
Persist session state and tear down links without forgetting hubs.