Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: 添加钩子函数 IgnoredException 用法 #2912

Merged
merged 4 commits into from
Aug 21, 2024
Merged

Docs: 添加钩子函数 IgnoredException 用法 #2912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
79489fe
Mention IgnoredException in runtime-hook.md
refparo Aug 20, 2024
27f2da6
Update runtime-hook.md according to reviewer's suggestions
refparo Aug 20, 2024
c5a156d
:arrow_down: Copy changes to versioned docs
refparo Aug 20, 2024
abe30fd
Apply suggestions from code review
yanyongyu Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions website/docs/advanced/runtime-hook.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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