ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-07-28 00:31:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

完善文档、清理垃圾、添加 Travis CI 配置文件

Browse Source
This commit is contained in:
Richard Chien
2017-01-14 16:14:40 +08:00
parent 357430c85f
commit 52b74daa38
8 changed files with 112 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/Write_Filter.md
View File

@ -1,13 +1,15 @@
# 编写过滤器
`filters` 目录中所有不以 `_` 开头的 `.py` 文件会被加载进程序，一般把过滤器放在这个目录里。对于临时不需要的过滤器，可以通过在文件名前加 `_` 来屏蔽掉。
## 写法
编写过滤器比较简单，只需要调用 `filter.py` 中的 `add_filter` 函数，传入过滤器函数和优先级，即可。
编写过滤器比较简单，只需要调用 `filter.py` 中的 `add_filter` 函数或 `as_filter` 装饰器，传入过滤器函数和优先级，即可。
比如我们需要做一个消息拦截器，当匹配到消息中有不文明词汇，就发送一条警告，并拦截消息不让后续过滤器和命令处理，代码可能如下：
```python
from filter import add_filter
from filter import add_filter, as_filter
from commands import core
@ -17,8 +19,16 @@ def _interceptor(ctx_msg):
return False
return True
add_filter(_interceptor, priority=100)
add_filter(_interceptor, 100)
# 或下面这样
@as_filter(priority=100)
def _interceptor(ctx_msg):
if 'xxx' in ctx_msg.get('content', ''):
core.echo('请不要说脏话', ctx_msg)
return False
return True
```
一般建议优先级设置为 0～100 之间。
@ -27,14 +37,11 @@ add_filter(_interceptor, 100)
## 现有的几个重要过滤器
### 消息日志过滤器
此过滤器用于把收到的消息打印在标准输出，在 `filters/message_logger_1000.py` 中定义，优先级 1000，一般不建议添加其它优先级比它高的过滤器，以确保日志不受任何干扰。
### 分离@开头过滤器
用于分离群组和讨论组中消息开头的 `@CCZU 小开`，优先级 50，在 `filters/split_at_xiaokai_50.py` 中定义。通过此过滤器的消息的 `content` 字段会被更新为分离掉开头的剩余部分，也就是说通过此过滤器的消息，就是确定用户的意图就是和这个 bot 说话的消息。
### 命令分发过滤器
用于处理消息中的命令，优先级 0，在 `filters/command_dispatcher_0.py` 中定义。
| 文件 | 优先级 | 作用 | 备注 |
| ------------------------------------- | ----- | ---------------------------------------- | -------------------------------------- |
| unitize_context_message_10000.py | 10000 | 对来自不同平台（QQ、微信）的消息上下文进行统一化，以避免耦合 | 不建议添加比它优先级更高的过滤器 |
| message_logger_1000.py | 1000 | 把收到的消息打印在标准输出 | 不建议添加比它优先级更高的过滤器 |
| intercept_some_message_formats_100.py | 100 | 拦截某些不支持的消息类型，对于文本消息，会把 `content` 字段复制到 `text` 字段 | 如果要自己编写插件，这里可以按需修改 |
| speech_recognition_90.py | 90 | 对语音消息进行语音识别（仅私聊消息），并把识别出的文字放到 `text` 字段，并标记 `from_voice` 字段为 True | 如果不需要可以删掉 |
| split_at_xiaokai_50.py | 50 | 分离群组和讨论组中消息开头的 `@CCZU 小开`，并更新 `text` 字段为剩余部分 | 也就是说通过此过滤器的消息，就是确定用户的意图就是和这个 bot 说话的消息 |
| command_dispatcher_0.py | 0 | 识别消息中的命令，并进行相应的调用 | |