""" 事件处理 ======== NoneBot 内部处理并按优先级分发事件给所有事件响应器,提供了多个插槽以进行事件的预处理等。 """ import asyncio from datetime import datetime from typing import Set, Type, Optional, Iterable, TYPE_CHECKING from nonebot.log import logger from nonebot.rule import TrieRule from nonebot.utils import escape_tag from nonebot.matcher import matchers, Matcher from nonebot.exception import IgnoredException, StopPropagation from nonebot.typing import State, EventPreProcessor, RunPreProcessor, EventPostProcessor, RunPostProcessor if TYPE_CHECKING: from nonebot.adapters import BaseBot as Bot, BaseEvent as Event _event_preprocessors: Set[EventPreProcessor] = set() _event_postprocessors: Set[EventPostProcessor] = set() _run_preprocessors: Set[RunPreProcessor] = set() _run_postprocessors: Set[RunPostProcessor] = set() def event_preprocessor(func: EventPreProcessor) -> EventPreProcessor: """ :说明: 事件预处理。装饰一个函数,使它在每次接收到事件并分发给各响应器之前执行。 :参数: 事件预处理函数接收三个参数。 * ``bot: Bot``: Bot 对象 * ``event: Event``: Event 对象 * ``state: State``: 当前 State """ _event_preprocessors.add(func) return func def event_postprocessor(func: EventPostProcessor) -> EventPostProcessor: """ :说明: 事件后处理。装饰一个函数,使它在每次接收到事件并分发给各响应器之后执行。 :参数: 事件后处理函数接收三个参数。 * ``bot: Bot``: Bot 对象 * ``event: Event``: Event 对象 * ``state: State``: 当前事件运行前 State """ _event_postprocessors.add(func) return func def run_preprocessor(func: RunPreProcessor) -> RunPreProcessor: """ :说明: 运行预处理。装饰一个函数,使它在每次事件响应器运行前执行。 :参数: 运行预处理函数接收四个参数。 * ``matcher: Matcher``: 当前要运行的事件响应器 * ``bot: Bot``: Bot 对象 * ``event: Event``: Event 对象 * ``state: State``: 当前 State """ _run_preprocessors.add(func) return func def run_postprocessor(func: RunPostProcessor) -> RunPostProcessor: """ :说明: 运行后处理。装饰一个函数,使它在每次事件响应器运行后执行。 :参数: 运行后处理函数接收五个参数。 * ``matcher: Matcher``: 运行完毕的事件响应器 * ``exception: Optional[Exception]``: 事件响应器运行错误(如果存在) * ``bot: Bot``: Bot 对象 * ``event: Event``: Event 对象 * ``state: State``: 当前 State """ _run_postprocessors.add(func) return func async def _check_matcher(priority: int, bot: "Bot", event: "Event", state: State) -> Iterable[Type[Matcher]]: current_matchers = matchers[priority].copy() async def _check(Matcher: Type[Matcher], bot: "Bot", event: "Event", state: State) -> Optional[Type[Matcher]]: try: if (not Matcher.expire_time or datetime.now() <= Matcher.expire_time ) and await Matcher.check_perm( bot, event) and await Matcher.check_rule(bot, event, state): return Matcher except Exception as e: logger.opt(colors=True, exception=e).error( f"Rule check failed for {Matcher}." ) return None async def _check_expire(Matcher: Type[Matcher]) -> Optional[Type[Matcher]]: if Matcher.temp or (Matcher.expire_time and datetime.now() > Matcher.expire_time): return Matcher return None checking_tasks = [ _check(Matcher, bot, event, state) for Matcher in current_matchers ] checking_expire_tasks = [ _check_expire(Matcher) for Matcher in current_matchers ] results = await asyncio.gather(*checking_tasks, return_exceptions=True) expired = await asyncio.gather(*checking_expire_tasks) for expired_matcher in filter(lambda x: x and x in results, expired): try: matchers[priority].remove(expired_matcher) except Exception: pass return filter(lambda x: x, results) async def _run_matcher(Matcher: Type[Matcher], bot: "Bot", event: "Event", state: State) -> None: logger.info(f"Event will be handled by {Matcher}") matcher = Matcher() coros = list( map(lambda x: x(matcher, bot, event, state), _run_preprocessors)) if coros: try: await asyncio.gather(*coros) except IgnoredException: logger.opt(colors=True).info( f"Matcher {matcher} running is cancelled") return except Exception as e: logger.opt(colors=True, exception=e).error( "Error when running RunPreProcessors. " "Running cancelled!") return exception = None try: logger.debug(f"Running matcher {matcher}") await matcher.run(bot, event, state) except StopPropagation as e: exception = e except Exception as e: logger.opt(colors=True, exception=e).error( f"Running matcher {matcher} failed." ) exception = e coros = list( map(lambda x: x(matcher, exception, bot, event, state), _run_postprocessors)) if coros: try: await asyncio.gather(*coros) except Exception as e: logger.opt(colors=True, exception=e).error( "Error when running RunPostProcessors" ) if matcher.block or isinstance(exception, StopPropagation): raise StopPropagation return async def handle_event(bot: "Bot", event: "Event"): """ :说明: 处理一个事件。调用该函数以实现分发事件。 :参数: * ``bot: Bot``: Bot 对象 * ``event: Event``: Event 对象 :示例: .. code-block:: python import asyncio asyncio.create_task(handle_event(bot, event)) """ show_log = True log_msg = f"{bot.type.upper()} | {event.self_id} [{event.name}]: " if event.type == "message": log_msg += f"Message {event.id} from " log_msg += str(event.user_id) if event.detail_type == "group": log_msg += f"@[群:{event.group_id}]:" log_msg += ' "' + "".join( map( lambda x: escape_tag(str(x)) if x.type == "text" else f"{escape_tag(str(x))}", event.message)) + '"' # type: ignore elif event.type == "notice": log_msg += f"Notice {event.raw_event}" elif event.type == "request": log_msg += f"Request {event.raw_event}" elif event.type == "meta_event": # log_msg += f"MetaEvent {event.detail_type}" show_log = False if show_log: logger.opt(colors=True).info(log_msg) state = {} coros = list(map(lambda x: x(bot, event, state), _event_preprocessors)) if coros: try: logger.debug("Running PreProcessors...") await asyncio.gather(*coros) except IgnoredException: logger.opt( colors=True).info(f"Event {event.name} is ignored") return except Exception as e: logger.opt(colors=True, exception=e).error( "Error when running EventPreProcessors. " "Event ignored!") return # Trie Match _, _ = TrieRule.get_value(bot, event, state) break_flag = False for priority in sorted(matchers.keys()): if break_flag: break if show_log: logger.debug(f"Checking for matchers in priority {priority}...") run_matchers = await _check_matcher(priority, bot, event, state) pending_tasks = [ _run_matcher(matcher, bot, event, state.copy()) for matcher in run_matchers ] results = await asyncio.gather(*pending_tasks, return_exceptions=True) for result in results: if isinstance(result, StopPropagation): if not break_flag: break_flag = True logger.debug("Stop event propagation") coros = list(map(lambda x: x(bot, event, state), _event_postprocessors)) if coros: try: logger.debug("Running PostProcessors...") await asyncio.gather(*coros) except Exception as e: logger.opt(colors=True, exception=e).error( "Error when running EventPostProcessors" )