From 4b837343ffc2b4bc9586a1e2a298bc601949f3e5 Mon Sep 17 00:00:00 2001 From: paro Date: Wed, 21 Aug 2024 23:23:56 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20Docs:=20=E6=B7=BB=E5=8A=A0=E9=92=A9?= =?UTF-8?q?=E5=AD=90=E5=87=BD=E6=95=B0=20IgnoredException=20=E7=94=A8?= =?UTF-8?q?=E6=B3=95=20(#2912)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Ju4tCode <42488585+yanyongyu@users.noreply.github.com> --- website/docs/advanced/runtime-hook.md | 12 ++++++++---- .../version-2.3.1/advanced/runtime-hook.md | 12 ++++++++---- .../version-2.3.2/advanced/runtime-hook.md | 12 ++++++++---- .../version-2.3.3/advanced/runtime-hook.md | 12 ++++++++---- 4 files changed, 32 insertions(+), 16 deletions(-) diff --git a/website/docs/advanced/runtime-hook.md b/website/docs/advanced/runtime-hook.md index 79fae7c5..6e3c1c41 100644 --- a/website/docs/advanced/runtime-hook.md +++ b/website/docs/advanced/runtime-hook.md @@ -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") ``` ### 事件后处理 @@ -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") ``` ### 运行后处理 diff --git a/website/versioned_docs/version-2.3.1/advanced/runtime-hook.md b/website/versioned_docs/version-2.3.1/advanced/runtime-hook.md index 79fae7c5..6e3c1c41 100644 --- a/website/versioned_docs/version-2.3.1/advanced/runtime-hook.md +++ b/website/versioned_docs/version-2.3.1/advanced/runtime-hook.md @@ -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") ``` ### 事件后处理 @@ -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") ``` ### 运行后处理 diff --git a/website/versioned_docs/version-2.3.2/advanced/runtime-hook.md b/website/versioned_docs/version-2.3.2/advanced/runtime-hook.md index 79fae7c5..6e3c1c41 100644 --- a/website/versioned_docs/version-2.3.2/advanced/runtime-hook.md +++ b/website/versioned_docs/version-2.3.2/advanced/runtime-hook.md @@ -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") ``` ### 事件后处理 @@ -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") ``` ### 运行后处理 diff --git a/website/versioned_docs/version-2.3.3/advanced/runtime-hook.md b/website/versioned_docs/version-2.3.3/advanced/runtime-hook.md index 79fae7c5..6e3c1c41 100644 --- a/website/versioned_docs/version-2.3.3/advanced/runtime-hook.md +++ b/website/versioned_docs/version-2.3.3/advanced/runtime-hook.md @@ -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") ``` ### 事件后处理 @@ -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") ``` ### 运行后处理