This commit is contained in:
Richard Chien
2016-12-26 16:36:35 +08:00
parent 4091a43121
commit 675ebfce6b
7 changed files with 70 additions and 12 deletions

24
docs/Write_Filter.md Normal file
View File

@ -0,0 +1,24 @@
# 编写过滤器
编写过滤器比较简单,只需要调用 `filter.py` 中的 `add_filter` 函数,传入过滤器函数和优先级,即可。
比如我们需要做一个消息拦截器,当匹配到消息中有不文明词汇,就发送一条警告,并拦截消息不让后续过滤器和命令处理,代码可能如下:
```python
from filter import add_filter
from commands import core
def _interceptor(ctx_msg):
if 'xxx' in ctx_msg.get('content', ''):
core.echo('请不要说脏话', ctx_msg)
return False
return True
add_filter(_interceptor, 100)
```
一般建议优先级设置为 0100 之间。
过滤器函数返回 True 表示让消息继续传递,返回 False 表示拦截消息。由于很多情况下可能不需要拦截,因此为了方便起见,将不返回值的情况(返回 None作为不拦截处理因此只要返回结果 is not False 就表示不拦截。