1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
|
from typing import TYPE_CHECKING, Type, TypeVar, Tuple, FrozenSet, Dict
from typing import Optional, Callable, Any, Collection, List, Coroutine
from itertools import chain
from collections import defaultdict
from .const import Status
from .metadata import Deadline, _Metadata
if TYPE_CHECKING:
from .stream import _SendType, _RecvType
from ._typing import IEventsTarget, IServerMethodFunc # noqa
from .protocol import Peer
class _Event:
__slots__ = ('__interrupted__',)
__payload__: Collection[str] = ()
__readonly__: FrozenSet[str] = frozenset()
__interrupted__: bool
def __init__(self, **kwargs): # type: ignore
assert len(kwargs) == len(self.__slots__), self.__slots__
super().__setattr__('__interrupted__', False)
for key, value in kwargs.items():
super().__setattr__(key, value)
def __setattr__(self, key: str, value: Any) -> None:
if key in self.__readonly__:
raise AttributeError('Read-only property: {!r}'.format(key))
else:
super().__setattr__(key, value)
def interrupt(self) -> None:
super().__setattr__('__interrupted__', True)
_EventType = TypeVar('_EventType', bound=_Event)
class _EventMeta(type):
def __new__(mcs, name, bases, params): # type: ignore
annotations = params.get('__annotations__') or {}
payload = params.get('__payload__') or ()
params['__slots__'] = tuple(name for name in annotations)
params['__readonly__'] = frozenset(name for name in annotations
if name not in payload)
return super().__new__(mcs, name, bases, params)
async def _ident(*args, **_): # type: ignore
return args
def _dispatches(event_type: Type[_Event]) -> Callable[[Any], Any]:
def decorator(func: Any) -> Any:
func.__dispatches__ = event_type
return func
return decorator
_Callback = Callable[[_Event], Coroutine[Any, Any, None]]
class _Dispatch:
__dispatch_methods__: Dict[Type[_Event], str] = {}
def __init__(self) -> None:
self._listeners: Dict[Type[_Event], List[_Callback]] = defaultdict(list)
for name in self.__dispatch_methods__.values():
self.__dict__[name] = _ident
def add_listener(
self,
event_type: Type[_Event],
callback: _Callback,
) -> None:
self.__dict__.pop(self.__dispatch_methods__[event_type], None)
self._listeners[event_type].append(callback)
async def __dispatch__(self, event: _Event) -> Any:
for callback in self._listeners[event.__class__]:
await callback(event)
if event.__interrupted__:
break
return tuple(getattr(event, name) for name in event.__payload__)
class _DispatchMeta(type):
def __new__(mcs, name, bases, params): # type: ignore
dispatch_methods = dict(chain.from_iterable(
getattr(base, '__dispatch_methods__', {}).items()
for base in bases
))
for key, value in params.items():
dispatches = getattr(value, '__dispatches__', None)
if dispatches is not None:
assert (isinstance(dispatches, type)
and issubclass(dispatches, _Event)), dispatches
assert dispatches not in dispatch_methods, dispatches
dispatch_methods[dispatches] = key
params['__dispatch_methods__'] = dispatch_methods
return super().__new__(mcs, name, bases, params)
def listen(
target: 'IEventsTarget',
event_type: Type[_EventType],
callback: Callable[[_EventType], Coroutine[Any, Any, None]],
) -> None:
"""Registers a listener function for the given target and event type
.. code-block:: python3
async def callback(event: SomeEvent):
print(event.data)
listen(target, SomeEvent, callback)
"""
target.__dispatch__.add_listener(event_type, callback)
class SendMessage(_Event, metaclass=_EventMeta):
"""Dispatches before sending message to the other party
:param mutable message: message to send
"""
__payload__ = ('message',)
message: Any
class RecvMessage(_Event, metaclass=_EventMeta):
"""Dispatches after message was received from the other party
:param mutable message: received message
"""
__payload__ = ('message',)
message: Any
class _DispatchCommonEvents(_Dispatch, metaclass=_DispatchMeta):
@_dispatches(SendMessage)
async def send_message(self, message: '_SendType') -> Tuple['_SendType']:
return await self.__dispatch__(SendMessage( # type: ignore
message=message,
))
@_dispatches(RecvMessage)
async def recv_message(self, message: '_RecvType') -> Tuple['_RecvType']:
return await self.__dispatch__(RecvMessage( # type: ignore
message=message,
))
class RecvRequest(_Event, metaclass=_EventMeta):
"""Dispatches after request was received from the client
:param mutable metadata: invocation metadata
:param mutable method_func: coroutine function to process this request,
accepts :py:class:`~grpclib.server.Stream`
:param read-only method_name: RPC's method name
:param read-only deadline: request's :py:class:`~grpclib.metadata.Deadline`
:param read-only content_type: request's content type
:param read-only user_agent: request's user agent
:param read-only peer: request's :py:class:`~grpclib.protocol.Peer`
"""
__payload__ = ('metadata', 'method_func')
metadata: _Metadata
method_func: 'IServerMethodFunc'
method_name: str
deadline: Optional[Deadline]
content_type: str
user_agent: Optional[str]
peer: 'Peer'
class SendInitialMetadata(_Event, metaclass=_EventMeta):
"""Dispatches before sending headers with initial metadata to the client
:param mutable metadata: initial metadata
"""
__payload__ = ('metadata',)
metadata: _Metadata
class SendTrailingMetadata(_Event, metaclass=_EventMeta):
"""Dispatches before sending trailers with trailing metadata to the client
:param mutable metadata: trailing metadata
:param read-only status: status of the RPC call
:param read-only status_message: description of the status
:param read-only status_details: additional status details
"""
__payload__ = ('metadata',)
metadata: _Metadata
status: Status
status_message: Optional[str]
status_details: Any
class _DispatchServerEvents(_DispatchCommonEvents):
@_dispatches(RecvRequest)
async def recv_request(
self,
metadata: _Metadata,
method_func: 'IServerMethodFunc',
*,
method_name: str,
deadline: Optional[Deadline],
content_type: str,
user_agent: Optional[str],
peer: 'Peer',
) -> Tuple[_Metadata, 'IServerMethodFunc']:
return await self.__dispatch__(RecvRequest( # type: ignore
metadata=metadata,
method_func=method_func,
method_name=method_name,
deadline=deadline,
content_type=content_type,
user_agent=user_agent,
peer=peer,
))
@_dispatches(SendInitialMetadata)
async def send_initial_metadata(
self,
metadata: _Metadata,
) -> Tuple[_Metadata]:
return await self.__dispatch__(SendInitialMetadata( # type: ignore
metadata=metadata,
))
@_dispatches(SendTrailingMetadata)
async def send_trailing_metadata(
self,
metadata: _Metadata,
*,
status: Status,
status_message: Optional[str],
status_details: Any,
) -> Tuple[_Metadata]:
return await self.__dispatch__(SendTrailingMetadata( # type: ignore
metadata=metadata,
status=status,
status_message=status_message,
status_details=status_details,
))
class SendRequest(_Event, metaclass=_EventMeta):
"""Dispatches before sending request to the server
:param mutable metadata: invocation metadata
:param read-only method_name: RPC's method name
:param read-only deadline: request's :py:class:`~grpclib.metadata.Deadline`
:param read-only content_type: request's content type
"""
__payload__ = ('metadata',)
metadata: _Metadata
method_name: str
deadline: Optional[Deadline]
content_type: str
class RecvInitialMetadata(_Event, metaclass=_EventMeta):
"""Dispatches after headers with initial metadata were received
from the server
:param mutable metadata: initial metadata
"""
__payload__ = ('metadata',)
metadata: _Metadata
class RecvTrailingMetadata(_Event, metaclass=_EventMeta):
"""Dispatches after trailers with trailing metadata were received
from the server
:param mutable metadata: trailing metadata
:param read-only status: status of the RPC call
:param read-only status_message: description of the status
:param read-only status_details: additional status details
"""
__payload__ = ('metadata',)
metadata: _Metadata
status: Status
status_message: Optional[str]
status_details: Any
class _DispatchChannelEvents(_DispatchCommonEvents):
@_dispatches(SendRequest)
async def send_request(
self,
metadata: _Metadata,
*,
method_name: str,
deadline: Optional[Deadline],
content_type: str,
) -> Tuple[_Metadata]:
return await self.__dispatch__(SendRequest( # type: ignore
metadata=metadata,
method_name=method_name,
deadline=deadline,
content_type=content_type,
))
@_dispatches(RecvInitialMetadata)
async def recv_initial_metadata(
self,
metadata: _Metadata,
) -> Tuple[_Metadata]:
return await self.__dispatch__(RecvInitialMetadata( # type: ignore
metadata=metadata,
))
@_dispatches(RecvTrailingMetadata)
async def recv_trailing_metadata(
self,
metadata: _Metadata,
*,
status: Status,
status_message: Optional[str],
status_details: Any,
) -> Tuple[_Metadata]:
return await self.__dispatch__(RecvTrailingMetadata( # type: ignore
metadata=metadata,
status=status,
status_message=status_message,
status_details=status_details,
))
|