Skip to content

Commit

Permalink
📝 Docs: 添加钩子函数 IgnoredException 用法 (#2912)
Browse files Browse the repository at this point in the history
Co-authored-by: Ju4tCode <42488585+yanyongyu@users.noreply.github.com>
  • Loading branch information
refparo and yanyongyu authored Aug 21, 2024
1 parent d1904ba commit 4b83734
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 16 deletions.
12 changes: 8 additions & 4 deletions website/docs/advanced/runtime-hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,16 @@ async def do_something(bot: Bot):

### 事件预处理

这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入,可以注入 `Bot` 对象、事件、会话状态。
这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入,可以注入 `Bot` 对象、事件、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 会使 NoneBot 忽略该事件。

```python
from nonebot.exception import IgnoredException
from nonebot.message import event_preprocessor

@event_preprocessor
async def do_something(event: Event):
pass
if not event.is_tome():
raise IgnoredException("some reason")
```

### 事件后处理
Expand All @@ -106,14 +108,16 @@ async def do_something(event: Event):

### 运行预处理

这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入,可以注入 `Bot` 对象、事件、事件响应器、会话状态。
这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入,可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略本次运行。

```python
from nonebot.message import run_preprocessor
from nonebot.exception import IgnoredException

@run_preprocessor
async def do_something(event: Event, matcher: Matcher):
pass
if not event.is_tome():
raise IgnoredException("some reason")
```

### 运行后处理
Expand Down
12 changes: 8 additions & 4 deletions website/versioned_docs/version-2.3.1/advanced/runtime-hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,16 @@ async def do_something(bot: Bot):

### 事件预处理

这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入,可以注入 `Bot` 对象、事件、会话状态。
这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入,可以注入 `Bot` 对象、事件、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 会使 NoneBot 忽略该事件。

```python
from nonebot.exception import IgnoredException
from nonebot.message import event_preprocessor

@event_preprocessor
async def do_something(event: Event):
pass
if not event.is_tome():
raise IgnoredException("some reason")
```

### 事件后处理
Expand All @@ -106,14 +108,16 @@ async def do_something(event: Event):

### 运行预处理

这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入,可以注入 `Bot` 对象、事件、事件响应器、会话状态。
这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入,可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略本次运行。

```python
from nonebot.message import run_preprocessor
from nonebot.exception import IgnoredException

@run_preprocessor
async def do_something(event: Event, matcher: Matcher):
pass
if not event.is_tome():
raise IgnoredException("some reason")
```

### 运行后处理
Expand Down
12 changes: 8 additions & 4 deletions website/versioned_docs/version-2.3.2/advanced/runtime-hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,16 @@ async def do_something(bot: Bot):

### 事件预处理

这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入,可以注入 `Bot` 对象、事件、会话状态。
这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入,可以注入 `Bot` 对象、事件、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 会使 NoneBot 忽略该事件。

```python
from nonebot.exception import IgnoredException
from nonebot.message import event_preprocessor

@event_preprocessor
async def do_something(event: Event):
pass
if not event.is_tome():
raise IgnoredException("some reason")
```

### 事件后处理
Expand All @@ -106,14 +108,16 @@ async def do_something(event: Event):

### 运行预处理

这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入,可以注入 `Bot` 对象、事件、事件响应器、会话状态。
这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入,可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略本次运行。

```python
from nonebot.message import run_preprocessor
from nonebot.exception import IgnoredException

@run_preprocessor
async def do_something(event: Event, matcher: Matcher):
pass
if not event.is_tome():
raise IgnoredException("some reason")
```

### 运行后处理
Expand Down
12 changes: 8 additions & 4 deletions website/versioned_docs/version-2.3.3/advanced/runtime-hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,16 @@ async def do_something(bot: Bot):

### 事件预处理

这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入,可以注入 `Bot` 对象、事件、会话状态。
这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入,可以注入 `Bot` 对象、事件、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 会使 NoneBot 忽略该事件。

```python
from nonebot.exception import IgnoredException
from nonebot.message import event_preprocessor

@event_preprocessor
async def do_something(event: Event):
pass
if not event.is_tome():
raise IgnoredException("some reason")
```

### 事件后处理
Expand All @@ -106,14 +108,16 @@ async def do_something(event: Event):

### 运行预处理

这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入,可以注入 `Bot` 对象、事件、事件响应器、会话状态。
这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入,可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略本次运行。

```python
from nonebot.message import run_preprocessor
from nonebot.exception import IgnoredException

@run_preprocessor
async def do_something(event: Event, matcher: Matcher):
pass
if not event.is_tome():
raise IgnoredException("some reason")
```

### 运行后处理
Expand Down

0 comments on commit 4b83734

Please sign in to comment.