📝 update handler doc

This commit is contained in:
yanyongyu
2022-01-06 17:51:32 +08:00
parent 381e5e4a76
commit 89ae275793
10 changed files with 158 additions and 45 deletions

View File

@ -46,7 +46,6 @@ from nonebot.typing import (
Any,
T_State,
T_Handler,
T_ArgsParser,
T_TypeUpdater,
T_DependencyCache,
T_PermissionUpdater,
@ -223,7 +222,6 @@ class Matcher(metaclass=MatcherMeta):
module: Optional[ModuleType] = None,
expire_time: Optional[datetime] = None,
default_state: Optional[T_State] = None,
default_parser: Optional[T_ArgsParser] = None,
default_type_updater: Optional[T_TypeUpdater] = None,
default_permission_updater: Optional[T_PermissionUpdater] = None,
) -> Type["Matcher"]:
@ -276,7 +274,6 @@ class Matcher(metaclass=MatcherMeta):
"priority": priority,
"block": block,
"_default_state": default_state or {},
"_default_parser": default_parser,
"_default_type_updater": default_type_updater,
"_default_permission_updater": default_permission_updater,
},
@ -344,22 +341,6 @@ class Matcher(metaclass=MatcherMeta):
bot, event, state, stack, dependency_cache
)
@classmethod
def args_parser(cls, func: T_ArgsParser) -> T_ArgsParser:
"""
:说明:
装饰一个函数来更改当前事件响应器的默认参数解析函数
:参数:
* ``func: T_ArgsParser``: 参数解析函数
"""
cls._default_parser = Dependent[None].parse(
call=func, allow_types=cls.HANDLER_PARAM_TYPES
)
return func
@classmethod
def type_updater(cls, func: T_TypeUpdater) -> T_TypeUpdater:
"""
@ -777,7 +758,6 @@ class Matcher(metaclass=MatcherMeta):
module=self.module,
expire_time=datetime.now() + bot.config.session_expire_timeout,
default_state=self.state,
default_parser=self.__class__._default_parser,
default_type_updater=self.__class__._default_type_updater,
default_permission_updater=self.__class__._default_permission_updater,
)
@ -797,7 +777,6 @@ class Matcher(metaclass=MatcherMeta):
module=self.module,
expire_time=datetime.now() + bot.config.session_expire_timeout,
default_state=self.state,
default_parser=self.__class__._default_parser,
default_type_updater=self.__class__._default_type_updater,
default_permission_updater=self.__class__._default_permission_updater,
)

View File

@ -197,23 +197,6 @@ T_Handler = Callable[..., Any]
Handler 处理函数。
"""
T_ArgsParser = Callable[..., Union[None, Awaitable[None]]]
"""
:类型: ``Callable[..., Union[None, Awaitable[None]]]``
:依赖参数:
* ``DependParam``: 子依赖参数
* ``BotParam``: Bot 对象
* ``EventParam``: Event 对象
* ``StateParam``: State 对象
* ``MatcherParam``: Matcher 对象
* ``DefaultParam``: 带有默认值的参数
:说明:
ArgsParser 即消息参数解析函数,在 Matcher.got 获取参数时被运行。
"""
T_TypeUpdater = Callable[..., Union[str, Awaitable[str]]]
"""
:类型: ``Callable[..., Union[None, Awaitable[None]]]``