nonebot2/nonebot/typing.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

from types import ModuleType
from typing import NoReturn, TYPE_CHECKING
from typing import Any, Set, List, Dict, Type, Tuple, Mapping
from typing import Union, TypeVar, Optional, Iterable, Callable, Awaitable

# import some modules needed when checking types
if TYPE_CHECKING:
    from nonebot.rule import Rule as RuleClass
    from nonebot.matcher import Matcher as MatcherClass
    from nonebot.drivers import BaseDriver, BaseWebSocket
    from nonebot.permission import Permission as PermissionClass
    from nonebot.adapters import BaseBot, BaseEvent, BaseMessage, BaseMessageSegment


def overrides(InterfaceClass: object):

    def overrider(func: Callable) -> Callable:
        assert func.__name__ in dir(
            InterfaceClass), f"Error method: {func.__name__}"
        return func

    return overrider


Driver = TypeVar("Driver", bound="BaseDriver")
WebSocket = TypeVar("WebSocket", bound="BaseWebSocket")

Bot = TypeVar("Bot", bound="BaseBot")
Event = TypeVar("Event", bound="BaseEvent")
Message = TypeVar("Message", bound="BaseMessage")
MessageSegment = TypeVar("MessageSegment", bound="BaseMessageSegment")

PreProcessor = Callable[[Bot, Event, dict], Union[Awaitable[None],
                                                  Awaitable[NoReturn]]]

Matcher = TypeVar("Matcher", bound="MatcherClass")
Handler = Callable[[Bot, Event, dict], Union[Awaitable[None],
                                             Awaitable[NoReturn]]]
Rule = TypeVar("Rule", bound="RuleClass")
RuleChecker = Callable[[Bot, Event, dict], Awaitable[bool]]
Permission = TypeVar("Permission", bound="PermissionClass")
PermissionChecker = Callable[[Bot, Event], Awaitable[bool]]
ArgsParser = Callable[[Bot, Event, dict], Union[Awaitable[None],
                                                Awaitable[NoReturn]]]