From 3fb9b25284ac7cd5d5fd99a3337db9bbda8730dc Mon Sep 17 00:00:00 2001 From: Jigsaw111 Date: Wed, 14 Apr 2021 12:28:02 +0000 Subject: [PATCH 1/5] =?UTF-8?q?:beers:=20publish=20plugin=20=E5=BE=85?= =?UTF-8?q?=E5=8A=9E=E4=BA=8B=E9=A1=B9=E6=8F=90=E9=86=92=EF=BC=88=E9=97=B9?= =?UTF-8?q?=E9=92=9F=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vuepress/public/plugins.json | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/.vuepress/public/plugins.json b/docs/.vuepress/public/plugins.json index 2893869f..39b9eede 100644 --- a/docs/.vuepress/public/plugins.json +++ b/docs/.vuepress/public/plugins.json @@ -230,5 +230,13 @@ "desc": "存储插件数据至本地文件", "author": "yanyongyu", "repo": "nonebot/plugin-localstore" + }, + { + "id": "nonebot_plugin_todo", + "link": "nonebot-plugin-todo", + "name": "待办事项提醒（闹钟）", + "desc": "没十年脑血栓写不出的待办事项提醒", + "author": "Jigsaw111", + "repo": "https://github.com/Jigsaw111/nonebot_plugin_todo" } ] \ No newline at end of file From 260d119711977daabbc5695de49de3b50a5e91ae Mon Sep 17 00:00:00 2001 From: Ailitonia <41713304+Ailitonia@users.noreply.github.com> Date: Mon, 19 Apr 2021 23:30:42 +0800 Subject: [PATCH 2/5] Bot: change repository url Updated new repository url for Bot: Omega Miya --- docs/.vuepress/public/bots.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/.vuepress/public/bots.json b/docs/.vuepress/public/bots.json index d12b6d0e..ad37e766 100644 --- a/docs/.vuepress/public/bots.json +++ b/docs/.vuepress/public/bots.json @@ -9,6 +9,6 @@ "name": "Omega Miya", "desc": "B站推送Pixiv搜图识番求签抽卡表情包还有其他杂七杂八的功能", "author": "Ailitonia", - "repo": "Ailitonia/nonebot2_miya" + "repo": "Ailitonia/omega-miya" } -] \ No newline at end of file +] From 4655bf1df85dfa24ecdba6ae8de6ee517b737560 Mon Sep 17 00:00:00 2001 From: AkiraXie Date: Sun, 25 Apr 2021 02:08:52 +0800 Subject: [PATCH 3/5] =?UTF-8?q?=F0=9F=93=9D=20=20update=20handlers-overloa?= =?UTF-8?q?d=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/advanced/overloaded-handlers.md | 51 ++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/docs/advanced/overloaded-handlers.md b/docs/advanced/overloaded-handlers.md index 97ff3116..29a689f2 100644 --- a/docs/advanced/overloaded-handlers.md +++ b/docs/advanced/overloaded-handlers.md @@ -1 +1,52 @@ # 事件处理函数重载 + +当我们在编写 `nonebot2` 应用时， 常常会遇到这样一个问题：该怎么让同一类型的不同事件执行不同的响应逻辑？又或者如何让不同的 `adapter` 针对同一类型的事件作出不同响应？ + +聪明的你可能很快就想到了，编写相对应的 `Rule` 来应用到不同的 `Matcher` 上面不就可以了！ + +诚然，此种方法是十分有效的，但是它在编写的过程中会有一些繁琐：需要编写多种不同的 `Rule` ，同时也需要注册不同的 `Matcher` 来适配不同的 `Rule` 。 + +针对这个情况， `nonebot2` 提供一个便捷而高效的解决方案：`事件处理函数重载` 机制。 简单地说，`handler` ( `事件处理函数` ) 会根据其参数的 `typing hint` (` 类型标注 `) 来对相对应的 `adapter` 和相对应的 `Event` 进行响应，并且忽略不符合其参数 `类型标注` 的情况。 + +必须要注意的是， 该机制的原理是利用了 `inspect` 获取到了函数的 `singnature` ( `签名` )， 并在其中提取了参数的名称和对应的 `类型标注` 。故而，我们在编写 `handler` 时，参数的名称和 `类型标注` 必须要符合 `T_handler` 之规定，详情可以参看 **指南** 中的[事件处理](../guide/creating-a-handler)。 + +::: tip + +如果想了解更多关于 `inspect` 标准库的信息，可以查看[官方文档](https://docs.python.org/zh-cn/3.9/library/inspect.html)。 + +::: + +下面，我们会以 `CQHTTP` 中的 `消息事件` 中的 `群聊消息事件` 和 `私聊消息事件` 为例，对该机制的应用进行简单的介绍。 + +## 一个例子 + +首先，我们需要导入需要的方法，类型。 + +```python +from nonebot.adapters.cqhttp.bot import Bot +from nonebot.adapters.cqhttp.event import GroupMessageEvent, PrivateMessageEvent +from nonebot.plugin import on_command +``` + +之后，我们可以注册一个 `Matcher` 来响应 `消息事件` 。 + +```python +testmatcher = on_command('testoverload') +``` + +最后, 我们编写不同的`handler ` 并编写不同的 `类型标注` 来实现事件处理函数重载： + +```python +@matcher.handle() +async def _(bot: Bot, event: GroupMessageEvent): + await matcher.send('群聊消息事件响应成功！') + + +@matcher.handle() +async def _(bot: Bot, event: PrivateMessageEvent): + await matcher.send('私聊消息事件响应成功！') +``` + +此时，我们可以在群聊或者私聊中对我们的机器人发送 `testoverload` ，它会在不同的场景做出不同的应答。 + +这样一个简单的事件处理函数重载就完成了。 \ No newline at end of file From 5f3bd913215f0da92fb70b769d251f63f14c0261 Mon Sep 17 00:00:00 2001 From: AkiraXie Date: Sun, 25 Apr 2021 02:31:37 +0800 Subject: [PATCH 4/5] =?UTF-8?q?=F0=9F=93=9D=20=20update=20description=20in?= =?UTF-8?q?=20handler-overload=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/advanced/overloaded-handlers.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/docs/advanced/overloaded-handlers.md b/docs/advanced/overloaded-handlers.md index 29a689f2..6e0ff782 100644 --- a/docs/advanced/overloaded-handlers.md +++ b/docs/advanced/overloaded-handlers.md @@ -1,16 +1,12 @@ # 事件处理函数重载 -当我们在编写 `nonebot2` 应用时， 常常会遇到这样一个问题：该怎么让同一类型的不同事件执行不同的响应逻辑？又或者如何让不同的 `adapter` 针对同一类型的事件作出不同响应？ +当我们在编写 `nonebot2` 应用时，常常会遇到这样一个问题：该怎么让同一类型的不同事件执行不同的响应逻辑？又或者如何让不同的 `adapter` 针对同一类型的事件作出不同响应？ -聪明的你可能很快就想到了，编写相对应的 `Rule` 来应用到不同的 `Matcher` 上面不就可以了！ +针对这个问题， `nonebot2` 提供一个便捷而高效的解决方案：事件处理函数重载机制。简单地说，`handler` (事件处理函数) 会根据其参数的 `type hints` (类型标注) 来对相对应的 `adapter` 和 `Event` 进行响应，并且会忽略不符合其参数类型标注的情况。 -诚然，此种方法是十分有效的，但是它在编写的过程中会有一些繁琐：需要编写多种不同的 `Rule` ，同时也需要注册不同的 `Matcher` 来适配不同的 `Rule` 。 +必须要注意的是，该机制利用了 `inspect` 标准库获取到了事件处理函数的 `singnature` (签名) ，进一步获取到参数名称和类型标注。故而，我们在编写 `handler` 时，参数的名称和类型标注必须要符合 `T_handler` 之规定，详情可以参看 **指南** 中的[事件处理](../guide/creating-a-handler)。 -针对这个情况， `nonebot2` 提供一个便捷而高效的解决方案：`事件处理函数重载` 机制。 简单地说，`handler` ( `事件处理函数` ) 会根据其参数的 `typing hint` (` 类型标注 `) 来对相对应的 `adapter` 和相对应的 `Event` 进行响应，并且忽略不符合其参数 `类型标注` 的情况。 - -必须要注意的是， 该机制的原理是利用了 `inspect` 获取到了函数的 `singnature` ( `签名` )， 并在其中提取了参数的名称和对应的 `类型标注` 。故而，我们在编写 `handler` 时，参数的名称和 `类型标注` 必须要符合 `T_handler` 之规定，详情可以参看 **指南** 中的[事件处理](../guide/creating-a-handler)。 - -::: tip +::: tip 提示 如果想了解更多关于 `inspect` 标准库的信息，可以查看[官方文档](https://docs.python.org/zh-cn/3.9/library/inspect.html)。 @@ -20,7 +16,7 @@ ## 一个例子 -首先，我们需要导入需要的方法，类型。 +首先，我们需要导入需要的方法、类型。 ```python from nonebot.adapters.cqhttp.bot import Bot @@ -31,10 +27,10 @@ from nonebot.plugin import on_command 之后，我们可以注册一个 `Matcher` 来响应 `消息事件` 。 ```python -testmatcher = on_command('testoverload') +matcher = on_command('testoverload') ``` -最后, 我们编写不同的`handler ` 并编写不同的 `类型标注` 来实现事件处理函数重载： +最后, 我们编写不同的 `handler` 并编写不同的类型标注来实现事件处理函数重载： ```python @matcher.handle() @@ -47,6 +43,6 @@ async def _(bot: Bot, event: PrivateMessageEvent): await matcher.send('私聊消息事件响应成功！') ``` -此时，我们可以在群聊或者私聊中对我们的机器人发送 `testoverload` ，它会在不同的场景做出不同的应答。 +此时，我们可以在群聊或私聊中对我们的机器人发送 `testoverload` ，它会在不同的场景做出不同的应答。 这样一个简单的事件处理函数重载就完成了。 \ No newline at end of file From 56e489b458d55faa4bb0d7a2ac3e4379f889bbd1 Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Sun, 25 Apr 2021 13:18:36 +0800 Subject: [PATCH 5/5] :memo: update doc --- docs/advanced/overloaded-handlers.md | 36 ++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/docs/advanced/overloaded-handlers.md b/docs/advanced/overloaded-handlers.md index 6e0ff782..1895727b 100644 --- a/docs/advanced/overloaded-handlers.md +++ b/docs/advanced/overloaded-handlers.md @@ -2,9 +2,9 @@ 当我们在编写 `nonebot2` 应用时，常常会遇到这样一个问题：该怎么让同一类型的不同事件执行不同的响应逻辑？又或者如何让不同的 `adapter` 针对同一类型的事件作出不同响应？ -针对这个问题， `nonebot2` 提供一个便捷而高效的解决方案：事件处理函数重载机制。简单地说，`handler` (事件处理函数) 会根据其参数的 `type hints` (类型标注) 来对相对应的 `adapter` 和 `Event` 进行响应，并且会忽略不符合其参数类型标注的情况。 +针对这个问题， `nonebot2` 提供一个便捷而高效的解决方案：事件处理函数重载机制。简单地说，`handler` (事件处理函数) 会根据其参数的 `type hints` ([PEP484 类型标注](https://www.python.org/dev/peps/pep-0484/)) 来对相对应的 `adapter` 和 `Event` 进行响应，并且会忽略不符合其参数类型标注的情况。 -必须要注意的是，该机制利用了 `inspect` 标准库获取到了事件处理函数的 `singnature` (签名) ，进一步获取到参数名称和类型标注。故而，我们在编写 `handler` 时，参数的名称和类型标注必须要符合 `T_handler` 之规定，详情可以参看 **指南** 中的[事件处理](../guide/creating-a-handler)。 +必须要注意的是，该机制利用了 `inspect` 标准库获取到了事件处理函数的 `singnature` (签名) ，进一步获取到参数名称和类型标注。故而，我们在编写 `handler` 时，参数的名称和类型标注必须要符合 `T_Handler` 规定，详情可以参看 **指南** 中的[事件处理](../guide/creating-a-handler)。 ::: tip 提示 @@ -19,30 +19,46 @@ 首先，我们需要导入需要的方法、类型。 ```python -from nonebot.adapters.cqhttp.bot import Bot -from nonebot.adapters.cqhttp.event import GroupMessageEvent, PrivateMessageEvent -from nonebot.plugin import on_command +from nonebot import on_command +from nonebot.adapters.cqhttp import Bot, GroupMessageEvent, PrivateMessageEvent ``` 之后，我们可以注册一个 `Matcher` 来响应 `消息事件` 。 ```python -matcher = on_command('testoverload') +matcher = on_command("testoverload") ``` -最后, 我们编写不同的 `handler` 并编写不同的类型标注来实现事件处理函数重载： +最后, 我们编写不同的 `handler` 并编写不同的类型标注来实现事件处理函数重载： ```python @matcher.handle() async def _(bot: Bot, event: GroupMessageEvent): - await matcher.send('群聊消息事件响应成功！') + await matcher.send("群聊消息事件响应成功！") @matcher.handle() async def _(bot: Bot, event: PrivateMessageEvent): - await matcher.send('私聊消息事件响应成功！') + await matcher.send("私聊消息事件响应成功！") ``` 此时，我们可以在群聊或私聊中对我们的机器人发送 `testoverload` ，它会在不同的场景做出不同的应答。 -这样一个简单的事件处理函数重载就完成了。 \ No newline at end of file +这样一个简单的事件处理函数重载就完成了。 + +## 进阶 + +事件处理函数重载机制同样支持被 `matcher.got` 等装饰器装饰的函数。 例如： + +```python +@matcher.got("key1", prompt="群事件提问") +async def _(bot: Bot, event: GroupMessageEvent): + await matcher.send("群聊消息事件响应成功！") + + +@matcher.got("key2", prompt="私聊事件提问") +async def _(bot: Bot, event: PrivateMessageEvent): + await matcher.send("私聊消息事件响应成功！") +``` + +只有触发事件符合的函数才会触发装饰器。