LogicSubscriber(
config: KafkaSubscriberConfig,
specification: SubscriberSpecification[Any, Any],
calls: CallsCollection[MsgType],
)
Bases: TasksMixin, SubscriberUsecase[MsgType]
A class to handle logic for consuming messages from Kafka.
Source code in faststream/confluent/subscriber/usecase.py
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70 | def __init__(
self,
config: "KafkaSubscriberConfig",
specification: "SubscriberSpecification[Any, Any]",
calls: "CallsCollection[MsgType]",
) -> None:
super().__init__(config, specification, calls)
self.__connection_data = config.connection_data
self.group_id = config.group_id
self._topics = config.topics
self._partitions = config.partitions
self.consumer = None
self.polling_interval = config.polling_interval
|
parser instance-attribute
group_id instance-attribute
group_id: str | None = config.group_id
consumer instance-attribute
polling_interval instance-attribute
polling_interval = config.polling_interval
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]] = []
start async
Start the consumer.
Source code in faststream/confluent/subscriber/usecase.py
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101 | @override
async def start(self) -> None:
"""Start the consumer."""
await super().start()
self.consumer = consumer = self._outer_config.builder(
*self.topics,
partitions=self.partitions,
group_id=self.group_id,
client_id=self.client_id,
**self.__connection_data,
)
self.parser._setup(consumer)
await consumer.start()
self._post_start()
if self.calls:
self.add_task(self._consume)
|
stop async
Source code in faststream/confluent/subscriber/usecase.py
| async def stop(self) -> None:
await super().stop()
if self.consumer is not None:
await self.consumer.stop()
self.consumer = None
|
get_one async
Source code in faststream/confluent/subscriber/usecase.py
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 | @override
async def get_one(
self,
*,
timeout: float = 5.0,
) -> "KafkaMessage | None":
assert self.consumer, "You should start subscriber at first."
assert not self.calls, (
"You can't use `get_one` method if subscriber has registered handlers."
)
raw_message = await self.consumer.getone(timeout=timeout)
context = self._outer_config.context
async_parser, async_decoder = self._get_parser_and_decoder()
return await process_msg( # type: ignore[return-value]
msg=raw_message,
middlewares=(
m(raw_message, context=context) for m in self._broker_middlewares
),
parser=async_parser,
decoder=async_decoder,
)
|
consume_one async
consume_one(msg: MsgType) -> None
Source code in faststream/confluent/subscriber/usecase.py
| async def consume_one(self, msg: MsgType) -> None:
await self.consume(msg)
|
get_msg abstractmethod async
get_msg() -> MsgType | None
Source code in faststream/confluent/subscriber/usecase.py
| @abstractmethod
async def get_msg(self) -> MsgType | None:
raise NotImplementedError
|
build_log_context staticmethod
build_log_context(
message: Optional[StreamMessage[Any]],
topic: str,
group_id: str | None = None,
) -> dict[str, str]
Source code in faststream/confluent/subscriber/usecase.py
217
218
219
220
221
222
223
224
225
226
227 | @staticmethod
def build_log_context(
message: Optional["StreamMessage[Any]"],
topic: str,
group_id: str | None = None,
) -> dict[str, str]:
return {
"topic": topic,
"group_id": group_id or "",
"message_id": getattr(message, "message_id", ""),
}
|
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259 | 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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352 | 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
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443 | 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_log_context
get_log_context(
message: Optional[StreamMessage[MsgType]],
) -> dict[str, str]
Generate log context.
Source code in faststream/_internal/endpoint/subscriber/usecase.py
495
496
497
498
499
500
501
502 | 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
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43 | 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)
|