nonebot2 插件编写指南（二）（2.0.0a16之前）

2023-10-28 05:59
文章标签 编写 指南 插件 之前 2.0 nonebot2 0a16

本文主要是介绍nonebot2 插件编写指南（二）（2.0.0a16之前），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

nb2 插件编写指南（二）

这一学期过完放假了，也有时间来填之前挖的坑了
突然发现两篇三篇写不完这些东西，就变成长期更新的学习笔记吧

这篇文章要点：

  • 使用 api 来发送到指定好友或群
  • 定时发送信息
  • 有参数传入的插件（例如查询 b 站视频封面）

用到的官方文档：nb2api
本篇还同时发布于我的博客：kamuXiY的小窝

1.NoneBot.adapters 使用

nb2 的协议官方提供了cqhttp、ding、mirai三个
以 cqhttp 为例
cqhttp 的 api 文档：文档
上篇，我们知道，使用这样的格式来发送一条信息到触发这个命令的群或好友：

await bot.send(发送内容)

这个使用的是NoneBot.adapters.cqhttp的send(event, message, at_sender=False, **kwargs)模块
这句话同样可以写为以下形式：

await bot.call_api("send_msg", message=发送内容)
await bot.send_msg(message=发送内容)

而发送到指定群的 api 为send_group_msg
便可以写为：

await bot.call_api("send_group_msg",group_id=群号, message=发送内容)
await bot.send_group_msg(group_id=群号, message=发送内容)

这是发送到群的，发送给好友的 api 为send_private_msg

如何定时发送信息？

这个是比较有用的一点
例如发送每日推送，或发送定时公告，或者定时开启爬虫来爬取信息并发出来
可以结合上面发送到指定对象来写出一个好用的定时推送插件
官方定时任务文档：定时任务

先要引入一个插件：nonebot_plugin_apscheduler
使用 nb-cli 脚手架来安装这个插件：

nb plugin install nonebot_plugin_apscheduler

这个插件与其他不同，稍后会直接导入到需要的位置，无需在 bot.py 中导入
除此之外，还需要添加其他配置：

在.env中添加：

APSCHEDULER_AUTOSTART=true
APSCHEDULER_CONFIG={"apscheduler.timezone": "Asia/Shanghai"}

在 bot.py 中添加：

nonebot.init(apscheduler_autostart=True)
nonebot.init(apscheduler_config={"apscheduler.timezone": "Asia/Shanghai"
})

插件使用格式：

#导入nonebot.require模块
from nonebot import require
#使用nonebot.require模块导入nonebot_plugin_apscheduler的scheduler
scheduler = require('nonebot_plugin_apscheduler').scheduler
#设置在几点启动脚本
@scheduler.scheduled_job('cron', hour='小时',minute='分钟')
#启动的脚本
async def run_every_2_hour():'''需要执行的代码'''

而发送消息需要用到最开始提到的发送给指定对象方法
但是 bot 本身需要知道自己是谁：

driver = get_driver()
BOT_ID = str(driver.config.bot_id)
bot = driver.bots[BOT_ID]

拿到 BOT_ID 后，bot 就知道自己是谁了

万事具备，我们来写个简单的例子来练练手
例如，我想在每天中午 12 点发一条测试信息到群（924026546），便可以这样写：

from nonebot import on_command, require, get_driver
from nonebot.typing import T_State
from nonebot.adapters import Bot, Event
from nonebot.adapters.cqhttp.message import Message
import nonebot.adapters.cqhttp
import _threadscheduler = require('nonebot_plugin_apscheduler').scheduler@scheduler.scheduled_job('cron', hour=12,minute=0)
async def demo():driver = get_driver()BOT_ID = str(driver.config.bot_id)bot = driver.bots[BOT_ID]group_id=924026546await bot.send_group_msg(group_id=group_id, message="测试消息")

好了，你已经完全掌握了，来试一试吧！.jpg

结合第一篇的日报发送，来写一篇定时发送最新日报的插件吧！
命运 2 每天凌晨 1 点更新内容，日报是 1:03 更新，我们就 1:05 更新吧
这样写（过长警告 ⚠）：

from nonebot import on_command, on_startswith, require, get_driver
from nonebot.rule import to_me
from nonebot.typing import T_State
from nonebot.adapters import Bot, Event
from nonebot.adapters.cqhttp.message import Message
import nonebot.adapters.cqhttp
import _threadimport urllib3
import jsonscheduler = require('nonebot_plugin_apscheduler').scheduler
m=5
h=1
@scheduler.scheduled_job('cron', hour=h,minute=m)
async def tm():driver = get_driver()BOT_ID = str(driver.config.bot_id)bot = driver.bots[BOT_ID]group_id=#这里写群号try:try:url = 'http://www.tianque.top/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]"msg=Message(cq)await bot.send_group_msg(group_id=group_id, message=msg)h=1except:h=h+1url = 'http://www.tianque.top/d2api/today/'r = urllib3.PoolManager().request('GET', url)hjson = json.loads(r.data.decode())error_url = hjson["error"]msg="获取日报失败\nerror:\n"+error_urlawait bot.send_group_msg(group_id=group_id, message=msg)except :h=h+1msg="获取日报失败:\n服务器错误"await bot.send_group_msg(group_id=group_id, message=msg)

直接改一下就能用了，是不是很简单（bushi

有参数传入的插件

官方文档：教程

我们在之前一直使用的是@响应器名.handle()
而要接受参数，或者在之后传入参数，或者判断参数格式错误后要求重新输入，就需要其他方法：
receive()和got()

一般使用 got()就够用了

这个插件用了网上查的 BV 转 av 方法：

if AV[0:2] in ["BV"]:table = 'fZodR9XQDSUm21yCkr6zBqiveYah8bt4xsWpHnJE7jL5VG3guMTKNPAwcF'tr = {}for i in range(58):tr[table[i]] = is = [11, 10, 3, 8, 4, 6]xor = 177451812add = 8728348608async def dec(x):r = 0for i in range(6):r += tr[x[s[i]]] * 58 ** ireturn "av" + str((r - add) ^ xor)

用了自己搭的 av 查封面的 api 接口:https://www.kamuxiy.top/demo/bilibiliapi/?AV_number=

from nonebot import on_command
from nonebot.rule import to_me
from nonebot.typing import T_State
from nonebot.adapters import Bot, Event
from nonebot.adapters.cqhttp.message import Messageimport urllib3
import jsonbphoto = on_command("/封面图", priority=5)@bphoto.handle()
async def handle_first_receive(bot: Bot, event: Event, state: T_State):args = str(event.get_message()).strip()  # 首次发送命令时跟随的参数if args:state["AV"] = args  # 如果用户发送了参数则直接赋值@bphoto.got("AV", prompt="你想查询哪个视频的封面图呢？")
async def handle_city(bot: Bot, event: Event, state: T_State):AV = state["AV"]if AV[0:2] not in ["av", "BV"]:await bphoto.reject("你想查询的AV或BV号无法查询，请重新输入！")city_weather = await get_weather(AV)await bphoto.finish(city_weather)async def get_weather(AV: str):try:if AV[0:2] in ["BV"]:table = 'fZodR9XQDSUm21yCkr6zBqiveYah8bt4xsWpHnJE7jL5VG3guMTKNPAwcF'tr = {}for i in range(58):tr[table[i]] = is = [11, 10, 3, 8, 4, 6]xor = 177451812add = 8728348608async def dec(x):r = 0for i in range(6):r += tr[x[s[i]]] * 58 ** ireturn "av" + str((r - add) ^ xor)BV = await dec(AV)url = 'https://www.kamuxiy.top/demo/bilibiliapi/?AV_number=' + BVr = urllib3.PoolManager().request('GET', url)hjson = json.loads(r.data.decode())img_url = hjson['img_url']cq = "[CQ:image,file=" + img_url + ",id=40000]"return f"{AV}的封面图是...\n" + Message(cq)else:url = 'https://www.kamuxiy.top/demo/bilibiliapi/?AV_number=' + AVr = urllib3.PoolManager().request('GET', url)hjson = json.loads(r.data.decode())img_url = hjson['img_url']cq = "[CQ:image,file=" + img_url + ",id=40000]"return f"{AV}的封面图是...\n" + Message(cq)except:return f"{AV}的封面图未找到\n可能是视频不存在" + AV

大概这样
got()可以判断"AV"是否在命令后，没有的话会发送 prompt 内的内容来重新单独获取"AV"
若"AV"已经赋值，便会执行 got()下的代码
其他就是之前讲到的内容了

后记

这篇补了几个最近用学到的内容写的插件，算是边学边用吧
帮隔壁三个地平线 4 群写了一个 annabot，最近也在逐渐完善中，期待一下吧！
目前annabot的菜单

这篇关于nonebot2 插件编写指南（二）（2.0.0a16之前）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/291186。

相关文章

Python+FFmpeg实现视频自动化处理的完整指南

Python+FFmpeg实现视频自动化处理的完整指南

《Python+FFmpeg实现视频自动化处理的完整指南》本文总结了一套在Python中使用subprocess.run调用FFmpeg进行视频自动化处理的解决方案,涵盖了跨平台硬件加速、中间素材处理... 目录一、 跨平台硬件加速：统一接口设计1. 核心映射逻辑2. python 实现代码二、 中间素材处
阅读更多...
Java 队列Queue从原理到实战指南

Java 队列Queue从原理到实战指南

《Java队列Queue从原理到实战指南》本文介绍了Java中队列（Queue）的底层实现、常见方法及其区别,通过LinkedList和ArrayDeque的实现,以及循环队列的概念,展示了如何高效... 目录一、队列的认识队列的底层与集合框架常见的队列方法插入元素方法对比（add和offer）移除元素方法
阅读更多...
Spring Boot基于 JWT 优化 Spring Security 无状态登录实战指南

Spring Boot基于 JWT 优化 Spring Security 无状态登录实战指南

《SpringBoot基于JWT优化SpringSecurity无状态登录实战指南》本文介绍如何使用JWT优化SpringSecurity实现无状态登录,提高接口安全性,并通过实际操作步骤... 目录Spring Boot 实战：基于 JWT 优化 Spring Security 无状态登录一、先搞懂：为什
阅读更多...
Nginx概念、架构、配置与虚拟主机实战操作指南

Nginx概念、架构、配置与虚拟主机实战操作指南

《Nginx概念、架构、配置与虚拟主机实战操作指南》Nginx是一个高性能的HTTP服务器、反向代理服务器、负载均衡器和IMAP/POP3/SMTP代理服务器,它支持高并发连接,资源占用低,功能全面且... 目录Nginx 深度解析：概念、架构、配置与虚拟主机实战一、Nginx 的概念二、Nginx 的特点
阅读更多...
C#实现插入与删除Word文档目录的完整指南

C#实现插入与删除Word文档目录的完整指南

《C#实现插入与删除Word文档目录的完整指南》在日常的办公自动化或文档处理场景中,Word文档的目录扮演着至关重要的角色,本文将深入探讨如何利用强大的第三方库Spire.Docfor.NET,在C#... 目录Spire.Doc for .NET 库：Word 文档处理利器自动化生成：C# 插入 Word
阅读更多...
Python列表去重的9种方法终极指南

Python列表去重的9种方法终极指南

《Python列表去重的9种方法终极指南》在Python开发中,列表去重是一个常见需求,尤其当需要保留元素原始顺序时,本文为大家详细介绍了Python列表去重的9种方法,感兴趣的小伙伴可以了解下... 目录第一章：python列表去重保持顺序方法概述使用字典去重（Python 3.7+）使用集合辅助遍历性能
阅读更多...
在SpringBoot+MyBatis项目中实现MySQL读写分离的实战指南

在SpringBoot+MyBatis项目中实现MySQL读写分离的实战指南

《在SpringBoot+MyBatis项目中实现MySQL读写分离的实战指南》在SpringBoot和MyBatis项目中实现MySQL读写分离,主要有两种思路：一种是在应用层通过代码和配置手动控制... 目录如何选择实现方案核心实现：应用层手动分离实施中的关键问题与解决方案总结在Spring Boot和
阅读更多...
Java JAR 启动内存参数配置指南(从基础设置到性能优化)

Java JAR 启动内存参数配置指南(从基础设置到性能优化)

《JavaJAR启动内存参数配置指南(从基础设置到性能优化)》在启动Java可执行JAR文件时,合理配置JVM内存参数是保障应用稳定性和性能的关键,本文将系统讲解如何通过命令行参数、环境变量等方式... 目录一、核心内存参数详解1.1 堆内存配置1.2 元空间配置（MetASPace）1.3 线程栈配置1.
阅读更多...
交换机救命命令手册! 思科交换机排障命令汇总指南

交换机救命命令手册! 思科交换机排障命令汇总指南

《交换机救命命令手册!思科交换机排障命令汇总指南》在交换机配置与故障排查过程中，总会遇到那些“关键时刻靠得住的命令”，今天我们就来分享一份思科双实战命令手册... 目录1. 基础系统诊断2. 接口与链路诊断3. L2切换排障4. L3路由与转发5. 高级调试与日志6. 性能与QoS7. 安全与DHCP8.
阅读更多...
VS Code中的Python代码格式化插件示例讲解

VS Code中的Python代码格式化插件示例讲解

《VSCode中的Python代码格式化插件示例讲解》在Java开发过程中,代码的规范性和可读性至关重要,一个团队中如果每个开发者的代码风格各异,会给代码的维护、审查和协作带来极大的困难,这篇文章主... 目录前言如何安装与配置使用建议与技巧如何选择总结前言在 VS Code 中，有几款非常出色的 pyt
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2