nonebot-plugin-msgbuf 0.2.0

适用于 NoneBot2 插件的被动消息构造集成

nonebot-plugin-msgbuf

✨ 适用于 NoneBot2 插件的被动消息构造集成 ✨

代码比 SAA 和 SegBuilder 好看（不是）

介绍

nonebot-plugin-msgbuf 是帮助开发者快速构造与发送跨平台消息结构的应用的工具。相较于 SAA 与 SegBuilder，本插件在开发中结构更为清晰优雅。

适配器支持状态

符号	含义
✅	完全支持
🟨	部分支持，需要用户额外分平台处理
❌	不支持，发送时自动转化为后备文本

适配器	纯文本	图片	提及(@)	回复	表情	语音	视频	文件	分享	地理位置
OneBot V11	✅	✅	🟨	🟨	🟨	✅	✅	❌	✅	✅
OneBot V11 (Go-CQHTTP 拓展)	✅	✅	🟨	🟨	🟨	✅	✅	✅	✅	✅
OneBot V12	✅	✅	🟨	🟨	❌	✅	✅	✅	❌	✅
未写明的	✅	❌	❌	❌	❌	❌	❌	❌	❌	❌

安装

通过 nb-cli:

nb plugin install nonebot-plugin-msgbuf

使用

关于 require() 的使用问题：

NoneBot2 插件的首次导入必须通过 NoneBot2 自身的方式（包括但不限于 require(), load_plugin() 等）完成，否则之后使用 NoneBot2 方式导入该插件的插件将无法正常工作。

NoneBot2 插件体系要求必须使用 require() 加载插件依赖。

竞品对比

这是常规的消息构造与发送方法：

展开

from nonebot import on_message
from nonebot.adapters.onebot.v11 import MessageSegment
from pathlib import Path

ma = on_message()

@ma.handle()
async def test():
    await ma.send(MessageSegment.image(Path("image.png")) + "Hello world!")

---

这是 SAA 的消息构造与发送方法：

展开

from nonebot import on_message, require
from pathlib import Path

require("nonebot_plugin_saa")

from nonebot_plugin_saa import MessageFactory, Text, Image

ma = on_message()

@ma.handle()
async def test():
    await MessageFactory([Image(Path("image.png")), Text("Hello world!")]).send()

---

这是 SegBuilder 的消息构造与发送方法：

展开

from nonebot import on_message, require
from pathlib import Path

require("nonebot_plugin_segbuilder")

from nonebot_plugin_segbuilder import SegmentBuilder

ma = on_message()

@ma.handle()
async def test():
    await ma.send(SegmentBuilder.image(Path("image.png")) + "Hello world!")

---

这是 MsgBuf 的消息构造与发送方法：

from nonebot import on_message, require
from pathlib import Path

require("nonebot_plugin_msgbuf")

from nonebot_plugin_msgbuf import MsgBuf

ma = on_message()

@ma.handle()
async def test():
    async with MsgBuf() as mb:
        mb.image(Path("image.png"))
        mb.text("Hello world!")

@ma.handle()
async def test():
    async with MsgBuf() as mb:
        mb.image(Path("image.png")).text("Hello world!")

from nonebot_plugin_msgbuf import Image, Text

@ma.handle()
async def test():
    async with MsgBuf() as mb:
        mb << Image(Path("image.png")) << Text("Hello world!")

@ma.handle()
async def test():
    await MsgBuf().image(Path("image.png")).text("Hello world!").send()

使用 Go-CQHTTP 拓展

from nonebot_plugin_msgbuf import Specs
from pathlib import Path

@ma.handle()
async def test():
    async with MsgBuf(specs=Specs.OB11_GOCQHTTP) as mb:
        mb.image(Path("image.png")).text("Hello world!").file(Path("image.png"))