From cd8d631348ac6f02ad7ed4f74a3a393b6907c836 Mon Sep 17 00:00:00 2001 From: snowy Date: Sun, 18 Aug 2024 23:52:26 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20=E6=B7=BB=E5=8A=A0=E5=BF=AB=E9=80=9F?= =?UTF-8?q?=E5=90=AF=E5=8A=A8=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/dev/dev_lyplugin.md | 51 +++++++++++++++++++++++++++------------- 1 file changed, 35 insertions(+), 16 deletions(-) diff --git a/docs/dev/dev_lyplugin.md b/docs/dev/dev_lyplugin.md index b80e6883..1c3761d4 100644 --- a/docs/dev/dev_lyplugin.md +++ b/docs/dev/dev_lyplugin.md @@ -5,7 +5,6 @@ order: 3 category: 开发 --- - ## 简介 轻雪插件是轻雪内置的一部分功能，运行在主进程中，可以很高程度地扩展轻雪的功能 @@ -14,18 +13,21 @@ category: 开发 ### 创建插件 -在标准项目中，位于liteyuki/plugins和src/liteyuki_plugins下的Python modules均会被当作插件加载，你可自行添加配置文件以指定插件的加载路径 一个`.py`文件或一个包含`__init__.py`的文件夹即可被识别为插件 -创建一个文件夹，例如`watchdog_plugin`，并在其中创建一个`__init__.py`文件，即可创建一个插件 +首先创建一个文件夹，例如`watchdog_plugin`，并在其中创建一个`__init__.py`文件，即可创建一个插件 + +`__init__.py` ```python -from liteyuki.plugin import PluginMetadata +from liteyuki.plugin import PluginMetadata, PluginType +from .watch_dog import * # 导入逻辑部分 -# 定义插件元数据，推荐填写 +# 定义插件元数据 __plugin_meta__ = PluginMetadata( - name="NoneDog", # 插件名称 - version="1.0.0", # 插件版本 - description="A simple plugin for nonebot developer" # 插件描述 + name="NoneDog", # 插件名称 + version="1.0.0", # 插件版本 + description="A simple plugin for nonebot developer", # 插件描述 + type=PluginType.SERVICE # 插件类型 ) # 你的插件代码 @@ -36,16 +38,16 @@ __plugin_meta__ = PluginMetadata( 轻雪主进程不涉及聊天部分，因此插件主要是一些后台任务或者与聊天机器人的通信 以下我们会编写一个简单的插件，用于开发NoneBot时进行文件系统变更重载 - +`watch_dog.py` ```python import os -from liteyuki.dev import observer # 导入文件系统观察器 -from liteyuki import get_bot, logger # 导入轻雪Bot和日志 -from watchdog.events import FileSystemEvent # 导入文件系统事件 +from liteyuki.dev import observer # 导入文件系统观察器 +from liteyuki import get_bot, logger # 导入轻雪Bot和日志 +from watchdog.events import FileSystemEvent # 导入文件系统事件 -liteyuki = get_bot() # 获取唯一的轻雪Bot实例 +liteyuki = get_bot() # 获取唯一的轻雪Bot实例 -exclude_extensions = (".pyc", ".pyo") # 排除的文件扩展名 +exclude_extensions = (".pyc", ".pyo") # 排除的文件扩展名 # 用observer的on_file_system_event装饰器监听文件系统事件 @@ -55,9 +57,26 @@ exclude_extensions = (".pyc", ".pyo") # 排除的文件扩展名 ) def restart_nonebot_process(event: FileSystemEvent): logger.debug(f"File {event.src_path} changed, reloading nonebot...") - liteyuki.restart_process("nonebot") # 调用重启进程方法 + liteyuki.restart_process("nonebot") # 调用重启进程方法 ``` ### 加载插件 -在配置文件中的`liteyuki.plugins`中添加你的插件路径，例如`watchdog_plugin`，重启轻雪即可加载插件。然后我们在src/nonebot_plugins下创建一个文件，例如`test.py`，并在其中写入一些代码，保存后轻雪会自动重载NoneBot进程 \ No newline at end of file +#### 方法1 + +- 在配置文件中的`liteyuki.plugins`中添加你的插件路径，例如`watchdog_plugin`，重启轻雪即可加载插件。 + +#### 方法2 + +- 使用开发工具快速运行插件，无需手动创建实例 +- 创建入口文件，例如`main.py`，并在其中写入以下代码 + +```python +from liteyuki.dev.plugin import run_plugins + +run_plugins("watchdog_plugin") +``` + +然后运行`python main.py`即可启动插件 + +启用插件后，我们在src/nonebot_plugins下创建一个文件，例如`test.py`，并在其中写入一些代码，保存后轻雪会自动重载NoneBot进程 \ No newline at end of file