nonebot2 插件编写指南(二)(2.0.0a16之前)

2023-10-28 05:59

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

nb2 插件编写指南(二)

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


这篇文章要点:

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

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

1.NoneBot.adapters 使用

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

await bot.send(发送内容)

这个使用的是NoneBot.adapters.cqhttpsend(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正则表达式匹配和替换的操作指南

《Python正则表达式匹配和替换的操作指南》正则表达式是处理文本的强大工具,Python通过re模块提供了完整的正则表达式功能,本文将通过代码示例详细介绍Python中的正则匹配和替换操作,需要的朋... 目录基础语法导入re模块基本元字符常用匹配方法1. re.match() - 从字符串开头匹配2.

JavaScript中的高级调试方法全攻略指南

《JavaScript中的高级调试方法全攻略指南》什么是高级JavaScript调试技巧,它比console.log有何优势,如何使用断点调试定位问题,通过本文,我们将深入解答这些问题,带您从理论到实... 目录观点与案例结合观点1观点2观点3观点4观点5高级调试技巧详解实战案例断点调试:定位变量错误性能分

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java

Python实现精确小数计算的完全指南

《Python实现精确小数计算的完全指南》在金融计算、科学实验和工程领域,浮点数精度问题一直是开发者面临的重大挑战,本文将深入解析Python精确小数计算技术体系,感兴趣的小伙伴可以了解一下... 目录引言:小数精度问题的核心挑战一、浮点数精度问题分析1.1 浮点数精度陷阱1.2 浮点数误差来源二、基础解决

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java:高效Word文档处理的利器代码实战:使用Java为Wo

从入门到精通详解Python虚拟环境完全指南

《从入门到精通详解Python虚拟环境完全指南》Python虚拟环境是一个独立的Python运行环境,它允许你为不同的项目创建隔离的Python环境,下面小编就来和大家详细介绍一下吧... 目录什么是python虚拟环境一、使用venv创建和管理虚拟环境1.1 创建虚拟环境1.2 激活虚拟环境1.3 验证虚

RabbitMQ 延时队列插件安装与使用示例详解(基于 Delayed Message Plugin)

《RabbitMQ延时队列插件安装与使用示例详解(基于DelayedMessagePlugin)》本文详解RabbitMQ通过安装rabbitmq_delayed_message_exchan... 目录 一、什么是 RabbitMQ 延时队列? 二、安装前准备✅ RabbitMQ 环境要求 三、安装延时队

从基础到高级详解Python数值格式化输出的完全指南

《从基础到高级详解Python数值格式化输出的完全指南》在数据分析、金融计算和科学报告领域,数值格式化是提升可读性和专业性的关键技术,本文将深入解析Python中数值格式化输出的相关方法,感兴趣的小伙... 目录引言:数值格式化的核心价值一、基础格式化方法1.1 三种核心格式化方式对比1.2 基础格式化示例

sysmain服务可以禁用吗? 电脑sysmain服务关闭后的影响与操作指南

《sysmain服务可以禁用吗?电脑sysmain服务关闭后的影响与操作指南》在Windows系统中,SysMain服务(原名Superfetch)作为一个旨在提升系统性能的关键组件,一直备受用户关... 在使用 Windows 系统时,有时候真有点像在「开盲盒」。全新安装系统后的「默认设置」,往往并不尽编

Python ORM神器之SQLAlchemy基本使用完全指南

《PythonORM神器之SQLAlchemy基本使用完全指南》SQLAlchemy是Python主流ORM框架,通过对象化方式简化数据库操作,支持多数据库,提供引擎、会话、模型等核心组件,实现事务... 目录一、什么是SQLAlchemy?二、安装SQLAlchemy三、核心概念1. Engine(引擎)