📖 介绍

本插件旨在允许开发者在聊天中执行带有上下文的 Python 代码，从而对 NoneBot 框架进行运行时侵入式修改。

由于这种设计，插件具有极高的灵活性，但也伴随着高风险。

💿 安装

nb plugin install nonebot-plugin-exe-code

uv add nonebot-plugin-exe-code

pip install nonebot-plugin-exe-code

pdm add nonebot-plugin-exe-code

poetry add nonebot-plugin-exe-code

conda install nonebot-plugin-exe-code

plugins = ["nonebot_plugin_exe_code"]

⚙️ 配置

在 nonebot2 项目的 .env 文件中添加下表中的配置

📄 权限说明

对于 exe_code__user 中配置的用户，在私聊/任意群聊中均可触发命令。

对于 exe_code__group 中配置的群组，任意用户均可触发命令。

对于 NoneBot 默认配置项 SUPERUSERS 中配置的用户，在私聊/任意群聊中均可触发命令，且在执行环境中拥有额外管理权限。

📦️ 数据存储

插件使用 nonebot/plugin-localstore 存储用户数据，存储位置参考 这里

🎉 使用

命令概览

• code [代码] 在用户执行环境中执行代码。

  代码中包含的 at 消息段将被转换为 用户ID 字符串。

  代码中包含的 图片 消息段将被转换为 图片URL 字符串。

  具体处理逻辑参考 ~matchers.depends:_ExtractCode

• getraw 获取引用消息的消息段的文本形式。

  例：对于 OneBot V11 适配器，将返回消息的 CQ码。

  提供变量： gem、gurl

• getmid 获取引用消息的消息 ID。

  提供变量： gem、gurl

• getimg [varname] 获取指定的图片。

  以 PIL.Image.Image 格式保存至上下文的 [varname] 变量中。未指定时默认为 img。

  提供变量： gurl

• terminate [@someone] 中止指定用户的代码。

  未指定时为自己的代码。仅 SUPERUSERS 可用。

执行环境

用户执行环境保存于 ~context:Context._contexts，随 NoneBot 重启而重置。

用户执行环境由 初始环境 深拷贝生成，包含 UniMessage 及一些常用消息段。

在传入代码开始执行前，用户执行环境将获得一个 API 实例，变量名固定为 api。同时，uid 变量将被设置为执行者的 用户ID，gid 变量将被设置为当前 群组ID (私聊则为 None)

api 中被 @export 装饰的方法将被导出到用户执行环境。例： print，feedback，help，input，...

传入的代码经过一次异步函数包装后，可以正常执行异步代码。具体参考 ~context:Context._solve_code。

对于供用户使用的接口方法，插件中使用 @descript 装饰器添加了描述。在执行代码时，可以通过 await help(api.method) 获取函数信息。

对于部分协议，插件提供了额外的接口，便于执行一些平台特化的操作。目前提供适配的协议：OneBot V11、Satori。

示例

await feedback(At(uid) + " Hi there")  # 向当前会话发送消息
await user(uid).send(f"Hello {uid}")   # 向指定用户发送消息
await group(gid).send(f"Hello {gid}")  # 向指定群组发送消息

# 插件重写的 print 函数，用法同原 print
# print 的内容将写入缓冲区，在代码段执行结束后输出
print("test", end=" ")
print("NoneBot", "Plugin", sep="-")

# 使用 UniMessage 提供的 Receipt 操作发送的消息
receipt = await feedback("Recall in 3s...")
await sleep(3)          # 异步等待 3 秒
await receipt.recall()  # 撤回消息

📝 更新日志

鸣谢

• nonebot/nonebot2: 跨平台 Python 异步机器人框架
• nonebot/plugin-alconna: 跨平台的消息处理接口
• nonebot/plugin-localstore: 插件数据存储
• he0119/nonebot-plugin-user: 获取用户标识
• RF-Tar-Railt/nonebot-plugin-uninfo: 多平台会话信息获取
• RF-Tar-Railt/nonebot-plugin-waiter: 灵活获取用户输入