💡 add docstrings

This commit is contained in:
yanyongyu
2022-01-18 23:46:10 +08:00
parent 608cf859c8
commit 4701537a48
8 changed files with 153 additions and 194 deletions

View File

@ -1,5 +1,4 @@
"""
## 事件处理
"""本模块定义了事件处理主要流程。
NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供了多个插槽以进行事件的预处理等。
@ -71,9 +70,7 @@ RUN_POSTPCS_PARAMS = [
def event_preprocessor(func: T_EventPreProcessor) -> T_EventPreProcessor:
"""
事件预处理。装饰一个函数,使它在每次接收到事件并分发给各响应器之前执行。
"""
"""事件预处理。装饰一个函数,使它在每次接收到事件并分发给各响应器之前执行。"""
_event_preprocessors.add(
Dependent[None].parse(call=func, allow_types=EVENT_PCS_PARAMS)
)
@ -81,9 +78,7 @@ def event_preprocessor(func: T_EventPreProcessor) -> T_EventPreProcessor:
def event_postprocessor(func: T_EventPostProcessor) -> T_EventPostProcessor:
"""
事件后处理。装饰一个函数,使它在每次接收到事件并分发给各响应器之后执行。
"""
"""事件后处理。装饰一个函数,使它在每次接收到事件并分发给各响应器之后执行。"""
_event_postprocessors.add(
Dependent[None].parse(call=func, allow_types=EVENT_PCS_PARAMS)
)
@ -91,9 +86,7 @@ def event_postprocessor(func: T_EventPostProcessor) -> T_EventPostProcessor:
def run_preprocessor(func: T_RunPreProcessor) -> T_RunPreProcessor:
"""
运行预处理。装饰一个函数,使它在每次事件响应器运行前执行。
"""
"""运行预处理。装饰一个函数,使它在每次事件响应器运行前执行。"""
_run_preprocessors.add(
Dependent[None].parse(call=func, allow_types=RUN_PREPCS_PARAMS)
)
@ -101,9 +94,7 @@ def run_preprocessor(func: T_RunPreProcessor) -> T_RunPreProcessor:
def run_postprocessor(func: T_RunPostProcessor) -> T_RunPostProcessor:
"""
运行后处理。装饰一个函数,使它在每次事件响应器运行后执行。
"""
"""运行后处理。装饰一个函数,使它在每次事件响应器运行后执行。"""
_run_postprocessors.add(
Dependent[None].parse(call=func, allow_types=RUN_POSTPCS_PARAMS)
)
@ -236,8 +227,7 @@ async def _run_matcher(
async def handle_event(bot: "Bot", event: "Event") -> None:
"""
处理一个事件。调用该函数以实现分发事件。
"""处理一个事件。调用该函数以实现分发事件。
参数:
bot: Bot 对象