From 79489fe463e6481a40d4f337e8b5ad54bf0a1e97 Mon Sep 17 00:00:00 2001 From: paro Date: Tue, 20 Aug 2024 21:30:49 +0800 Subject: [PATCH 1/4] Mention IgnoredException in runtime-hook.md --- website/docs/advanced/runtime-hook.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/docs/advanced/runtime-hook.md b/website/docs/advanced/runtime-hook.md index 79fae7c521eb..c1e915f8624e 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 some_condition: + raise IgnoredException("some reason") ``` ### 事件后处理 From 27f2da6f965013d356029896fcb79fecc5591e08 Mon Sep 17 00:00:00 2001 From: paro Date: Wed, 21 Aug 2024 00:56:56 +0800 Subject: [PATCH 2/4] Update runtime-hook.md according to reviewer's suggestions --- website/docs/advanced/runtime-hook.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/website/docs/advanced/runtime-hook.md b/website/docs/advanced/runtime-hook.md index c1e915f8624e..2020461b57b0 100644 --- a/website/docs/advanced/runtime-hook.md +++ b/website/docs/advanced/runtime-hook.md @@ -90,7 +90,7 @@ from nonebot.message import event_preprocessor @event_preprocessor async def do_something(event: Event): - if some_condition: + if not event.is_tome(): raise IgnoredException("some reason") ``` @@ -108,14 +108,16 @@ async def do_something(event: Event): ### 运行预处理 -这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。 +这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略该事件。 ```python +from nonebot.exception import IgnoredException from nonebot.message import run_preprocessor @run_preprocessor async def do_something(event: Event, matcher: Matcher): - pass + if not event.is_tome(): + raise IgnoredException("some reason") ``` ### 运行后处理 From c5a156d52a0a494ee549c0aa886d3b820eac0f7e Mon Sep 17 00:00:00 2001 From: paro Date: Tue, 20 Aug 2024 17:13:40 +0000 Subject: [PATCH 3/4] :arrow_down: Copy changes to versioned docs --- .../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 ++++++++---- 3 files changed, 24 insertions(+), 12 deletions(-) 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 79fae7c521eb..2020461b57b0 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.exception import IgnoredException from nonebot.message import run_preprocessor @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 79fae7c521eb..2020461b57b0 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.exception import IgnoredException from nonebot.message import run_preprocessor @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 79fae7c521eb..2020461b57b0 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.exception import IgnoredException from nonebot.message import run_preprocessor @run_preprocessor async def do_something(event: Event, matcher: Matcher): - pass + if not event.is_tome(): + raise IgnoredException("some reason") ``` ### 运行后处理 From abe30fd42063bedc6b8b914291fdff840e256dc1 Mon Sep 17 00:00:00 2001 From: Ju4tCode <42488585+yanyongyu@users.noreply.github.com> Date: Wed, 21 Aug 2024 23:16:39 +0800 Subject: [PATCH 4/4] Apply suggestions from code review --- website/docs/advanced/runtime-hook.md | 4 ++-- website/versioned_docs/version-2.3.1/advanced/runtime-hook.md | 4 ++-- website/versioned_docs/version-2.3.2/advanced/runtime-hook.md | 4 ++-- website/versioned_docs/version-2.3.3/advanced/runtime-hook.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/website/docs/advanced/runtime-hook.md b/website/docs/advanced/runtime-hook.md index 2020461b57b0..6e3c1c414733 100644 --- a/website/docs/advanced/runtime-hook.md +++ b/website/docs/advanced/runtime-hook.md @@ -108,11 +108,11 @@ async def do_something(event: Event): ### 运行预处理 -这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略该事件。 +这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略本次运行。 ```python -from nonebot.exception import IgnoredException from nonebot.message import run_preprocessor +from nonebot.exception import IgnoredException @run_preprocessor async def do_something(event: Event, matcher: Matcher): 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 2020461b57b0..6e3c1c414733 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 @@ -108,11 +108,11 @@ async def do_something(event: Event): ### 运行预处理 -这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略该事件。 +这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略本次运行。 ```python -from nonebot.exception import IgnoredException from nonebot.message import run_preprocessor +from nonebot.exception import IgnoredException @run_preprocessor async def do_something(event: Event, matcher: Matcher): 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 2020461b57b0..6e3c1c414733 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 @@ -108,11 +108,11 @@ async def do_something(event: Event): ### 运行预处理 -这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略该事件。 +这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略本次运行。 ```python -from nonebot.exception import IgnoredException from nonebot.message import run_preprocessor +from nonebot.exception import IgnoredException @run_preprocessor async def do_something(event: Event, matcher: Matcher): 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 2020461b57b0..6e3c1c414733 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 @@ -108,11 +108,11 @@ async def do_something(event: Event): ### 运行预处理 -这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略该事件。 +这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。在这个钩子函数内抛出 `nonebot.exception.IgnoredException` 也会使 NoneBot 忽略本次运行。 ```python -from nonebot.exception import IgnoredException from nonebot.message import run_preprocessor +from nonebot.exception import IgnoredException @run_preprocessor async def do_something(event: Event, matcher: Matcher):