docs: 更新文档内容,简化语言并修正格式
- 简化插件开发指南中的描述,移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档,删除不准确的数据 - 重构核心概念文档,使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档,简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档,添加参数注入示例 - 优化单例管理器文档的表述
This commit is contained in:
@@ -2,9 +2,9 @@
|
||||
|
||||
写插件很简单,但写出**高性能、不炸裂**的插件需要遵守规矩。
|
||||
|
||||
## 1. 绝对不要阻塞事件循环 (Don't Block the Loop!)
|
||||
## 1. 绝对不要阻塞事件循环。。。
|
||||
|
||||
这是死罪。NEO Bot 是单线程异步架构,如果你在主线程里 `time.sleep(5)`,整个机器人就会卡死 5 秒,谁都别想说话。
|
||||
这是底线。NEO Bot 是单线程异步架构,如果你在主线程里 `time.sleep(5)`,整个机器人就会卡死 5 秒
|
||||
|
||||
* **错误**: `time.sleep(1)`, `requests.get(...)`, 大量 CPU 计算。
|
||||
* **正确**: `await asyncio.sleep(1)`, `await session.get(...)`。
|
||||
@@ -40,23 +40,23 @@ weather = await redis_manager.get("weather:beijing")
|
||||
|
||||
## 4. 类型提示 (Type Hinting)
|
||||
|
||||
我们开启了 Mypyc 编译,这意味着你的代码最好有规范的类型提示。
|
||||
这不仅是为了编译,也是为了让你自己少写 Bug。
|
||||
我开启了 Mypyc 编译,这意味着你的代码最好有规范的类型提示。
|
||||
这不仅是为了编译,也是为了让你自己少写 Bug
|
||||
|
||||
```python
|
||||
# 好的写法
|
||||
async def handle(event: MessageEvent, args: list[str]) -> None:
|
||||
...
|
||||
|
||||
# 烂写法
|
||||
# 不好写法
|
||||
async def handle(event, args):
|
||||
...
|
||||
```
|
||||
|
||||
## 5. 异常处理
|
||||
|
||||
别让你的插件因为一个报错就搞崩整个机器人。
|
||||
虽然框架层有捕获机制,但你自己处理好异常是基本素养。
|
||||
别让你的插件因为一个报错就崩溃机器人
|
||||
虽然框架层有捕获机制,但你自己处理好异常是最好的。。。
|
||||
|
||||
```python
|
||||
try:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# 指令处理与参数解析
|
||||
|
||||
光会 `event.reply()` 只能写玩具。正经的插件,都得和用户传进来的参数打交道。
|
||||
光会 `event.reply()` 只能写小插件。。。认识一下其他的方法吧
|
||||
|
||||
## 1. 获取原始参数
|
||||
|
||||
@@ -15,7 +15,7 @@ async def handle_echo(event: MessageEvent, args: str):
|
||||
# 如果用户发送 /echo hello world
|
||||
# args 的值就是 "hello world"
|
||||
if not args:
|
||||
await event.reply("你啥也没说啊。")
|
||||
await event.reply("你啥也没说啊")
|
||||
else:
|
||||
await event.reply(f"你说了:{args}")
|
||||
```
|
||||
@@ -26,7 +26,7 @@ async def handle_echo(event: MessageEvent, args: str):
|
||||
|
||||
一整坨字符串用起来太费劲了,还得自己 `split()`。框架提供了更高级的玩法:**参数自动解析**。
|
||||
|
||||
你只需要在函数签名里,用类型提示声明你想要的参数,框架会像 FastAPI 一样,自动帮你解析和注入。
|
||||
你只需要在函数签名里,用类型提示声明你想要的参数,框架会动帮你解析和注入。
|
||||
|
||||
### a. 基础用法
|
||||
|
||||
@@ -85,6 +85,53 @@ async def handle_say(event: MessageEvent, target_user: str, content: str = ...):
|
||||
await event.reply(f"正在对 {target_user} 说:{content}")
|
||||
```
|
||||
|
||||
## 3. 更复杂的解析:依赖注入
|
||||
## 3. 智能的参数注入
|
||||
|
||||
如果你的参数不是简单的 `int` 或 `str`,或者你需要更复杂的解析逻辑(比如 `@某人`),请参考 `FastAPI` 的依赖注入系统,我们用了同一套逻辑。
|
||||
除了 `args` 列表,命令处理器还可以自动接收一些非常有用的上下文对象。框架底层使用了 Python 的 `inspect` 模块来分析你函数的参数签名,并自动“注入”你需要的对象。
|
||||
|
||||
这是一种轻量级的**依赖注入**,让你的代码更简洁、更易于测试。
|
||||
|
||||
### 可用的参数
|
||||
|
||||
你可以在命令处理函数的参数中声明以下任意名称,框架会自动为你传入:
|
||||
|
||||
| 参数名 | 类型 | 描述 |
|
||||
| ------------------- | -------------------------------- | ---------------------------------------- |
|
||||
| `bot` | `Bot` | 当前的 Bot 实例,用于调用 API 发送消息等。 |
|
||||
| `event` | `MessageEvent` (或其子类) | 触发该命令的完整消息事件对象。 |
|
||||
| `args` | `List[str]` | 和之前一样,包含命令参数的字符串列表。 |
|
||||
| `permission_granted`| `bool` | 指示当前用户是否通过了权限检查。 |
|
||||
|
||||
### 示例
|
||||
|
||||
假设我们想写一个“回声”命令,但只在用户拥有管理员权限时才重复他们的消息。
|
||||
|
||||
```python
|
||||
# plugins/echo_plus.py
|
||||
from core.bot import Bot
|
||||
from core.permission import ADMIN
|
||||
from models.events.message import MessageEvent
|
||||
from core.managers.command_manager import matcher
|
||||
|
||||
@matcher.command("echo_plus", permission=ADMIN)
|
||||
async def echo_plus(bot: Bot, event: MessageEvent, args: list[str], permission_granted: bool):
|
||||
"""
|
||||
一个更强大的回声命令
|
||||
"""
|
||||
# 只有当 permission_granted 为 True 时,代码才会执行到这里
|
||||
# 因为框架会自动处理权限拒绝的情况
|
||||
|
||||
if not args:
|
||||
await bot.send(event, "你想要我复述什么呢?")
|
||||
return
|
||||
|
||||
# 我们可以从 event 对象中获取更详细的信息
|
||||
user_id = event.user_id
|
||||
message_to_echo = " ".join(args)
|
||||
|
||||
response = f"管理员 {user_id} 说:{message_to_echo}"
|
||||
await bot.send(event, response)
|
||||
|
||||
```
|
||||
|
||||
在这个例子中,我们没有手动检查权限。我们只是在 `@matcher.command` 中声明了 `permission=ADMIN`,然后在函数参数中请求了 `permission_granted: bool`。框架会自动完成权限检查,如果失败,甚至不会执行我们的函数,并会发送一条权限不足的消息。这就是依赖注入的强大之处。
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# 插件开发入门
|
||||
|
||||
写插件是给 NEO Bot 添加功能的唯一方式。这玩意儿很简单,一个 Python 文件就是一个插件。
|
||||
写插件是给 NEO Bot 添加功能的唯一方式,一个 Python 文件就是一个插件。(或者一个文件夹里边有__init__.py)
|
||||
|
||||
## 1. 创建你的第一个插件
|
||||
|
||||
@@ -35,8 +35,6 @@ async def handle_hello(event: MessageEvent):
|
||||
|
||||
不用你动手,NEO Bot 启动时会自动加载 `plugins/` 目录下的所有 `.py` 文件。
|
||||
|
||||
如果你是在 Bot 运行时新增或修改了插件,只需要在控制台输入 `reload` 命令,或者让管理员在群里发 `/reload`,就能热重载所有插件。
|
||||
|
||||
## 3. 测试插件
|
||||
|
||||
现在,去群里或者私聊给 Bot 发送:
|
||||
|
||||
Reference in New Issue
Block a user