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。

相关文章

使用JavaScript将PDF页面中的标注扁平化的操作指南

使用JavaScript将PDF页面中的标注扁平化的操作指南

《使用JavaScript将PDF页面中的标注扁平化的操作指南》扁平化(flatten)操作可以将标注作为矢量图形包含在PDF页面的内容中,使其不可编辑,DynamsoftDocumentViewer... 目录使用Dynamsoft Document Viewer打开一个PDF文件并启用标注添加功能扁平化
阅读更多...
电脑显示hdmi无信号怎么办? 电脑显示器无信号的终极解决指南

电脑显示hdmi无信号怎么办? 电脑显示器无信号的终极解决指南

《电脑显示hdmi无信号怎么办?电脑显示器无信号的终极解决指南》HDMI无信号的问题却让人头疼不已，遇到这种情况该怎么办？针对这种情况，我们可以采取一系列步骤来逐一排查并解决问题，以下是详细的方法... 无论你是试图为笔记本电脑设置多个显示器还是使用外部显示器，都可能会弹出“无HDMI信号”错误。此消息可能
阅读更多...
如何安装 Ubuntu 24.04 LTS 桌面版或服务器? Ubuntu安装指南

如何安装 Ubuntu 24.04 LTS 桌面版或服务器? Ubuntu安装指南

《如何安装Ubuntu24.04LTS桌面版或服务器?Ubuntu安装指南》对于我们程序员来说，有一个好用的操作系统、好的编程环境也是很重要，如何安装Ubuntu24.04LTS桌面... Ubuntu 24.04 LTS，代号 Noble NumBAT，于 2024 年 4 月 25 日正式发布，引入了众
阅读更多...
IDEA常用插件之代码扫描SonarLint详解

IDEA常用插件之代码扫描SonarLint详解

《IDEA常用插件之代码扫描SonarLint详解》SonarLint是一款用于代码扫描的插件,可以帮助查找隐藏的bug,下载并安装插件后,右键点击项目并选择“Analyze”、“Analyzewit... 目录SonajavascriptrLint 查找隐藏的bug下载安装插件扫描代码查看结果总结Sona
阅读更多...
使用Java编写一个文件批量重命名工具

使用Java编写一个文件批量重命名工具

《使用Java编写一个文件批量重命名工具》这篇文章主要为大家详细介绍了如何使用Java编写一个文件批量重命名工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录背景处理1. 文件夹检查与遍历2. 批量重命名3. 输出配置代码片段完整代码背景在开发移动应用时，UI设计通常会提供不
阅读更多...
Retrieval-based-Voice-Conversion-WebUI模型构建指南

Retrieval-based-Voice-Conversion-WebUI模型构建指南

一、模型介绍 Retrieval-based-Voice-Conversion-WebUI（简称 RVC）模型是一个基于 VITS（Variational Inference with adversarial learning for end-to-end Text-to-Speech）的简单易用的语音转换框架。 具有以下特点 简单易用：RVC 模型通过简单易用的网页界面，使得用户无需深入了
阅读更多...
Java 创建图形用户界面（GUI）入门指南（Swing库 JFrame 类）概述

Java 创建图形用户界面（GUI）入门指南（Swing库 JFrame 类）概述

概述 基本概念 Java Swing 的架构 Java Swing 是一个为 Java 设计的 GUI 工具包，是 JAVA 基础类的一部分，基于 Java AWT 构建，提供了一系列轻量级、可定制的图形用户界面（GUI）组件。 与 AWT 相比，Swing 提供了许多比 AWT 更好的屏幕显示元素，更加灵活和可定制，具有更好的跨平台性能。 组件和容器 Java Swing 提供了许多
阅读更多...
基于UE5和ROS2的激光雷达+深度RGBD相机小车的仿真指南(五)：Blender锥桶建模

基于UE5和ROS2的激光雷达+深度RGBD相机小车的仿真指南(五)：Blender锥桶建模

前言 本系列教程旨在使用UE5配置一个具备激光雷达+深度摄像机的仿真小车，并使用通过跨平台的方式进行ROS2和UE5仿真的通讯，达到小车自主导航的目的。本教程默认有ROS2导航及其gazebo仿真相关方面基础，Nav2相关的学习教程可以参考本人的其他博客Nav2代价地图实现和原理–Nav2源码解读之CostMap2D(上)-CSDN博客往期教程： 第一期：基于UE5和ROS2的激光雷达+深度RG
阅读更多...
如何编写Linux PCIe设备驱动器 之二

如何编写Linux PCIe设备驱动器 之二

如何编写Linux PCIe设备驱动器 之二 功能(capability)集功能(capability)APIs通过pci_bus_read_config完成功能存取功能APIs参数pos常量值PCI功能结构 PCI功能IDMSI功能电源功率管理功能 功能(capability)集 功能(capability)APIs int pcie_capability_read_wo
阅读更多...
Maven(插件配置和生命周期的绑定)

Maven(插件配置和生命周期的绑定)

1.这篇文章很好，介绍的maven插件的。 2.maven的source插件为例，可以把源代码打成包。 Goals Overview就可以查看该插件下面所有的目标。 这里我们要使用的是source:jar-no-fork。 3.查看source插件的example，然后配置到riil-collect.xml中。  <build>   <plugins>    <pl
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2