Source code for wsrpc_aiohttp.websocket.abc

import asyncio
from abc import ABC, abstractmethod
from enum import IntEnum
from typing import (
    Any, Callable, Coroutine, DefaultDict, Dict, Mapping, Set, Tuple, Type,
    TypeVar, Union,
)

from aiohttp import WSMessage
from aiohttp.web import Request
from aiohttp.web_ws import WebSocketResponse


try:
    from typing import Concatenate, ParamSpec
except ImportError:
    from typing_extensions import Concatenate, ParamSpec


FrameMappingItemType = Mapping[IntEnum, Callable[[WSMessage], Any]]
LocksCollectionType = DefaultDict[int, asyncio.Lock]
FutureCollectionType = DefaultDict[int, asyncio.Future]
TimeoutType = Union[int, float]
LoadsType = Callable[..., Any]
DumpsType = Callable[..., str]


[docs]class AbstractWebSocket(ABC): @abstractmethod def __init__(self, request: Request): raise NotImplementedError(request)
[docs] @classmethod @abstractmethod def configure( cls, keepalive_timeout: TimeoutType, client_timeout: TimeoutType, max_concurrent_requests: int, ) -> None: """ Configures the handler class :param keepalive_timeout: sets timeout of client pong response :param client_timeout: internal lock timeout :param max_concurrent_requests: how many concurrent requests might be performed by each client """ raise NotImplementedError(( keepalive_timeout, client_timeout, max_concurrent_requests, ))
@abstractmethod def __await__(self) -> Coroutine: raise NotImplementedError
[docs] @abstractmethod async def authorize(self) -> bool: """ Special method for authorize client. If this method return True then access allowed, otherwise ``403 Forbidden`` will be sent. This method will be called before socket connection establishment. By default everyone has access. You have to inherit this class and change this behaviour. .. note:: You can validate some headers (self.request.headers) or check cookies (self.reauest.cookies). """ raise NotImplementedError
async def __handle_request(self) -> WebSocketResponse: raise NotImplementedError
[docs] @classmethod @abstractmethod def broadcast( cls, func, callback=None, return_exceptions=True, **kwargs: Mapping[str, Any] ) -> asyncio.Task: """ Call remote function on all connected clients :param func: Remote route name :param callback: Function which receive responses :param return_exceptions: Return exceptions of client calls instead of raise a first one """ raise NotImplementedError
[docs] async def close(self, message: Any = None): """ Cancel all pending tasks and stop this socket connection """ raise NotImplementedError
class AbstractRoute: # noinspection PyUnusedLocal def __init__(self, socket: AbstractWebSocket): pass @property def socket(self) -> AbstractWebSocket: raise NotImplementedError @property def loop(self) -> asyncio.AbstractEventLoop: raise NotImplementedError class ProxyMethod: __slots__ = "__call", "__name" def __init__(self, call_method, name): self.__call = call_method self.__name = name def __call__(self, **kwargs): return self.__call(self.__name, **kwargs) def __getattr__(self, item: str): return self.__class__(self.__call, ".".join((self.__name, item))) class Proxy: __slots__ = ("__call",) def __init__(self, call_method): self.__call = call_method def __getattr__(self, item: str): return ProxyMethod(self.__call, item) EventType = Mapping[str, Any] EventListenerType = Callable[[EventType], Any]
[docs]class WSRPCBase(ABC): @abstractmethod def __init__( self, loop: asyncio.AbstractEventLoop = None, timeout: Union[int, float] = None, ): raise NotImplementedError((loop, timeout))
[docs] @abstractmethod async def close(self, message: WSMessage = None): """ Cancel all pending tasks """ raise NotImplementedError
@abstractmethod async def handle_binary(self, message: WSMessage) -> None: raise NotImplementedError @abstractmethod async def handle_message(self, message: WSMessage): raise NotImplementedError @abstractmethod async def _on_message(self, msg: WSMessage): raise NotImplementedError @classmethod @abstractmethod def get_routes(cls) -> Mapping[str, "RouteType"]: raise NotImplementedError @classmethod def get_clients(cls) -> Dict[str, "AbstractWSRPC"]: raise NotImplementedError @property @abstractmethod def routes(self) -> Dict[str, "RouteType"]: raise NotImplementedError @property def clients(self) -> Dict[str, "AbstractWSRPC"]: """ Property which contains the socket clients """ raise NotImplementedError @abstractmethod def prepare_args(self, args) -> Tuple[Tuple[Any, ...], Dict[str, Any]]: raise NotImplementedError @staticmethod @abstractmethod def is_route(func) -> bool: raise NotImplementedError @abstractmethod async def handle_method( self, method: str, serial: int, args: Tuple[Tuple[Any, ...]], kwargs: Mapping[str, Any], ) -> None: raise NotImplementedError @abstractmethod async def handle_result(self, serial: int, result: Any): raise NotImplementedError @abstractmethod async def handle_error(self, serial, error): raise NotImplementedError @abstractmethod async def handle_event(self, event): raise NotImplementedError @abstractmethod def resolver(self, func_name: str) -> Callable[..., Any]: raise NotImplementedError
[docs] @abstractmethod async def call( self, func: str, timeout: Union[int, float] = None, **kwargs: Mapping[str, Any] ): """ Method for call remote function Remote methods allows only kwargs as arguments. You might use functions as route or classes .. code-block:: python async def remote_function(socket: WSRPCBase, *, foo, bar): # call function from the client-side await self.socket.proxy.ping() return foo + bar class RemoteClass(WebSocketRoute): # this method executes when remote side call route name asyc def init(self): # call function from the client-side await self.socket.proxy.ping() async def make_something(self, foo, bar): return foo + bar """ raise NotImplementedError
async def emit(self, event: Any) -> None: pass @abstractmethod def add_event_listener(self, func: EventListenerType) -> None: raise NotImplementedError def remove_event_listeners(self, func: EventListenerType) -> None: raise NotImplementedError
[docs] @classmethod def remove_route(cls, route: str, fail=True): """ Removes route by name. If `fail=True` an exception will be raised in case the route was not found. """ raise NotImplementedError
@property @abstractmethod def proxy(self) -> Proxy: """ Special property which allow run the remote functions by `dot` notation .. code-block:: python # calls remote function with name ping await client.proxy.ping() # full equivalent of await client.call('ping') """ raise NotImplementedError
WSRPC = TypeVar("WSRPC", bound=WSRPCBase) RouteType = Union[Callable[..., Any], Type[AbstractRoute]] P = ParamSpec("P")
[docs]class AbstractWSRPC(WSRPCBase, ABC):
[docs] @classmethod @abstractmethod def add_route( cls, route: str, handler: Union[ Callable[Concatenate[WSRPC, P], Any], Type[AbstractRoute], ], ) -> None: """ Expose local function through RPC :param route: Name which function will be aliased for this function. Remote side should call function by this name. :param handler: Function or Route class (classes based on :class:`wsrpc_aiohttp.WebSocketRoute`). For route classes the public methods will be registered automatically. .. note:: Route classes might be initialized only once for each socket instance. In case the method of class will be called first, :func:`wsrpc_aiohttp.WebSocketRoute.init` will be called without params before callable method. """ raise NotImplementedError
RouteCollectionType = DefaultDict[ Type[AbstractWSRPC], Dict[str, RouteType], ] ClientCollectionType = DefaultDict[ Type[AbstractWSRPC], Dict[str, AbstractWSRPC], ] EventListenerCollectionType = Set[EventListenerType]