LiteyukiBot/docs/dev/api/message/matcher.md

98 lines
1.8 KiB
Markdown
Raw Normal View History

2024-08-21 09:59:21 +00:00
---
title: liteyuki.message.matcher
---
2024-08-29 06:19:39 +00:00
### **class** `Matcher`
### *method* `__init__(self, rule: Rule, priority: int, block: bool)`
2024-08-21 09:59:21 +00:00
2024-08-29 06:19:39 +00:00
**说明**: 匹配器
2024-08-21 09:59:21 +00:00
2024-08-29 06:19:39 +00:00
**参数**:
> - rule: 规则
> - priority: 优先级 >= 0
> - block: 是否阻断后续优先级更低的匹配器
2024-08-21 09:59:21 +00:00
<details>
2024-08-29 06:19:39 +00:00
<summary> <b>源代码</b> </summary>
2024-08-21 09:59:21 +00:00
```python
def __init__(self, rule: Rule, priority: int, block: bool):
"""
匹配器
Args:
rule: 规则
priority: 优先级 >= 0
block: 是否阻断后续优先级更低的匹配器
"""
self.rule = rule
self.priority = priority
self.block = block
self.handlers: list[EventHandler] = []
```
</details>
2024-08-29 06:19:39 +00:00
### *method* `handle(self) -> Callable[[EventHandler], EventHandler]`
2024-08-21 09:59:21 +00:00
2024-08-29 06:19:39 +00:00
**说明**: 添加处理函数,装饰器
2024-08-21 09:59:21 +00:00
2024-08-29 06:19:39 +00:00
**返回**: 装饰器 handler
2024-08-21 09:59:21 +00:00
<details>
2024-08-29 06:19:39 +00:00
<summary> <b>源代码</b> </summary>
2024-08-21 09:59:21 +00:00
```python
2024-08-29 06:19:39 +00:00
def handle(self) -> Callable[[EventHandler], EventHandler]:
2024-08-21 09:59:21 +00:00
"""
添加处理函数,装饰器
2024-08-29 06:19:39 +00:00
Returns:
装饰器 handler
"""
def decorator(handler: EventHandler) -> EventHandler:
self.handlers.append(handler)
return handler
return decorator
```
</details>
### *async method* `run(self, event: MessageEvent) -> None`
**说明**: 运行处理函数
**参数**:
> - event:
<details>
<summary> <b>源代码</b> </summary>
```python
async def run(self, event: MessageEvent) -> None:
"""
运行处理函数
2024-08-21 09:59:21 +00:00
Args:
2024-08-29 06:19:39 +00:00
event:
2024-08-21 09:59:21 +00:00
Returns:
"""
2024-08-29 06:19:39 +00:00
if not await self.rule(event):
return
for handler in self.handlers:
try:
await handler(event)
except Exception:
traceback.print_exc()
2024-08-21 09:59:21 +00:00
```
</details>
2024-08-29 06:19:39 +00:00
### ***var*** `EventHandler = Callable[[MessageEvent], Coroutine[None, None, Any]]`
- **类型**: `TypeAlias`