nonebot2/README.md
2020-10-16 16:08:51 +08:00

3.4 KiB
Raw Blame History

nonebot

NoneBot

Python 异步机器人框架

license pypi python cqhttp
QQ Chat Telegram Chat QQ Release Telegram Release

文档 · 安装 · 开始使用

简介

NoneBot2 是一个可扩展的 Python 异步机器人框架,它会对机器人收到的消息进行解析和处理,并以插件化的形式,分发给消息所对应的命令处理器和自然语言处理器,来完成具体的功能。

除了起到解析消息的作用NoneBot 还为插件提供了大量实用的预设操作和权限控制机制,尤其对于命令处理器,它更是提供了完善且易用的会话机制和内部调用机制,以分别适应命令的连续交互和插件内部功能复用等需求。

目前 NoneBot2 在 FastAPI 的基础上封装了与 CQHTTP(OneBot) 协议插件的网络交互。

得益于 Python 的 asyncio 机制NoneBot 处理消息的吞吐量有了很大的保障,再配合 WebSocket 通信方式也是最建议的通信方式NoneBot 的性能可以达到 HTTP 通信方式的两倍以上,相较于传统同步 I/O 的 HTTP 通信,更是有质的飞跃。

需要注意的是NoneBot 仅支持 Python 3.7+ 及 CQHTTP(OneBot) 插件 v11+。

此外NoneBot2 还有可配套使用的额外脚手架/框架:

文档

文档目前尚未完成「API」部分由 sphinx 自动生成,你可以在 这里 查看。

贡献

如果你在使用过程中发现任何问题,可以 提交 issue 或自行 fork 修改后提交 pull request。

如果你要提交 pull request请确保你的代码风格和项目已有的代码保持一致遵循 PEP 8,变量命名清晰,有适当的注释。