深度学习项目实践——QQ聊天机器人(transformer)(三)功能实现的方法——NoneBot2插件结构与编写

本文主要是介绍深度学习项目实践——QQ聊天机器人(transformer)(三)功能实现的方法——NoneBot2插件结构与编写,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

深度学习项目实践——QQ聊天机器人(transformer)(三)功能实现的方法——NoneBot2插件结构与编写

在前两节中,我们详细讲解了QQ聊天的原理、QQ机器人的框架与环境配置的流程。本节将重点介绍NoneBot2的插件构成,以及如何从零开始编写一个属于自己的插件。这一篇文章主要就是充当搬运工,参考了nonebot2的官方文档

第一步:了解NoneBot2的架构

在开始编写插件之前,我们先来了解一下NoneBot2的基本架构和构成。

1. NoneBot2的基本架构

NoneBot2 是一个基于Python的插件化机器人框架,具有高度扩展性和灵活性。它的架构主要由以下几个核心部分组成:

  • 机器人主体(Bot): 这是整个系统的核心,负责管理和协调插件的运行。它可以被看作是一个大脑,控制着整个机器人的逻辑流。

  • 驱动器(Driver): 驱动器负责与外部世界进行通信,例如与QQ服务器建立连接、发送和接收消息等。NoneBot2 支持多种驱动器,常见的有 FastAPI 和 WebSocket。

  • 适配器(Adapter): 适配器用来将不同平台的消息格式转化为NoneBot2可以理解的标准格式。适配器决定了机器人支持的平台,如QQ、Telegram等。

  • 插件(Plugin): 插件是NoneBot2的灵魂,几乎所有的功能都由插件实现。你可以通过编写插件来扩展机器人的能力,比如实现关键词回复、自动化任务等。

2. NoneBot2 项目的基本构成

一个典型的NoneBot2项目由以下几个文件和文件夹组成:

  • bot.py: 这是NoneBot2机器人的入口文件,负责启动整个机器人。
  • plugins/: 这是存放所有插件的文件夹,每个插件都是一个独立的Python文件或模块。
  • config.py: 配置文件,用于设置机器人的相关配置,如日志级别、插件加载选项等。

了解了这些基本构成之后,我们就可以开始编写插件了。

第二步:编写自己的NoneBot2插件

编写插件是NoneBot2开发中最有趣的部分,它允许你根据自己的需求为机器人添加各种功能。下面我们通过一个简单的例子,展示如何编写一个插件。

插件编写准备

在正式编写插件之前,我们需要先了解一下插件的概念和结构。

插件结构

在 NoneBot 中,插件即是 Python 的一个模块(module)。NoneBot 会在导入时对这些模块做一些特殊的处理,使得它们成为一个插件。插件间应尽量减少耦合,可以进行有限制的相互调用,NoneBot 能够正确解析插件间的依赖关系。

单文件插件

一个普通的 .py 文件即可以作为一个插件,例如创建一个 foo.py 文件:

Project
📂 plugins
└── 📜 foo.py

这个时候模块 foo 已经可以被称为一个插件了,尽管它还什么都没做。

包插件

一个包含 __init__.py 的文件夹即是一个常规的 Python 包(package),例如创建一个 foo 文件夹:

Project
📂 plugins
└── 📂 foo└── 📜 __init__.py

这个时候包 foo 同样是一个合法的插件,插件内容可以在 __init__.py 文件中编写。

创建插件

项目结构调整

如果在之前的快速上手章节中已经使用 bootstrap 模板创建了项目,那么你需要做出如下修改:

  1. 在项目目录中创建一个两层文件夹 qqbot/plugins
Project
📦 qqbot
├── 📂 qqbot
│   └── 📂 plugins
├── 📜 pyproject.toml
└── 📜 README.md
  1. 修改 pyproject.toml 文件中的 nonebot 配置项,在 plugin_dirs 中添加 qqbot/plugins
[tool.nonebot]
plugin_dirs = ["qqbot/plugins"]

加载插件

如果你使用自定义的入口文件 bot.py,那么你需要在 bot.py 中加载插件:

import nonebotnonebot.init()# 加载插件
nonebot.load_builtin_plugins("echo")  # 内置插件
nonebot.load_plugins("qqbot/plugins")  # 本地插件nonebot.run()

使用 nb-cli 创建插件

创建插件可以通过 nb-cli 命令从完整模板创建,也可以手动新建空白文件。通过以下命令创建一个名为 weather 的插件:

$ nb plugin create
[?] 插件名称: weather
[?] 使用嵌套插件? (y/N) N
[?] 输出目录: qqbot/plugins

nb-cli 会在 qqbot/plugins 目录下创建一个名为 weather 的文件夹,其中包含的文件将在稍后章节中用到。

Project
📦 qqbot
├── 📂 qqbot
│   └── 📂 plugins
│       └── 📂 weather
│           ├── 📜 __init__.py
│           └── 📜 config.py
├── 📜 pyproject.toml
└── 📜 README.md

加载插件的方式

加载插件是在机器人入口文件中完成的,需要在框架初始化之后,运行之前进行。以下是为加载插件提供的几种方式:

load_plugin

通过点分割模块名称或使用 pathlibPath 对象来加载插件。通常用于加载第三方插件或者项目插件。例如:

from pathlib import Pathnonebot.load_plugin("path.to.your.plugin")  # 加载第三方插件
nonebot.load_plugin(Path("./qqbot/plugins/weather.py"))  # 加载项目插件

load_plugins

加载传入插件目录中的所有插件,通常用于加载一系列本地编写的项目插件。例如:

nonebot.load_plugins("qqbot/plugins", "path/to/your/plugins")

load_all_plugins

这种加载方式是以上两种方式的混合,加载所有传入的插件模块名称,以及所有给定目录下的插件。例如:

nonebot.load_all_plugins(["path.to.your.plugin"], ["qqbot/plugins"])

load_from_json

通过 JSON 文件加载插件,是 load_all_plugins 的 JSON 变种。通过读取 JSON 文件中的 plugins 字段和 plugin_dirs 字段进行加载。例如:

{"plugins": ["path.to.your.plugin"],"plugin_dirs": ["qqbot/plugins"]
}
nonebot.load_from_json("plugin_config.json", encoding="utf-8")

load_from_toml

通过 TOML 文件加载插件,是 load_all_plugins 的 TOML 变种。通过读取 TOML 文件中的 [tool.nonebot] 表中的 pluginsplugin_dirs 数组进行加载。例如:

[tool.nonebot]
plugins = ["path.to.your.plugin"]
plugin_dirs = ["qqbot/plugins"]
nonebot.load_from_toml("plugin_config.toml", encoding="utf-8")

load_builtin_plugin

加载一个内置插件,传入的插件名必须为 NoneBot 内置插件。该方法是 load_plugin 的封装。例如:

nonebot.load_builtin_plugin("echo")

load_builtin_plugins

加载传入插件列表中的所有内置插件。例如:

nonebot.load_builtin_plugins("echo", "single_session")

这篇关于深度学习项目实践——QQ聊天机器人(transformer)(三)功能实现的方法——NoneBot2插件结构与编写的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1128212

相关文章

Python如何使用__slots__实现节省内存和性能优化

《Python如何使用__slots__实现节省内存和性能优化》你有想过,一个小小的__slots__能让你的Python类内存消耗直接减半吗,没错,今天咱们要聊的就是这个让人眼前一亮的技巧,感兴趣的... 目录背景:内存吃得满满的类__slots__:你的内存管理小助手举个大概的例子:看看效果如何?1.

Python+PyQt5实现多屏幕协同播放功能

《Python+PyQt5实现多屏幕协同播放功能》在现代会议展示、数字广告、展览展示等场景中,多屏幕协同播放已成为刚需,下面我们就来看看如何利用Python和PyQt5开发一套功能强大的跨屏播控系统吧... 目录一、项目概述:突破传统播放限制二、核心技术解析2.1 多屏管理机制2.2 播放引擎设计2.3 专

一文详解SpringBoot响应压缩功能的配置与优化

《一文详解SpringBoot响应压缩功能的配置与优化》SpringBoot的响应压缩功能基于智能协商机制,需同时满足很多条件,本文主要为大家详细介绍了SpringBoot响应压缩功能的配置与优化,需... 目录一、核心工作机制1.1 自动协商触发条件1.2 压缩处理流程二、配置方案详解2.1 基础YAML

Python实现无痛修改第三方库源码的方法详解

《Python实现无痛修改第三方库源码的方法详解》很多时候,我们下载的第三方库是不会有需求不满足的情况,但也有极少的情况,第三方库没有兼顾到需求,本文将介绍几个修改源码的操作,大家可以根据需求进行选择... 目录需求不符合模拟示例 1. 修改源文件2. 继承修改3. 猴子补丁4. 追踪局部变量需求不符合很

一文教你如何将maven项目转成web项目

《一文教你如何将maven项目转成web项目》在软件开发过程中,有时我们需要将一个普通的Maven项目转换为Web项目,以便能够部署到Web容器中运行,本文将详细介绍如何通过简单的步骤完成这一转换过程... 目录准备工作步骤一:修改​​pom.XML​​1.1 添加​​packaging​​标签1.2 添加

idea中创建新类时自动添加注释的实现

《idea中创建新类时自动添加注释的实现》在每次使用idea创建一个新类时,过了一段时间发现看不懂这个类是用来干嘛的,为了解决这个问题,我们可以设置在创建一个新类时自动添加注释,帮助我们理解这个类的用... 目录前言:详细操作:步骤一:点击上方的 文件(File),点击&nbmyHIgsp;设置(Setti

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.

mysql出现ERROR 2003 (HY000): Can‘t connect to MySQL server on ‘localhost‘ (10061)的解决方法

《mysql出现ERROR2003(HY000):Can‘tconnecttoMySQLserveron‘localhost‘(10061)的解决方法》本文主要介绍了mysql出现... 目录前言:第一步:第二步:第三步:总结:前言:当你想通过命令窗口想打开mysql时候发现提http://www.cpp

MySQL大表数据的分区与分库分表的实现

《MySQL大表数据的分区与分库分表的实现》数据库的分区和分库分表是两种常用的技术方案,本文主要介绍了MySQL大表数据的分区与分库分表的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有... 目录1. mysql大表数据的分区1.1 什么是分区?1.2 分区的类型1.3 分区的优点1.4 分

一文详解如何从零构建Spring Boot Starter并实现整合

《一文详解如何从零构建SpringBootStarter并实现整合》SpringBoot是一个开源的Java基础框架,用于创建独立、生产级的基于Spring框架的应用程序,:本文主要介绍如何从... 目录一、Spring Boot Starter的核心价值二、Starter项目创建全流程2.1 项目初始化(