LogicSubscriber(
config: RedisSubscriberConfig,
specification: SubscriberSpecification[Any, Any],
calls: CallsCollection[Any],
)
Bases: TasksMixin, SubscriberUsecase[UnifyRedisDict]
A class to represent a Redis handler.
Source code in faststream/redis/subscriber/usecases/basic.py
| def __init__(
self,
config: "RedisSubscriberConfig",
specification: "SubscriberSpecification[Any, Any]",
calls: "CallsCollection[Any]",
) -> None:
super().__init__(config, specification, calls)
self.config = config
|
lock instance-attribute
lock: AbstractContextManager[Any] = FakeContext()
extra_watcher_options: dict[str, Any] = {}
graceful_timeout instance-attribute
graceful_timeout: float | None
specification instance-attribute
specification = specification
ack_policy instance-attribute
ack_policy = config.ack_policy
running instance-attribute
tasks instance-attribute
tasks: list[Task[Any]] = []
config instance-attribute
stop async
Clean up handler subscription, cancel consume task in graceful mode.
Source code in faststream/_internal/endpoint/subscriber/mixins.py
43
44
45
46
47
48
49
50
51 | async def stop(self) -> None:
"""Clean up handler subscription, cancel consume task in graceful mode."""
await super().stop()
for task in self.tasks:
if not task.done():
task.cancel()
self.tasks.clear()
|
add_call
add_call(
*,
parser_: Optional[CustomCallable],
decoder_: Optional[CustomCallable],
dependencies_: Sequence[Dependant],
codec_: Optional[CodecProto] = None,
) -> Self
Source code in faststream/_internal/endpoint/subscriber/usecase.py
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244 | def add_call(
self,
*,
parser_: Optional["CustomCallable"],
decoder_: Optional["CustomCallable"],
dependencies_: Sequence["Dependant"],
codec_: Optional["CodecProto"] = None,
) -> Self:
self._call_options = _CallOptions(
parser=parser_,
decoder=decoder_,
dependencies=dependencies_,
codec=codec_,
)
return self
|
consume async
consume(msg: MsgType) -> Any
Consume a message asynchronously.
Source code in faststream/_internal/endpoint/subscriber/usecase.py
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337 | async def consume(self, msg: MsgType) -> Any:
"""Consume a message asynchronously."""
if not self.running:
return None
try:
return await self.process_message(msg)
except StopConsume:
# Stop handler at StopConsume exception
await self.stop()
except SystemExit:
# Stop handler at `exit()` call
await self.stop()
if app := self._outer_config.context.get("app"):
app.exit()
except Exception: # nosec B110 # noqa: S110
# All other exceptions were logged by CriticalLogMiddleware
pass
|
process_message async
process_message(msg: MsgType) -> Response
Execute all message processing stages.
Source code in faststream/_internal/endpoint/subscriber/usecase.py
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428 | async def process_message(self, msg: MsgType) -> "Response":
"""Execute all message processing stages."""
context = self._outer_config.context
logger_state = self._outer_config.logger
async with AsyncExitStack() as stack:
stack.enter_context(self.lock)
# Enter context before middlewares
stack.enter_context(
context.scopes(
(
("handler_", self),
("logger", logger_state.logger.logger),
*self._outer_config.extra_context.items(),
),
),
)
# enter all middlewares
middlewares: list[BaseMiddleware] = []
for base_m in self.__build__middlewares_stack():
middleware = base_m(msg, context=context)
middlewares.append(middleware)
await middleware.__aenter__()
cache: dict[Any, Any] = {}
parsing_error: Exception | None = None
for h in self.calls:
try:
message = await h.is_suitable(msg, cache)
except Exception as e:
parsing_error = e
break
if message is not None:
stack.enter_context(
context.scopes(
(
("log_context", self.get_log_context(message)),
("message", message),
),
),
)
# Middlewares should be exited before scope release
for m in middlewares:
stack.push_async_exit(m.__aexit__)
result_msg = ensure_response(
await h.call(
message=message,
# consumer middlewares
_extra_middlewares=(
m.consume_scope for m in middlewares[::-1]
),
),
)
if not result_msg.correlation_id:
result_msg.correlation_id = message.correlation_id
for p in chain(
self.__get_response_publisher(message),
h.handler._publishers,
):
await p._publish(
result_msg.as_publish_command(),
_extra_middlewares=(
m.publish_scope for m in middlewares[::-1]
),
)
# Return data for tests
return result_msg
# Suitable handler was not found or
# parsing/decoding exception occurred
for m in middlewares:
stack.push_async_exit(m.__aexit__)
# Reraise it to catch in tests
if parsing_error:
raise parsing_error
error_msg = f"There is no suitable handler for {msg=}"
raise SubscriberNotFound(error_msg)
# An error was raised and processed by some middleware
return ensure_response(None)
|
get_one abstractmethod async
get_one(
*, timeout: float = 5
) -> Optional[StreamMessage[MsgType]]
Source code in faststream/_internal/endpoint/subscriber/usecase.py
| @abstractmethod
async def get_one(self, *, timeout: float = 5) -> Optional["StreamMessage[MsgType]"]:
raise NotImplementedError
|
get_log_context
get_log_context(
message: Optional[StreamMessage[MsgType]],
) -> dict[str, str]
Generate log context.
Source code in faststream/_internal/endpoint/subscriber/usecase.py
480
481
482
483
484
485
486
487 | def get_log_context( # noqa: PLR6301
self,
message: Optional["StreamMessage[MsgType]"],
) -> dict[str, str]:
"""Generate log context."""
return {
"message_id": getattr(message, "message_id", ""),
}
|
schema
Source code in faststream/_internal/endpoint/subscriber/usecase.py
| def schema(self) -> dict[str, "SubscriberSpec"]:
self._build_fastdepends_model()
return self.specification.get_schema()
|
add_task
add_task(
func: Callable[..., Coroutine[Any, Any, Any]],
func_args: tuple[Any, ...] | None = None,
func_kwargs: dict[str, Any] | None = None,
*,
restart_on_failure: bool = True,
) -> None
Source code in faststream/_internal/endpoint/subscriber/mixins.py
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41 | def add_task(
self,
func: Callable[..., Coroutine[Any, Any, Any]],
func_args: tuple[Any, ...] | None = None,
func_kwargs: dict[str, Any] | None = None,
*,
restart_on_failure: bool = True,
) -> None:
args = func_args or ()
kwargs = func_kwargs or {}
task = asyncio.create_task(func(*args, **kwargs))
callback = TaskCallbackSupervisor(
func,
func_args,
func_kwargs,
self,
restart_on_failure=restart_on_failure,
)
task.add_done_callback(callback)
self.tasks.append(task)
|
start async
start(*args: Any) -> None
Source code in faststream/redis/subscriber/usecases/basic.py
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89 | @override
async def start(
self,
*args: Any,
) -> None:
await super().start()
self._post_start()
start_signal = anyio.Event()
if self.calls:
self.add_task(self._consume, args, {"start_signal": start_signal})
with anyio.fail_after(3.0):
await start_signal.wait()
else:
start_signal.set()
|
build_log_context staticmethod
build_log_context(
message: Optional[StreamMessage[Any]], channel: str = ""
) -> dict[str, str]
Source code in faststream/redis/subscriber/usecases/basic.py
123
124
125
126
127
128
129
130
131 | @staticmethod
def build_log_context(
message: Optional["BrokerStreamMessage[Any]"],
channel: str = "",
) -> dict[str, str]:
return {
"channel": channel,
"message_id": getattr(message, "message_id", ""),
}
|
consume_one async
consume_one(msg: Any) -> None
Source code in faststream/redis/subscriber/usecases/basic.py
| async def consume_one(self, msg: Any) -> None:
await self.consume(msg)
|