nonebot2 插件编写指南（初级）（2.0.0a16之前）_kamuXiY_nonebot插件

网络 02-07 4557

nonebot2 插件编写指南（初级）

这篇文章将从零教你白手起一个插件（并辅以现写一个获取命运 2 每日日报的插件（感谢天阙提供的日报 api 接口）本文另发于个人博客：这里

阅读这篇文章，你至少需要以下技能：

部分 python 知识nb2 的部分使用方式使用百度排除故障的能力等

官方提供的教程：创建插件

1.如何创建一个插件？

因日报插件体量非常小，因选择单文件插件创建方式在你的 nb2 目录找到你的 bot，在 bot 文件夹下找到 plugins 文件夹这里存放着用户自定义的插件，而官方插件存放在 python 的包目录下

若找不到 plugins 文件夹，请使用：

nb plugin new

在 plugins 文件夹下创建文件today.py 插件文件就创建好了

2.需要用到的包

首先我们要引入 nonebot 的必要包：

#事件响应器函数 from nonebot import on_command, on_startswith #rule事件响应规则（需要@bot才能响应事件） from nonebot.rule import to_me #bot使用的对象和字典 from nonebot.typing import T_State from nonebot.adapters import Bot, Event

这些包也是一会要用到的：

#massage是使用cq码的必要函数 from nonebot.adapters.cqhttp.message import Message #使用无头浏览器访问api地址 import urllib3 #处理api返回的json数据 import json 3.事件响应器

要使你的 bot 能识别 qq 消息关键词，并对消息做出响应，你需要注册一个事件响应器响应器格式为：

事件函数名=响应器函数("事件响应器名",[aliases={'响应关键词1','响应关键词2', }],priority=响应优先级,[rule=响应器规则])

日报的事件响应器可以这样写：

today = on_command("today", aliases={'调试/日报', }, priority=5)

使用调试/日报可以激活此函数响应，优先级为 5

handle

handle()是处理事件的主体部分，是事件处理的起点（不包括预处理）在函数前加上这段来进行说明这是一个handle：

@today.handle()

然后创建一个异步函数：

async def handle_first_receive(bot: Bot, event: Event, state: T_State):

接下来的内容可以在脚本之外先提前测试访问 api 并读取返回的 json 值，并转换成可读格式：

url = 'http://·/heybox/dailynews/img/d227cae814dacb6434ae0617bc3131a5.png", "width": 1063, "height": 4770 }

提取图片地址：

img_url = hjson["img_url"]

这时，图片的网址就提前并存入变量了，而发送图片需要一个特殊的格式—cq 码

cq 码

CQ 码，是指在酷 Q Pro / Air 的消息中，以 [CQ:开头、 ] 结尾的，可以实现特殊功能的代码。酷 Q 虽已不再使用，但 cq 码却保留了下来

发送图片的 cq 格式为：

[CQ:image,file=%文件名%]

其中%文件名%可为网址或本地协议（例如 go-cqhttp）本地文件夹下的 data/image 文件夹内文件构建 cq 码：

cq = "[CQ:image,file=" + img_url + ",id=40000]"

id=40000 表示为默认特效

本地运行

根据以上语句，测试 python 完整代码为：

import urllib3 import json url = 'http://·/heybox/dailynews/img/d227cae814dacb6434ae0617bc3131a5.png,id=40000]

使用 send 来发送消息：

await today.send(Message(cq))

cq 码需要使用 Massage()来处理才能正常识别为图片并发送

完整代码 from nonebot import on_command, on_startswith from nonebot.typing import T_State from nonebot.adapters import Bot, Event from nonebot.adapters.cqhttp.message import Message import urllib3 import json today = on_command("today", aliases={'调试/日报', }, priority=5) @today.handle() async def handle_first_receive(bot: Bot, event: Event, state: T_State): url = 'http://·/d2api/today/' r = urllib3.PoolManager().request('GET', url) hjson = json.loads(r.data.decode()) img_url = hjson["img_url"] cq = "[CQ:image,file=" + img_url + ",id=40000]" await today.send(Message(cq)) 优化

日报更新与棒鸡服务器和天阙的服务器状态挂钩，若无法更新则会无法读取图片地址，bot 将无任何返回值，无反馈的错误是一件很糟糕的事我们使用try-except来做一个简单的异常嵌套：

from nonebot import on_command, on_startswith from nonebot.typing import T_State from nonebot.adapters import Bot, Event from nonebot.adapters.cqhttp.message import Message import urllib3 import json today = on_command("today", aliases={'调试/日报', }, priority=5) @today.handle() async def handle_first_receive(bot: Bot, event: Event, state: T_State): try: try: url = 'http://·/d2api/today/' r = urllib3.PoolManager().request('GET', url) hjson = json.loads(r.data.decode()) img_url = hjson["img_url"] #print(img_url) cq = "[CQ:image,file=" + img_url + ",id=40000]" await today.send(Message('json：\n'+str(hjson)+ '\nimg_url：\n'+img_url+ '\n'+cq)) except: url = 'http://·/d2api/today/' r = urllib3.PoolManager().request('GET', url) hjson = json.loads(r.data.decode()) error_url = hjson["error"] await today.send("获取日报失败\n"+ "error:\n"+ error_url) except : await today.send("获取日报失败:\n服务器错误")

虽然比较简陋，但是应该能应付大部分情况

后记

最近对群 bot 比较感兴趣，就自学了一下 python 和 nb2 的知识，尝试写一下可以帮助自己的插件下一篇可以讲一下如何让用户输入附带参数，还有一些简单是例子