From a729b8fa3ceb9e009323a7f15acd58a5cb0a9136 Mon Sep 17 00:00:00 2001 From: abrahum Date: Thu, 21 Jan 2021 03:09:57 +0000 Subject: [PATCH 01/13] =?UTF-8?q?:beers:=20publish=20=E6=A8=A1=E6=8B=9F?= =?UTF-8?q?=E6=8A=BD=E5=8D=A1?= 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 0e9abd39..3dbed187 100644 --- a/docs/.vuepress/public/plugins.json +++ b/docs/.vuepress/public/plugins.json @@ -78,5 +78,13 @@ "desc": "多语种翻译插件", "name": "translator", "repo": "Lancercmd/nonebot_plugin_translator" + }, + { + "id": "nonebot_plugin_simdraw", + "link": "nonebot-plugin-simdraw", + "author": "abrahum", + "desc": "根据配置的手游卡池信息模拟抽卡", + "name": "模拟抽卡", + "repo": "abrahum/nonebot_plugin_simdraw" } ] \ No newline at end of file From 9f37fb23d6dc73b248e2da8e0b65f891462d36bf Mon Sep 17 00:00:00 2001 From: Joenothing-lst Date: Mon, 25 Jan 2021 05:45:55 +0000 Subject: [PATCH 02/13] :beers: publish nonebot-plugin-wordbank --- 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 3dbed187..c77bd1ab 100644 --- a/docs/.vuepress/public/plugins.json +++ b/docs/.vuepress/public/plugins.json @@ -86,5 +86,13 @@ "desc": "根据配置的手游卡池信息模拟抽卡", "name": "模拟抽卡", "repo": "abrahum/nonebot_plugin_simdraw" + }, + { + "id": "nonebot-plugin-wordbank", + "link": "nonebot-plugin-wordbank", + "author": "Joenothing-lst", + "desc": "无数据库的轻量问答插件，支持模糊问答", + "name": "nonebot-plugin-wordbank", + "repo": "Joenothing-lst/word-bank" } ] \ No newline at end of file From d43dcdf03f7c3eb9253798f8e11e011021383e99 Mon Sep 17 00:00:00 2001 From: jks15satoshi Date: Wed, 27 Jan 2021 15:56:14 +0000 Subject: [PATCH 03/13] =?UTF-8?q?:beers:=20publish=20=E5=86=B7=E5=8D=B4?= =?UTF-8?q?=E4=BA=8B=E4=BB=B6?= 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 c77bd1ab..840676c2 100644 --- a/docs/.vuepress/public/plugins.json +++ b/docs/.vuepress/public/plugins.json @@ -94,5 +94,13 @@ "desc": "无数据库的轻量问答插件，支持模糊问答", "name": "nonebot-plugin-wordbank", "repo": "Joenothing-lst/word-bank" + }, + { + "id": "nonebot_plugin_cooldown", + "link": "nonebot-plugin-cooldown", + "author": "jks15satoshi", + "desc": "为用户调用功能添加冷却时间（调用频率限制）功能", + "name": "冷却事件", + "repo": "jks15satoshi/nonebot-plugin-cooldown" } ] \ No newline at end of file From 9cbe182ff46ece646ca220683f4fc95fdf93acac Mon Sep 17 00:00:00 2001 From: synodriver Date: Sat, 30 Jan 2021 05:31:40 +0000 Subject: [PATCH 04/13] =?UTF-8?q?:beers:=20publish=20mqtt=E6=8E=A5?= =?UTF-8?q?=E5=85=A5?= 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 840676c2..b7c78e50 100644 --- a/docs/.vuepress/public/plugins.json +++ b/docs/.vuepress/public/plugins.json @@ -102,5 +102,13 @@ "desc": "为用户调用功能添加冷却时间（调用频率限制）功能", "name": "冷却事件", "repo": "jks15satoshi/nonebot-plugin-cooldown" + }, + { + "id": "nonebot_plugin_mqtt", + "link": "nonebot-plugin-mqtt", + "author": "synodriver", + "desc": "接入mqtt网络,订阅和发布消息", + "name": "mqtt接入", + "repo": "synodriver/nonebot_plugin_mqtt" } ] \ No newline at end of file From 84504c9daf25a6bc90aaf24b03fc7566ac2e4167 Mon Sep 17 00:00:00 2001 From: iyume Date: Sat, 30 Jan 2021 10:37:12 +0000 Subject: [PATCH 05/13] =?UTF-8?q?:beers:=20publish=20=E6=B6=88=E6=81=AF?= =?UTF-8?q?=E4=BA=A4=E4=BA=92=E5=BC=8F=20python=20=E8=A7=A3=E9=87=8A?= =?UTF-8?q?=E5=99=A8?= 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 b7c78e50..5a3051d8 100644 --- a/docs/.vuepress/public/plugins.json +++ b/docs/.vuepress/public/plugins.json @@ -110,5 +110,13 @@ "desc": "接入mqtt网络,订阅和发布消息", "name": "mqtt接入", "repo": "synodriver/nonebot_plugin_mqtt" + }, + { + "id": "nonebot-plugin-ipypreter", + "link": "nonebot-plugin-ipypreter", + "author": "iyume", + "desc": "消息交互式 python 解释器", + "name": "消息交互式 python 解释器", + "repo": "iyume/nonebot-plugin-ipypreter" } ] \ No newline at end of file From 95aad49fb4efa0f81e22921b594ca4ea806b71c3 Mon Sep 17 00:00:00 2001 From: maxesisn Date: Sun, 31 Jan 2021 05:07:38 +0000 Subject: [PATCH 06/13] :beers: publish songpicker2 --- 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 5a3051d8..25e7b2b9 100644 --- a/docs/.vuepress/public/plugins.json +++ b/docs/.vuepress/public/plugins.json @@ -118,5 +118,13 @@ "desc": "消息交互式 python 解释器", "name": "消息交互式 python 解释器", "repo": "iyume/nonebot-plugin-ipypreter" + }, + { + "id": "nonebot_plugin_songpicker2", + "link": "nonebot-plugin-songpicker2", + "author": "maxesisn", + "desc": "点播歌曲，支持候选菜单、热评显示，数据源为网易云", + "name": "songpicker2", + "repo": "maxesisn/nonebot_plugin_songpicker2" } ] \ No newline at end of file From 977c10524e2004cef4890589e6cae83ebefae96c Mon Sep 17 00:00:00 2001 From: jks15satoshi Date: Sun, 31 Jan 2021 18:31:29 +0000 Subject: [PATCH 07/13] =?UTF-8?q?:beers:=20publish=20=E9=A3=8E=E6=A0=BC?= =?UTF-8?q?=E5=8C=96=E5=AD=97=E7=AC=A6=E4=B8=B2=E7=AE=A1=E7=90=86?= 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 25e7b2b9..df725b06 100644 --- a/docs/.vuepress/public/plugins.json +++ b/docs/.vuepress/public/plugins.json @@ -126,5 +126,13 @@ "desc": "点播歌曲，支持候选菜单、热评显示，数据源为网易云", "name": "songpicker2", "repo": "maxesisn/nonebot_plugin_songpicker2" + }, + { + "id": "nonebot_plugin_styledstr", + "link": "nonebot-plugin-styledstr", + "author": "jks15satoshi", + "desc": "通过字符串标签管理字符串资源", + "name": "风格化字符串管理", + "repo": "jks15satoshi/nonebot_plugin_styledstr" } ] \ No newline at end of file From f8fb36a1f788777a4eadad9fde817327d05a3491 Mon Sep 17 00:00:00 2001 From: AkiraXie Date: Mon, 1 Feb 2021 22:28:48 +0800 Subject: [PATCH 08/13] :zap:Support shell-like command --- nonebot/plugin.py | 56 ++++++++++++++++++++++++++++++++++++-- nonebot/plugin.pyi | 10 +++++++ nonebot/rule.py | 68 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 132 insertions(+), 2 deletions(-) diff --git a/nonebot/plugin.py b/nonebot/plugin.py index de4073c9..562811fd 100644 --- a/nonebot/plugin.py +++ b/nonebot/plugin.py @@ -9,6 +9,7 @@ import re import sys import pkgutil import importlib +from argparse import ArgumentParser from types import ModuleType from dataclasses import dataclass from importlib._bootstrap import _load @@ -19,7 +20,7 @@ from nonebot.log import logger from nonebot.matcher import Matcher from nonebot.permission import Permission from nonebot.typing import T_State, T_StateFactory, T_Handler, T_RuleChecker -from nonebot.rule import Rule, startswith, endswith, keyword, command, regex +from nonebot.rule import Rule, shell_like_command, startswith, endswith, keyword, command, regex if TYPE_CHECKING: from nonebot.adapters import Bot, Event @@ -436,6 +437,56 @@ def on_command(cmd: Union[str, Tuple[str, ...]], return on_message(command(*commands) & rule, handlers=handlers, **kwargs) +def on_shell_like_command(cmd: Union[str, Tuple[str, ...]], + rule: Optional[Union[Rule, T_RuleChecker]] = None, + aliases: Optional[Set[Union[str, + Tuple[str, ...]]]] = None, + shell_like_argsparser: Optional[ArgumentParser] = None, + **kwargs) -> Type[Matcher]: + """ + :说明: + + 注册一个支持 ``shell_like`` 解析参数的命令消息事件响应器。 + + 与普通的 ``on_command`` 不同的是，在添加 ``shell_like_argsparser`` 参数时, 响应器会自动处理消息, + + 并将 ``shell_like_argsparser`` 处理的参数保存在 ``state["args"]`` 中 + + :参数: + + * ``cmd: Union[str, Tuple[str, ...]]``: 指定命令内容 + * ``rule: Optional[Union[Rule, T_RuleChecker]]``: 事件响应规则 + * ``aliases: Optional[Set[Union[str, Tuple[str, ...]]]]``: 命令别名 + * ``shell_like_argsparser:Optional[ArgumentParser]``: ``argparse.ArgumentParser`` 对象,是一个类 ``shell`` 的 ``argsparser`` + * ``permission: Optional[Permission]``: 事件响应权限 + * ``handlers: Optional[List[T_Handler]]``: 事件处理函数列表 + * ``temp: bool``: 是否为临时事件响应器（仅执行一次） + * ``priority: int``: 事件响应器优先级 + * ``block: bool``: 是否阻止事件向更低优先级传递 + * ``state: Optional[T_State]``: 默认 state + * ``state_factory: Optional[T_StateFactory]``: 默认 state 的工厂函数 + + :返回: + + - ``Type[Matcher]`` + """ + + async def _strip_cmd(bot: "Bot", event: "Event", state: T_State): + message = event.get_message() + segment = message.pop(0) + new_message = message.__class__( + str(segment) + [len(state["_prefix"]["raw_command"]):].strip()) # type: ignore + for new_segment in reversed(new_message): + message.insert(0, new_segment) + + handlers = kwargs.pop("handlers", []) + handlers.insert(0, _strip_cmd) + + commands = set([cmd]) | (aliases or set()) + return on_message(shell_like_command(shell_like_argsparser, *commands) & rule, handlers=handlers, **kwargs) + + def on_regex(pattern: str, flags: Union[int, re.RegexFlag] = 0, rule: Optional[Rule] = None, @@ -917,7 +968,8 @@ def load_plugins(*plugin_dir: str) -> Set[Plugin]: m.module = name plugin = Plugin(name, module, _tmp_matchers.get(), _export.get()) plugins[name] = plugin - logger.opt(colors=True).info(f'Succeeded to import "{name}"') + logger.opt(colors=True).info( + f'Succeeded to import "{name}"') return plugin except Exception as e: logger.opt(colors=True, exception=e).error( diff --git a/nonebot/plugin.pyi b/nonebot/plugin.pyi index db31ad3d..1e8cb810 100644 --- a/nonebot/plugin.pyi +++ b/nonebot/plugin.pyi @@ -1,4 +1,5 @@ import re +from argparse import ArgumentParser from types import ModuleType from contextvars import ContextVar from typing import Any, Set, List, Dict, Type, Tuple, Union, Optional @@ -146,6 +147,15 @@ def on_command(cmd: Union[str, Tuple[str, ...]], ... +def on_shell_like_command(cmd: Union[str, Tuple[str, ...]], + rule: Optional[Union[Rule, T_RuleChecker]] = None, + aliases: Optional[Set[Union[str, + Tuple[str, ...]]]] = None, + shell_like_argsparser: Optional[ArgumentParser] = None, + **kwargs) -> Type[Matcher]: + ... + + def on_regex(pattern: str, flags: Union[int, re.RegexFlag] = 0, rule: Optional[Rule] = ..., diff --git a/nonebot/rule.py b/nonebot/rule.py index d2b8f1fd..0c0effc4 100644 --- a/nonebot/rule.py +++ b/nonebot/rule.py @@ -9,10 +9,12 @@ \:\:\: """ +from argparse import ArgumentParser import re import asyncio from itertools import product from typing import Any, Dict, Union, Tuple, Optional, Callable, NoReturn, Awaitable, TYPE_CHECKING +from loguru import logger from pygtrie import CharTrie @@ -276,6 +278,72 @@ def command(*cmds: Union[str, Tuple[str, ...]]) -> Rule: return Rule(_command) +def shell_like_command(shell_like_argsparser: Optional[ArgumentParser] = None, *cmds: Union[str, Tuple[str, ...]]) -> Rule: + """ + :说明: + + 支持 ``shell_like`` 解析参数的命令形式匹配，根据配置里提供的 ``command_start``, ``command_sep`` 判断消息是否为命令。 + + 可以通过 ``state["_prefix"]["command"]`` 获取匹配成功的命令（例：``("test",)``），通过 ``state["_prefix"]["raw_command"]`` 获取匹配成功的原始命令文本（例：``"/test"``）。 + + 添加 ``shell_like_argpsarser`` 参数后, 可以自动处理消息并将结果保存在 ``state["args"]`` 中。 + + + + + :参数: + * ``shell_like_argsparser: Optional[ArgumentParser]``: ``argparse.ArgumentParser`` 对象, 是一个类 ``shell`` 的 ``argsparser`` + + * ``*cmds: Union[str, Tuple[str, ...]]``: 命令内容 + + :示例: + + 使用默认 ``command_start``, ``command_sep`` 配置 + + 命令 ``("test",)`` 可以匹配：``/test`` 开头的消息 + 命令 ``("test", "sub")`` 可以匹配”``/test.sub`` 开头的消息 + + 当 ``shell_like_argsparser`` 的 ``argument`` 为 ``-a`` 时且 ``action`` 为 ``store_true`` ， ``state["args"]["a"]`` 将会记录 ``True`` + + \:\:\:tip 提示 + 命令内容与后续消息间无需空格！ + \:\:\: + """ + config = get_driver().config + command_start = config.command_start + command_sep = config.command_sep + commands = list(cmds) + for index, command in enumerate(commands): + if isinstance(command, str): + commands[index] = command = (command,) + + if len(command) == 1: + for start in command_start: + TrieRule.add_prefix(f"{start}{command[0]}", command) + else: + for start, sep in product(command_start, command_sep): + TrieRule.add_prefix(f"{start}{sep.join(command)}", command) + + async def _shell_like_command(bot: "Bot", event: "Event", state: T_State) -> bool: + if state["_prefix"]["command"] in commands: + if shell_like_argsparser: + message = str(event.get_message()) + strip_message = message[len( + state["_prefix"]["raw_command"]):].lstrip() + try: + args = shell_like_argsparser.parse_args( + strip_message.split()) + state["args"]=dict() + state["args"].update(**args.__dict__) + except: + pass + return True + else: + return False + + return Rule(_shell_like_command) + + def regex(regex: str, flags: Union[int, re.RegexFlag] = 0) -> Rule: """ :说明: From c8ebaf38b6aae28efadba0dc4a729e04e384ef4d Mon Sep 17 00:00:00 2001 From: AkiraXie Date: Mon, 1 Feb 2021 17:22:53 +0000 Subject: [PATCH 09/13] :memo: update api docs --- docs/api/plugin.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++ docs/api/rule.md | 38 +++++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+) diff --git a/docs/api/plugin.md b/docs/api/plugin.md index 91e3e763..5e958f64 100644 --- a/docs/api/plugin.md +++ b/docs/api/plugin.md @@ -507,6 +507,63 @@ def something_else(): +## `on_shell_like_command(cmd, rule=None, aliases=None, shell_like_argsparser=None, **kwargs)` + + +* **说明** + + 注册一个支持 `shell_like` 解析参数的命令消息事件响应器。 + + 与普通的 `on_command` 不同的是，在添加 `shell_like_argsparser` 参数时, 响应器会自动处理消息, + + 并将 `shell_like_argsparser` 处理的参数保存在 `state["args"]` 中 + + + +* **参数** + + + * `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容 + + + * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 + + + * `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名 + + + * `shell_like_argsparser:Optional[ArgumentParser]`: `argparse.ArgumentParser` 对象,是一个类 `shell` 的 `argsparser` + + + * `permission: Optional[Permission]`: 事件响应权限 + + + * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 + + + * `temp: bool`: 是否为临时事件响应器（仅执行一次） + + + * `priority: int`: 事件响应器优先级 + + + * `block: bool`: 是否阻止事件向更低优先级传递 + + + * `state: Optional[T_State]`: 默认 state + + + * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 + + + +* **返回** + + + * `Type[Matcher]` + + + ## `on_regex(pattern, flags=0, rule=None, **kwargs)` diff --git a/docs/api/rule.md b/docs/api/rule.md index cb3fd05f..44f4a098 100644 --- a/docs/api/rule.md +++ b/docs/api/rule.md @@ -170,6 +170,44 @@ Rule(async_function, run_sync(sync_function)) ::: +## `shell_like_command(shell_like_argsparser=None, *cmds)` + + +* **说明** + + 支持 `shell_like` 解析参数的命令形式匹配，根据配置里提供的 `command_start`, `command_sep` 判断消息是否为命令。 + + 可以通过 `state["_prefix"]["command"]` 获取匹配成功的命令（例：`("test",)`），通过 `state["_prefix"]["raw_command"]` 获取匹配成功的原始命令文本（例：`"/test"`）。 + + 添加 `shell_like_argpsarser` 参数后, 可以自动处理消息并将结果保存在 `state["args"]` 中。 + + + +* **参数** + + + * `shell_like_argsparser: Optional[ArgumentParser]`: `argparse.ArgumentParser` 对象, 是一个类 `shell` 的 `argsparser` + + + * `*cmds: Union[str, Tuple[str, ...]]`: 命令内容 + + + +* **示例** + + 使用默认 `command_start`, `command_sep` 配置 + + 命令 `("test",)` 可以匹配：`/test` 开头的消息 + 命令 `("test", "sub")` 可以匹配”`/test.sub` 开头的消息 + + 当 `shell_like_argsparser` 的 `argument` 为 `-a` 时且 `action` 为 `store_true` ， `state["args"]["a"]` 将会记录 `True` + + +:::tip 提示 +命令内容与后续消息间无需空格！ +::: + + ## `regex(regex, flags=0)` From 9e4e9f29d1b5256e50a4c221e0393f36965a119d Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Tue, 2 Feb 2021 11:59:14 +0800 Subject: [PATCH 10/13] :sparkles: rewrite shell command --- nonebot/__init__.py | 2 +- nonebot/exception.py | 17 +++++ nonebot/plugin.py | 103 ++++++++++++++++++++++++++----- nonebot/plugin.pyi | 46 +++++++++++--- nonebot/rule.py | 79 ++++++++++++++++-------- tests/test_plugins/test_shell.py | 15 +++++ 6 files changed, 212 insertions(+), 50 deletions(-) create mode 100644 tests/test_plugins/test_shell.py diff --git a/nonebot/__init__.py b/nonebot/__init__.py index 11dad7cd..dce9c9ec 100644 --- a/nonebot/__init__.py +++ b/nonebot/__init__.py @@ -218,6 +218,6 @@ def run(host: Optional[str] = None, from nonebot.plugin import on_message, on_notice, on_request, on_metaevent, CommandGroup, MatcherGroup -from nonebot.plugin import on_startswith, on_endswith, on_keyword, on_command, on_regex +from nonebot.plugin import on_startswith, on_endswith, on_keyword, on_command, on_shell_command, on_regex from nonebot.plugin import load_plugin, load_plugins, load_builtin_plugins from nonebot.plugin import export, require, get_plugin, get_loaded_plugins diff --git a/nonebot/exception.py b/nonebot/exception.py index 815ac714..b8a42aa4 100644 --- a/nonebot/exception.py +++ b/nonebot/exception.py @@ -37,6 +37,23 @@ class IgnoredException(NoneBotException): return self.__repr__() +class ParserExit(NoneBotException): + """ + :说明: + + ``shell command`` 处理消息失败时返回的异常 + + :参数: + + * ``status`` + * ``message`` + """ + + def __init__(self, status=0, message=None): + self.status = status + self.message = message + + class PausedException(NoneBotException): """ :说明: diff --git a/nonebot/plugin.py b/nonebot/plugin.py index 562811fd..1e198179 100644 --- a/nonebot/plugin.py +++ b/nonebot/plugin.py @@ -9,7 +9,6 @@ import re import sys import pkgutil import importlib -from argparse import ArgumentParser from types import ModuleType from dataclasses import dataclass from importlib._bootstrap import _load @@ -20,7 +19,7 @@ from nonebot.log import logger from nonebot.matcher import Matcher from nonebot.permission import Permission from nonebot.typing import T_State, T_StateFactory, T_Handler, T_RuleChecker -from nonebot.rule import Rule, shell_like_command, startswith, endswith, keyword, command, regex +from nonebot.rule import Rule, startswith, endswith, keyword, command, shell_command, ArgumentParser, regex if TYPE_CHECKING: from nonebot.adapters import Bot, Event @@ -437,27 +436,26 @@ def on_command(cmd: Union[str, Tuple[str, ...]], return on_message(command(*commands) & rule, handlers=handlers, **kwargs) -def on_shell_like_command(cmd: Union[str, Tuple[str, ...]], - rule: Optional[Union[Rule, T_RuleChecker]] = None, - aliases: Optional[Set[Union[str, - Tuple[str, ...]]]] = None, - shell_like_argsparser: Optional[ArgumentParser] = None, - **kwargs) -> Type[Matcher]: +def on_shell_command(cmd: Union[str, Tuple[str, ...]], + rule: Optional[Union[Rule, T_RuleChecker]] = None, + aliases: Optional[Set[Union[str, Tuple[str, ...]]]] = None, + parser: Optional[ArgumentParser] = None, + **kwargs) -> Type[Matcher]: """ :说明: 注册一个支持 ``shell_like`` 解析参数的命令消息事件响应器。 - 与普通的 ``on_command`` 不同的是，在添加 ``shell_like_argsparser`` 参数时, 响应器会自动处理消息, + 与普通的 ``on_command`` 不同的是，在添加 ``parser`` 参数时, 响应器会自动处理消息。 - 并将 ``shell_like_argsparser`` 处理的参数保存在 ``state["args"]`` 中 + 并将用户输入的原始参数列表保存在 ``state["argv"]``, ``parser`` 处理的参数保存在 ``state["args"]`` 中 :参数: * ``cmd: Union[str, Tuple[str, ...]]``: 指定命令内容 * ``rule: Optional[Union[Rule, T_RuleChecker]]``: 事件响应规则 * ``aliases: Optional[Set[Union[str, Tuple[str, ...]]]]``: 命令别名 - * ``shell_like_argsparser:Optional[ArgumentParser]``: ``argparse.ArgumentParser`` 对象,是一个类 ``shell`` 的 ``argsparser`` + * ``parser: Optional[ArgumentParser]``: ``nonebot.rule.ArgumentParser`` 对象 * ``permission: Optional[Permission]``: 事件响应权限 * ``handlers: Optional[List[T_Handler]]``: 事件处理函数列表 * ``temp: bool``: 是否为临时事件响应器（仅执行一次） @@ -484,7 +482,9 @@ def on_shell_like_command(cmd: Union[str, Tuple[str, ...]], handlers.insert(0, _strip_cmd) commands = set([cmd]) | (aliases or set()) - return on_message(shell_like_command(shell_like_argsparser, *commands) & rule, handlers=handlers, **kwargs) + return on_message(shell_command(*commands, parser=parser) & rule, + handlers=handlers, + **kwargs) def on_regex(pattern: str, @@ -564,6 +564,29 @@ class CommandGroup: final_kwargs.update(kwargs) return on_command(cmd, **final_kwargs) + def shell_command(self, cmd: Union[str, Tuple[str, ...]], + **kwargs) -> Type[Matcher]: + """ + :说明: + + 注册一个新的命令。 + + :参数: + + * ``cmd: Union[str, Tuple[str, ...]]``: 命令前缀 + * ``**kwargs``: 其他传递给 ``on_command`` 的参数，将会覆盖命令组默认值 + + :返回: + + - ``Type[Matcher]`` + """ + sub_cmd = (cmd,) if isinstance(cmd, str) else cmd + cmd = self.basecmd + sub_cmd + + final_kwargs = self.base_kwargs.copy() + final_kwargs.update(kwargs) + return on_shell_command(cmd, **final_kwargs) + class MatcherGroup: """事件响应器组合，统一管理。为 ``Matcher`` 创建提供默认属性。""" @@ -851,6 +874,59 @@ class MatcherGroup: handlers=handlers, **kwargs) + def on_shell_command(self, + cmd: Union[str, Tuple[str, ...]], + rule: Optional[Union[Rule, T_RuleChecker]] = None, + aliases: Optional[Set[Union[str, Tuple[str, + ...]]]] = None, + parser: Optional[ArgumentParser] = None, + **kwargs) -> Type[Matcher]: + """ + :说明: + + 注册一个支持 ``shell_like`` 解析参数的命令消息事件响应器。 + + 与普通的 ``on_command`` 不同的是，在添加 ``parser`` 参数时, 响应器会自动处理消息。 + + 并将用户输入的原始参数列表保存在 ``state["argv"]``, ``parser`` 处理的参数保存在 ``state["args"]`` 中 + + :参数: + + * ``cmd: Union[str, Tuple[str, ...]]``: 指定命令内容 + * ``rule: Optional[Union[Rule, T_RuleChecker]]``: 事件响应规则 + * ``aliases: Optional[Set[Union[str, Tuple[str, ...]]]]``: 命令别名 + * ``parser: Optional[ArgumentParser]``: ``nonebot.rule.ArgumentParser`` 对象 + * ``permission: Optional[Permission]``: 事件响应权限 + * ``handlers: Optional[List[T_Handler]]``: 事件处理函数列表 + * ``temp: bool``: 是否为临时事件响应器（仅执行一次） + * ``priority: int``: 事件响应器优先级 + * ``block: bool``: 是否阻止事件向更低优先级传递 + * ``state: Optional[T_State]``: 默认 state + * ``state_factory: Optional[T_StateFactory]``: 默认 state 的工厂函数 + + :返回: + + - ``Type[Matcher]`` + """ + + async def _strip_cmd(bot: "Bot", event: "Event", state: T_State): + message = event.get_message() + segment = message.pop(0) + new_message = message.__class__( + str(segment) + [len(state["_prefix"]["raw_command"]):].strip()) # type: ignore + for new_segment in reversed(new_message): + message.insert(0, new_segment) + + handlers = kwargs.pop("handlers", []) + handlers.insert(0, _strip_cmd) + + commands = set([cmd]) | (aliases or set()) + return self.on_message(rule=shell_command(*commands, parser=parser) & + rule, + handlers=handlers, + **kwargs) + def on_regex(self, pattern: str, flags: Union[int, re.RegexFlag] = 0, @@ -968,8 +1044,7 @@ def load_plugins(*plugin_dir: str) -> Set[Plugin]: m.module = name plugin = Plugin(name, module, _tmp_matchers.get(), _export.get()) plugins[name] = plugin - logger.opt(colors=True).info( - f'Succeeded to import "{name}"') + logger.opt(colors=True).info(f'Succeeded to import "{name}"') return plugin except Exception as e: logger.opt(colors=True, exception=e).error( diff --git a/nonebot/plugin.pyi b/nonebot/plugin.pyi index 1e8cb810..5fbefa8a 100644 --- a/nonebot/plugin.pyi +++ b/nonebot/plugin.pyi @@ -1,12 +1,11 @@ import re -from argparse import ArgumentParser from types import ModuleType from contextvars import ContextVar from typing import Any, Set, List, Dict, Type, Tuple, Union, Optional -from nonebot.rule import Rule from nonebot.matcher import Matcher from nonebot.permission import Permission +from nonebot.rule import Rule, ArgumentParser from nonebot.typing import T_State, T_StateFactory, T_Handler, T_RuleChecker plugins: Dict[str, "Plugin"] = ... @@ -147,12 +146,11 @@ def on_command(cmd: Union[str, Tuple[str, ...]], ... -def on_shell_like_command(cmd: Union[str, Tuple[str, ...]], - rule: Optional[Union[Rule, T_RuleChecker]] = None, - aliases: Optional[Set[Union[str, - Tuple[str, ...]]]] = None, - shell_like_argsparser: Optional[ArgumentParser] = None, - **kwargs) -> Type[Matcher]: +def on_shell_command(cmd: Union[str, Tuple[str, ...]], + rule: Optional[Union[Rule, T_RuleChecker]] = None, + aliases: Optional[Set[Union[str, Tuple[str, ...]]]] = None, + parser: Optional[ArgumentParser] = None, + **kwargs) -> Type[Matcher]: ... @@ -227,6 +225,22 @@ class CommandGroup: state_factory: Optional[T_StateFactory] = ...) -> Type[Matcher]: ... + def shell_command( + self, + cmd: Union[str, Tuple[str, ...]], + *, + rule: Optional[Union[Rule, T_RuleChecker]] = ..., + aliases: Optional[Set[Union[str, Tuple[str, ...]]]] = ..., + parser: Optional[ArgumentParser] = ..., + permission: Optional[Permission] = ..., + handlers: Optional[List[T_Handler]] = ..., + temp: bool = ..., + priority: int = ..., + block: bool = ..., + state: Optional[T_State] = ..., + state_factory: Optional[T_StateFactory] = ...) -> Type[Matcher]: + ... + class MatcherGroup: @@ -361,6 +375,22 @@ class MatcherGroup: state_factory: Optional[T_StateFactory] = ...) -> Type[Matcher]: ... + def on_shell_command( + self, + *, + cmd: Union[str, Tuple[str, ...]], + rule: Optional[Union[Rule, T_RuleChecker]] = ..., + aliases: Optional[Set[Union[str, Tuple[str, ...]]]] = ..., + parser: Optional[ArgumentParser] = ..., + permission: Optional[Permission] = ..., + handlers: Optional[List[T_Handler]] = ..., + temp: bool = ..., + priority: int = ..., + block: bool = ..., + state: Optional[T_State] = ..., + state_factory: Optional[T_StateFactory] = ...) -> Type[Matcher]: + ... + def on_regex( self, *, diff --git a/nonebot/rule.py b/nonebot/rule.py index 0c0effc4..09a8ff70 100644 --- a/nonebot/rule.py +++ b/nonebot/rule.py @@ -9,18 +9,19 @@ \:\:\: """ -from argparse import ArgumentParser import re +import shlex import asyncio from itertools import product -from typing import Any, Dict, Union, Tuple, Optional, Callable, NoReturn, Awaitable, TYPE_CHECKING -from loguru import logger +from argparse import Namespace, ArgumentParser as ArgParser +from typing import Any, Dict, Union, Tuple, Optional, Callable, Sequence, NoReturn, Awaitable, TYPE_CHECKING from pygtrie import CharTrie from nonebot import get_driver from nonebot.log import logger from nonebot.utils import run_sync +from nonebot.exception import ParserExit from nonebot.typing import T_State, T_RuleChecker if TYPE_CHECKING: @@ -278,7 +279,28 @@ def command(*cmds: Union[str, Tuple[str, ...]]) -> Rule: return Rule(_command) -def shell_like_command(shell_like_argsparser: Optional[ArgumentParser] = None, *cmds: Union[str, Tuple[str, ...]]) -> Rule: +class ArgumentParser(ArgParser): + + def _print_message(self, message, file=None): + pass + + def exit(self, status=0, message=None): + raise ParserExit(status=status, message=message) + + def parse_args( + self, + args: Optional[Sequence[str]] = None, + namespace: Optional[Namespace] = None + ) -> Union[ParserExit, Namespace]: + try: + return super().parse_args(args=args, + namespace=namespace) # type: ignore + except ParserExit as e: + return e + + +def shell_command(*cmds: Union[str, Tuple[str, ...]], + parser: Optional[ArgumentParser] = None) -> Rule: """ :说明: @@ -286,29 +308,36 @@ def shell_like_command(shell_like_argsparser: Optional[ArgumentParser] = None, * 可以通过 ``state["_prefix"]["command"]`` 获取匹配成功的命令（例：``("test",)``），通过 ``state["_prefix"]["raw_command"]`` 获取匹配成功的原始命令文本（例：``"/test"``）。 - 添加 ``shell_like_argpsarser`` 参数后, 可以自动处理消息并将结果保存在 ``state["args"]`` 中。 - - + 可以通过 ``state["argv"]`` 获取用户输入的原始参数列表 + 添加 ``parser`` 参数后, 可以自动处理消息并将结果保存在 ``state["args"]`` 中。 :参数: - * ``shell_like_argsparser: Optional[ArgumentParser]``: ``argparse.ArgumentParser`` 对象, 是一个类 ``shell`` 的 ``argsparser`` * ``*cmds: Union[str, Tuple[str, ...]]``: 命令内容 + * ``parser: Optional[ArgumentParser]``: ``nonebot.rule.ArgumentParser`` 对象 :示例: - 使用默认 ``command_start``, ``command_sep`` 配置 + 使用默认 ``command_start``, ``command_sep`` 配置，更多示例参考 ``argparse`` 标准库文档。 - 命令 ``("test",)`` 可以匹配：``/test`` 开头的消息 - 命令 ``("test", "sub")`` 可以匹配”``/test.sub`` 开头的消息 - - 当 ``shell_like_argsparser`` 的 ``argument`` 为 ``-a`` 时且 ``action`` 为 ``store_true`` ， ``state["args"]["a"]`` 将会记录 ``True`` + .. code-block:: python + + from nonebot.rule import ArgumentParser + + parser = ArgumentParser() + parser.add_argument("-a", type=bool) + + rule = shell_command("ls", parser=parser) \:\:\:tip 提示 命令内容与后续消息间无需空格！ \:\:\: """ + if not isinstance(parser, ArgumentParser): + raise TypeError( + "`parser` must be an instance of nonebot.rule.ArgumentParser") + config = get_driver().config command_start = config.command_start command_sep = config.command_sep @@ -324,24 +353,21 @@ def shell_like_command(shell_like_argsparser: Optional[ArgumentParser] = None, * for start, sep in product(command_start, command_sep): TrieRule.add_prefix(f"{start}{sep.join(command)}", command) - async def _shell_like_command(bot: "Bot", event: "Event", state: T_State) -> bool: + async def _shell_command(bot: "Bot", event: "Event", + state: T_State) -> bool: if state["_prefix"]["command"] in commands: - if shell_like_argsparser: - message = str(event.get_message()) - strip_message = message[len( - state["_prefix"]["raw_command"]):].lstrip() - try: - args = shell_like_argsparser.parse_args( - strip_message.split()) - state["args"]=dict() - state["args"].update(**args.__dict__) - except: - pass + message = str(event.get_message()) + strip_message = message[len(state["_prefix"]["raw_command"] + ):].lstrip() + state["argv"] = shlex.split(strip_message) + if parser: + args = parser.parse_args(state["argv"]) + state["args"] = args return True else: return False - return Rule(_shell_like_command) + return Rule(_shell_command) def regex(regex: str, flags: Union[int, re.RegexFlag] = 0) -> Rule: @@ -372,7 +398,6 @@ def regex(regex: str, flags: Union[int, re.RegexFlag] = 0) -> Rule: state["_matched"] = matched.group() return True else: - state["_matched"] = None return False return Rule(_regex) diff --git a/tests/test_plugins/test_shell.py b/tests/test_plugins/test_shell.py new file mode 100644 index 00000000..5afebd6d --- /dev/null +++ b/tests/test_plugins/test_shell.py @@ -0,0 +1,15 @@ +from nonebot.adapters import Bot +from nonebot.typing import T_State +from nonebot import on_shell_command +from nonebot.rule import to_me, ArgumentParser + +parser = ArgumentParser() +parser.add_argument("-a", type=bool) + +shell = on_shell_command("ls", to_me(), parser=parser) + + +@shell.handle() +async def _(bot: Bot, state: T_State): + print(state["argv"]) + print(state["args"]) From 88bbb57c66580d63fadca7ee515268b525a26e53 Mon Sep 17 00:00:00 2001 From: AkiraXie Date: Tue, 2 Feb 2021 04:06:57 +0000 Subject: [PATCH 11/13] :memo: update api docs --- docs/api/exception.md | 21 ++++++++++ docs/api/plugin.md | 91 +++++++++++++++++++++++++++++++++++++++++-- docs/api/rule.md | 24 +++++++----- 3 files changed, 123 insertions(+), 13 deletions(-) diff --git a/docs/api/exception.md b/docs/api/exception.md index ac2d28b2..817c02a9 100644 --- a/docs/api/exception.md +++ b/docs/api/exception.md @@ -40,6 +40,27 @@ sidebarDepth: 0 +## _exception_ `ParserExit` + +基类：`nonebot.exception.NoneBotException` + + +* **说明** + + `shell command` 处理消息失败时返回的异常 + + + +* **参数** + + + * `status` + + + * `message` + + + ## _exception_ `PausedException` 基类：`nonebot.exception.NoneBotException` diff --git a/docs/api/plugin.md b/docs/api/plugin.md index 24bfb5ab..960521da 100644 --- a/docs/api/plugin.md +++ b/docs/api/plugin.md @@ -507,16 +507,16 @@ def something_else(): -## `on_shell_like_command(cmd, rule=None, aliases=None, shell_like_argsparser=None, **kwargs)` +## `on_shell_command(cmd, rule=None, aliases=None, parser=None, **kwargs)` * **说明** 注册一个支持 `shell_like` 解析参数的命令消息事件响应器。 - 与普通的 `on_command` 不同的是，在添加 `shell_like_argsparser` 参数时, 响应器会自动处理消息, + 与普通的 `on_command` 不同的是，在添加 `parser` 参数时, 响应器会自动处理消息。 - 并将 `shell_like_argsparser` 处理的参数保存在 `state["args"]` 中 + 并将用户输入的原始参数列表保存在 `state["argv"]`, `parser` 处理的参数保存在 `state["args"]` 中 @@ -532,7 +532,7 @@ def something_else(): * `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名 - * `shell_like_argsparser:Optional[ArgumentParser]`: `argparse.ArgumentParser` 对象,是一个类 `shell` 的 `argsparser` + * `parser: Optional[ArgumentParser]`: `nonebot.rule.ArgumentParser` 对象 * `permission: Optional[Permission]`: 事件响应权限 @@ -680,6 +680,32 @@ def something_else(): +### `shell_command(cmd, **kwargs)` + + +* **说明** + + 注册一个新的命令。 + + + +* **参数** + + + * `cmd: Union[str, Tuple[str, ...]]`: 命令前缀 + + + * `**kwargs`: 其他传递给 `on_command` 的参数，将会覆盖命令组默认值 + + + +* **返回** + + + * `Type[Matcher]` + + + ## _class_ `MatcherGroup` 基类：`object` @@ -1127,6 +1153,63 @@ def something_else(): +### `on_shell_command(cmd, rule=None, aliases=None, parser=None, **kwargs)` + + +* **说明** + + +注册一个支持 `shell_like` 解析参数的命令消息事件响应器。 + +与普通的 `on_command` 不同的是，在添加 `parser` 参数时, 响应器会自动处理消息。 + +并将用户输入的原始参数列表保存在 `state["argv"]`, `parser` 处理的参数保存在 `state["args"]` 中 + + +* **参数** + + + +* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容 + + +* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 + + +* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名 + + +* `parser: Optional[ArgumentParser]`: `nonebot.rule.ArgumentParser` 对象 + + +* `permission: Optional[Permission]`: 事件响应权限 + + +* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 + + +* `temp: bool`: 是否为临时事件响应器（仅执行一次） + + +* `priority: int`: 事件响应器优先级 + + +* `block: bool`: 是否阻止事件向更低优先级传递 + + +* `state: Optional[T_State]`: 默认 state + + +* `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 + + +* **返回** + + + +* `Type[Matcher]` + + ### `on_regex(pattern, flags=0, rule=None, **kwargs)` diff --git a/docs/api/rule.md b/docs/api/rule.md index e9a8ce4d..b569a400 100644 --- a/docs/api/rule.md +++ b/docs/api/rule.md @@ -170,7 +170,7 @@ Rule(async_function, run_sync(sync_function)) ::: -## `shell_like_command(shell_like_argsparser=None, *cmds)` +## `shell_command(*cmds, parser=None)` * **说明** @@ -179,29 +179,35 @@ Rule(async_function, run_sync(sync_function)) 可以通过 `state["_prefix"]["command"]` 获取匹配成功的命令（例：`("test",)`），通过 `state["_prefix"]["raw_command"]` 获取匹配成功的原始命令文本（例：`"/test"`）。 - 添加 `shell_like_argpsarser` 参数后, 可以自动处理消息并将结果保存在 `state["args"]` 中。 + 可以通过 `state["argv"]` 获取用户输入的原始参数列表 + + 添加 `parser` 参数后, 可以自动处理消息并将结果保存在 `state["args"]` 中。 * **参数** - * `shell_like_argsparser: Optional[ArgumentParser]`: `argparse.ArgumentParser` 对象, 是一个类 `shell` 的 `argsparser` - - * `*cmds: Union[str, Tuple[str, ...]]`: 命令内容 + * `parser: Optional[ArgumentParser]`: `nonebot.rule.ArgumentParser` 对象 + + * **示例** - 使用默认 `command_start`, `command_sep` 配置 + 使用默认 `command_start`, `command_sep` 配置，更多示例参考 `argparse` 标准库文档。 - 命令 `("test",)` 可以匹配：`/test` 开头的消息 - 命令 `("test", "sub")` 可以匹配”`/test.sub` 开头的消息 - 当 `shell_like_argsparser` 的 `argument` 为 `-a` 时且 `action` 为 `store_true` ， `state["args"]["a"]` 将会记录 `True` +```python +from nonebot.rule import ArgumentParser +parser = ArgumentParser() +parser.add_argument("-a", type=bool) + +rule = shell_command("ls", parser=parser) +``` :::tip 提示 命令内容与后续消息间无需空格！ From a54fd2f23582090a5043ba87537e70a263231b24 Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Tue, 2 Feb 2021 12:15:20 +0800 Subject: [PATCH 12/13] :bulb: update docstring --- nonebot/__init__.py | 1 + nonebot/rule.py | 27 +++++++++++++++------------ 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/nonebot/__init__.py b/nonebot/__init__.py index 9f9a0c37..db0d8277 100644 --- a/nonebot/__init__.py +++ b/nonebot/__init__.py @@ -12,6 +12,7 @@ - ``on_endswith`` => ``nonebot.plugin.on_endswith`` - ``on_keyword`` => ``nonebot.plugin.on_keyword`` - ``on_command`` => ``nonebot.plugin.on_command`` +- ``on_shell_command`` => ``nonebot.plugin.on_shell_command`` - ``on_regex`` => ``nonebot.plugin.on_regex`` - ``CommandGroup`` => ``nonebot.plugin.CommandGroup`` - ``Matchergroup`` => ``nonebot.plugin.MatcherGroup`` diff --git a/nonebot/rule.py b/nonebot/rule.py index ca0aa6db..eb00de57 100644 --- a/nonebot/rule.py +++ b/nonebot/rule.py @@ -280,6 +280,11 @@ def command(*cmds: Union[str, Tuple[str, ...]]) -> Rule: class ArgumentParser(ArgParser): + """ + :说明: + + ``shell_like`` 命令参数解析器，解析出错时不会退出程序。 + """ def _print_message(self, message, file=None): pass @@ -287,16 +292,11 @@ class ArgumentParser(ArgParser): def exit(self, status=0, message=None): raise ParserExit(status=status, message=message) - def parse_args( - self, - args: Optional[Sequence[str]] = None, - namespace: Optional[Namespace] = None - ) -> Union[ParserExit, Namespace]: - try: - return super().parse_args(args=args, - namespace=namespace) # type: ignore - except ParserExit as e: - return e + def parse_args(self, + args: Optional[Sequence[str]] = None, + namespace: Optional[Namespace] = None) -> Namespace: + return super().parse_args(args=args, + namespace=namespace) # type: ignore def shell_command(*cmds: Union[str, Tuple[str, ...]], @@ -361,8 +361,11 @@ def shell_command(*cmds: Union[str, Tuple[str, ...]], ):].lstrip() state["argv"] = shlex.split(strip_message) if parser: - args = parser.parse_args(state["argv"]) - state["args"] = args + try: + args = parser.parse_args(state["argv"]) + state["args"] = args + except ParserExit as e: + state["args"] = e return True else: return False From 223b9bc887b8bd0239ac7ac2a7edab90bc573b95 Mon Sep 17 00:00:00 2001 From: AkiraXie Date: Tue, 2 Feb 2021 04:16:37 +0000 Subject: [PATCH 13/13] :memo: update api docs --- docs/api/nonebot.md | 3 +++ docs/api/rule.md | 11 +++++++++++ 2 files changed, 14 insertions(+) diff --git a/docs/api/nonebot.md b/docs/api/nonebot.md index d2ef4eb4..58f7fbda 100644 --- a/docs/api/nonebot.md +++ b/docs/api/nonebot.md @@ -34,6 +34,9 @@ sidebarDepth: 0 * `on_command` => `nonebot.plugin.on_command` +* `on_shell_command` => `nonebot.plugin.on_shell_command` + + * `on_regex` => `nonebot.plugin.on_regex` diff --git a/docs/api/rule.md b/docs/api/rule.md index b569a400..25a9fe13 100644 --- a/docs/api/rule.md +++ b/docs/api/rule.md @@ -170,6 +170,17 @@ Rule(async_function, run_sync(sync_function)) ::: +## _class_ `ArgumentParser` + +基类：`argparse.ArgumentParser` + + +* **说明** + + `shell_like` 命令参数解析器，解析出错时不会退出程序。 + + + ## `shell_command(*cmds, parser=None)`