ElapsingDreams/LiteyukiBot
1
0
Fork 0
forked from bot/app
Code Pull Requests Activity

📝 添加轻雪插件编写的一些注释

Browse Source
This commit is contained in:
远野千束 2024-08-12 06:07:01 +08:00
parent 47ef3f2a49
commit 3cb03fa4dc
2 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/dev/dev_comm.md
View File

@ -25,12 +25,14 @@ import asyncio
from liteyuki.comm import get_channel, Channel from liteyuki.comm import get_channel, Channel
from liteyuki import get_bot from liteyuki import get_bot
# get_channel函数获取通道对象，参数为调用set_channel时的通道标识
channel_passive = get_channel("nonebot-passive") # 每个进程只能获取在当前进程通过set_channel设置的通道
channel_active = get_channel("nonebot-active") # 轻雪已经在创建进程时把每个通道都传递给了主进程和子进程，以便在哪个进程都可以被获取
channel_passive = get_channel("nonebot-passive") # 获取被动通道
channel_active = get_channel("nonebot-active") # 获取主动通道
liteyuki_bot = get_bot() liteyuki_bot = get_bot()
# 注册一个函数在轻雪启动后运行
@liteyuki_bot.on_after_start @liteyuki_bot.on_after_start
async def do_something_after_start(): async def do_something_after_start():
while True: while True:
@ -49,15 +51,17 @@ from liteyuki.log import logger
driver = get_driver() driver = get_driver()
# 通过get_channel函数获取通道对象，参数为调用set_channel时的通道标识
channel_passive = get_channel("nonebot-passive") channel_passive = get_channel("nonebot-passive")
channel_active = get_channel("nonebot-active") channel_active = get_channel("nonebot-active")
# 被动模式，通过装饰器注册一个函数在接收到消息时运行，每次接收到字符串数据时都会运行
@channel_passive.on_receive() @channel_passive.on_receive(filter_func=lambda data: isinstance(data, str))
async def on_passive_receive(data): async def on_passive_receive(data):
logger.info(f"Passive receive: {data}") logger.info(f"Passive receive: {data}")
# 注册一个函数在NoneBot启动后运行
@driver.on_startup @driver.on_startup
async def on_startup(): async def on_startup():
while True: while True:

25
docs/dev/dev_lyplugin.md
View File

@ -16,18 +16,20 @@ category: 开发
在标准项目中，位于liteyuki/plugins和src/liteyuki_plugins下的Python modules均会被当作插件加载，你可自行添加配置文件以指定插件的加载路径 在标准项目中，位于liteyuki/plugins和src/liteyuki_plugins下的Python modules均会被当作插件加载，你可自行添加配置文件以指定插件的加载路径
一个`.py`文件或一个包含`__init__.py`的文件夹即可被识别为插件 一个`.py`文件或一个包含`__init__.py`的文件夹即可被识别为插件
创建一个文件夹，例如`my_plugin`，并在其中创建一个`__init__.py`文件，即可创建一个插件 创建一个文件夹，例如`watchdog_plugin`，并在其中创建一个`__init__.py`文件，即可创建一个插件
```python ```python
from liteyuki.plugin import PluginMetadata from liteyuki.plugin import PluginMetadata
# 定义插件元数据，推荐填写
__plugin_meta__ = PluginMetadata( __plugin_meta__ = PluginMetadata(
name="My Plugin", name="NoneDog", # 插件名称
version="1.0.0", version="1.0.0", # 插件版本
description="A simple plugin" description="A simple plugin for nonebot developer" # 插件描述
) )
# 你的插件代码 # 你的插件代码
...
``` ```
### 编写逻辑部分 ### 编写逻辑部分
@ -36,13 +38,14 @@ __plugin_meta__ = PluginMetadata(
以下我们会编写一个简单的插件，用于开发NoneBot时进行文件系统变更重载 以下我们会编写一个简单的插件，用于开发NoneBot时进行文件系统变更重载
```python ```python
from liteyuki.dev import observer import os
from liteyuki import get_bot, logger from liteyuki.dev import observer # 导入文件系统观察器
from watchdog.events import FileSystemEvent from liteyuki import get_bot, logger # 导入轻雪Bot和日志
from watchdog.events import FileSystemEvent # 导入文件系统事件
liteyuki = get_bot() liteyuki = get_bot() # 获取唯一的轻雪Bot实例
exclude_extensions = (".pyc", ".pyo") exclude_extensions = (".pyc", ".pyo") # 排除的文件扩展名
# 用observer的on_file_system_event装饰器监听文件系统事件 # 用observer的on_file_system_event装饰器监听文件系统事件
@ -52,9 +55,9 @@ exclude_extensions = (".pyc", ".pyo")
) )
def restart_nonebot_process(event: FileSystemEvent): def restart_nonebot_process(event: FileSystemEvent):
logger.debug(f"File {event.src_path} changed, reloading nonebot...") logger.debug(f"File {event.src_path} changed, reloading nonebot...")
liteyuki.restart_process("nonebot") liteyuki.restart_process("nonebot") # 调用重启进程方法
``` ```
### 加载插件 ### 加载插件
在配置文件中的`liteyuki.plugins`中添加你的插件路径，例如`my_plugin`，重启轻雪即可加载插件。然后我们在src/nonebot_plugins下创建一个文件，例如`test.py`，并在其中写入一些代码，保存后轻雪会自动重载NoneBot进程 在配置文件中的`liteyuki.plugins`中添加你的插件路径，例如`watchdog_plugin`，重启轻雪即可加载插件。然后我们在src/nonebot_plugins下创建一个文件，例如`test.py`，并在其中写入一些代码，保存后轻雪会自动重载NoneBot进程