✨ allow using matcher subclass (#1815)

2025-09-06 12:06:45 +00:00 · 2023-03-17 15:48:48 +08:00
parent 7822cabe32
commit 8f44df371a
5 changed files with 244 additions and 345 deletions
--- a/nonebot/internal/matcher/matcher.py
+++ b/nonebot/internal/matcher/matcher.py
@ -1,5 +1,6 @@
 from types import ModuleType
 from contextvars import ContextVar
+from typing_extensions import Self
 from datetime import datetime, timedelta
 from contextlib import AsyncExitStack, contextmanager
 from typing import (
@ -81,7 +82,7 @@ class MatcherMeta(type):

    def __repr__(self) -> str:
        return (
-            f"Matcher(type={self.type!r}"
+            f"{self.__name__}(type={self.type!r}"
            + (f", module={self.module_name}" if self.module_name else "")
            + ")"
        )
@ -140,7 +141,7 @@ class Matcher(metaclass=MatcherMeta):

    def __repr__(self) -> str:
        return (
-            f"Matcher(type={self.type!r}"
+            f"{self.__class__.__name__}(type={self.type!r}"
            + (f", module={self.module_name}" if self.module_name else "")
            + ")"
        )
@ -164,7 +165,7 @@ class Matcher(metaclass=MatcherMeta):
        default_permission_updater: Optional[
            Union[T_PermissionUpdater, Dependent[Permission]]
        ] = None,
-    ) -> Type["Matcher"]:
+    ) -> Type[Self]:
        """
        创建一个新的事件响应器，并存储至 `matchers <#matchers>`_

@ -185,8 +186,8 @@ class Matcher(metaclass=MatcherMeta):
            Type[Matcher]: 新的事件响应器类
        """
        NewMatcher = type(
-            "Matcher",
-            (Matcher,),
+            cls.__name__,
+            (cls,),
            {
                "plugin": plugin,
                "module": module,
@ -763,7 +764,7 @@ class Matcher(metaclass=MatcherMeta):
                bot, event, stack, dependency_cache
            )

-            Matcher.new(
+            self.new(
                type_,
                Rule(),
                permission,
@ -784,7 +785,7 @@ class Matcher(metaclass=MatcherMeta):
                bot, event, stack, dependency_cache
            )

-            Matcher.new(
+            self.new(
                type_,
                Rule(),
                permission,
--- a/nonebot/plugin/on.py
+++ b/nonebot/plugin/on.py
@ -89,21 +89,12 @@ def on(
    return matcher


-def on_metaevent(
-    rule: Optional[Union[Rule, T_RuleChecker]] = None,
-    *,
-    handlers: Optional[List[Union[T_Handler, Dependent]]] = None,
-    temp: bool = False,
-    expire_time: Optional[Union[datetime, timedelta]] = None,
-    priority: int = 1,
-    block: bool = False,
-    state: Optional[T_State] = None,
-    _depth: int = 0,
-) -> Type[Matcher]:
+def on_metaevent(*args, _depth: int = 0, **kwargs) -> Type[Matcher]:
    """注册一个元事件响应器。

    参数:
        rule: 事件响应规则
+        permission: 事件响应权限
        handlers: 事件处理函数列表
        temp: 是否为临时事件响应器（仅执行一次）
        expire_time: 事件响应器最终有效时间点，过时即被删除
@ -111,36 +102,10 @@ def on_metaevent(
        block: 是否阻止事件向更低优先级传递
        state: 默认 state
    """
-    plugin_chain = _current_plugin_chain.get()
-    matcher = Matcher.new(
-        "meta_event",
-        Rule() & rule,
-        Permission(),
-        temp=temp,
-        expire_time=expire_time,
-        priority=priority,
-        block=block,
-        handlers=handlers,
-        plugin=plugin_chain[-1] if plugin_chain else None,
-        module=_get_matcher_module(_depth + 1),
-        default_state=state,
-    )
-    _store_matcher(matcher)
-    return matcher
+    return on("meta_event", *args, **kwargs, _depth=_depth + 1)


-def on_message(
-    rule: Optional[Union[Rule, T_RuleChecker]] = None,
-    permission: Optional[Union[Permission, T_PermissionChecker]] = None,
-    *,
-    handlers: Optional[List[Union[T_Handler, Dependent]]] = None,
-    temp: bool = False,
-    expire_time: Optional[Union[datetime, timedelta]] = None,
-    priority: int = 1,
-    block: bool = True,
-    state: Optional[T_State] = None,
-    _depth: int = 0,
-) -> Type[Matcher]:
+def on_message(*args, _depth: int = 0, **kwargs) -> Type[Matcher]:
    """注册一个消息事件响应器。

    参数:
@ -153,39 +118,15 @@ def on_message(
        block: 是否阻止事件向更低优先级传递
        state: 默认 state
    """
-    plugin_chain = _current_plugin_chain.get()
-    matcher = Matcher.new(
-        "message",
-        Rule() & rule,
-        Permission() | permission,
-        temp=temp,
-        expire_time=expire_time,
-        priority=priority,
-        block=block,
-        handlers=handlers,
-        plugin=plugin_chain[-1] if plugin_chain else None,
-        module=_get_matcher_module(_depth + 1),
-        default_state=state,
-    )
-    _store_matcher(matcher)
-    return matcher
+    return on("message", *args, **kwargs, _depth=_depth + 1)


-def on_notice(
-    rule: Optional[Union[Rule, T_RuleChecker]] = None,
-    *,
-    handlers: Optional[List[Union[T_Handler, Dependent]]] = None,
-    temp: bool = False,
-    expire_time: Optional[Union[datetime, timedelta]] = None,
-    priority: int = 1,
-    block: bool = False,
-    state: Optional[T_State] = None,
-    _depth: int = 0,
-) -> Type[Matcher]:
+def on_notice(*args, _depth: int = 0, **kwargs) -> Type[Matcher]:
    """注册一个通知事件响应器。

    参数:
        rule: 事件响应规则
+        permission: 事件响应权限
        handlers: 事件处理函数列表
        temp: 是否为临时事件响应器（仅执行一次）
        expire_time: 事件响应器最终有效时间点，过时即被删除
@ -193,39 +134,15 @@ def on_notice(
        block: 是否阻止事件向更低优先级传递
        state: 默认 state
    """
-    plugin_chain = _current_plugin_chain.get()
-    matcher = Matcher.new(
-        "notice",
-        Rule() & rule,
-        Permission(),
-        temp=temp,
-        expire_time=expire_time,
-        priority=priority,
-        block=block,
-        handlers=handlers,
-        plugin=plugin_chain[-1] if plugin_chain else None,
-        module=_get_matcher_module(_depth + 1),
-        default_state=state,
-    )
-    _store_matcher(matcher)
-    return matcher
+    return on("notice", *args, **kwargs, _depth=_depth + 1)


-def on_request(
-    rule: Optional[Union[Rule, T_RuleChecker]] = None,
-    *,
-    handlers: Optional[List[Union[T_Handler, Dependent]]] = None,
-    temp: bool = False,
-    expire_time: Optional[Union[datetime, timedelta]] = None,
-    priority: int = 1,
-    block: bool = False,
-    state: Optional[T_State] = None,
-    _depth: int = 0,
-) -> Type[Matcher]:
+def on_request(*args, _depth: int = 0, **kwargs) -> Type[Matcher]:
    """注册一个请求事件响应器。

    参数:
        rule: 事件响应规则
+        permission: 事件响应权限
        handlers: 事件处理函数列表
        temp: 是否为临时事件响应器（仅执行一次）
        expire_time: 事件响应器最终有效时间点，过时即被删除
@ -233,22 +150,7 @@ def on_request(
        block: 是否阻止事件向更低优先级传递
        state: 默认 state
    """
-    plugin_chain = _current_plugin_chain.get()
-    matcher = Matcher.new(
-        "request",
-        Rule() & rule,
-        Permission(),
-        temp=temp,
-        expire_time=expire_time,
-        priority=priority,
-        block=block,
-        handlers=handlers,
-        plugin=plugin_chain[-1] if plugin_chain else None,
-        module=_get_matcher_module(_depth + 1),
-        default_state=state,
-    )
-    _store_matcher(matcher)
-    return matcher
+    return on("request", *args, **kwargs, _depth=_depth + 1)


 def on_startswith(
@ -593,6 +495,7 @@ class MatcherGroup(_Group):

        参数:
            rule: 事件响应规则
+            permission: 事件响应权限
            handlers: 事件处理函数列表
            temp: 是否为临时事件响应器（仅执行一次）
            expire_time: 事件响应器最终有效时间点，过时即被删除
@ -628,6 +531,7 @@ class MatcherGroup(_Group):

        参数:
            rule: 事件响应规则
+            permission: 事件响应权限
            handlers: 事件处理函数列表
            temp: 是否为临时事件响应器（仅执行一次）
            expire_time: 事件响应器最终有效时间点，过时即被删除
@ -645,6 +549,7 @@ class MatcherGroup(_Group):

        参数:
            rule: 事件响应规则
+            permission: 事件响应权限
            handlers: 事件处理函数列表
            temp: 是否为临时事件响应器（仅执行一次）
            expire_time: 事件响应器最终有效时间点，过时即被删除
--- a/nonebot/plugin/on.pyi
+++ b/nonebot/plugin/on.pyi
@ -23,6 +23,7 @@ def on(
 ) -> Type[Matcher]: ...
 def on_metaevent(
    rule: Optional[Union[Rule, T_RuleChecker]] = ...,
+    permission: Optional[Union[Permission, T_PermissionChecker]] = ...,
    *,
    handlers: Optional[List[Union[T_Handler, Dependent]]] = ...,
    temp: bool = ...,
@ -44,6 +45,7 @@ def on_message(
 ) -> Type[Matcher]: ...
 def on_notice(
    rule: Optional[Union[Rule, T_RuleChecker]] = ...,
+    permission: Optional[Union[Permission, T_PermissionChecker]] = ...,
    *,
    handlers: Optional[List[Union[T_Handler, Dependent]]] = ...,
    temp: bool = ...,
@ -54,6 +56,7 @@ def on_notice(
 ) -> Type[Matcher]: ...
 def on_request(
    rule: Optional[Union[Rule, T_RuleChecker]] = ...,
+    permission: Optional[Union[Permission, T_PermissionChecker]] = ...,
    *,
    handlers: Optional[List[Union[T_Handler, Dependent]]] = ...,
    temp: bool = ...,
@ -243,6 +246,7 @@ class MatcherGroup:
        self,
        *,
        rule: Optional[Union[Rule, T_RuleChecker]] = ...,
+        permission: Optional[Union[Permission, T_PermissionChecker]] = ...,
        handlers: Optional[List[Union[T_Handler, Dependent]]] = ...,
        temp: bool = ...,
        expire_time: Optional[Union[datetime, timedelta]] = ...,
@ -266,6 +270,7 @@ class MatcherGroup:
        self,
        *,
        rule: Optional[Union[Rule, T_RuleChecker]] = ...,
+        permission: Optional[Union[Permission, T_PermissionChecker]] = ...,
        handlers: Optional[List[Union[T_Handler, Dependent]]] = ...,
        temp: bool = ...,
        expire_time: Optional[Union[datetime, timedelta]] = ...,
@ -277,6 +282,7 @@ class MatcherGroup:
        self,
        *,
        rule: Optional[Union[Rule, T_RuleChecker]] = ...,
+        permission: Optional[Union[Permission, T_PermissionChecker]] = ...,
        handlers: Optional[List[Union[T_Handler, Dependent]]] = ...,
        temp: bool = ...,
        expire_time: Optional[Union[datetime, timedelta]] = ...,