Skip to content

ConcurrentDefaultSubscriber

faststream.kafka.subscriber.usecase.ConcurrentDefaultSubscriber #

ConcurrentDefaultSubscriber(
    *args: Any, max_workers: int, **kwargs: Any
)

Bases: ConcurrentMixin['ConsumerRecord'], DefaultSubscriber

Source code in faststream/_internal/endpoint/subscriber/mixins.py
66
67
68
69
70
71
72
73
74
75
76
77
def __init__(
    self,
    *args: Any,
    max_workers: int,
    **kwargs: Any,
) -> None:
    self.max_workers = max_workers
    self.limiter = anyio.Semaphore(max_workers)
    # Closed until `start`, so a subscriber that is only declared holds nothing open
    self.send_stream, self.receive_stream = _closed_queue()

    super().__init__(*args, **kwargs)

lock instance-attribute #

lock: AbstractContextManager[Any] = FakeContext()

extra_watcher_options instance-attribute #

extra_watcher_options: dict[str, Any] = {}

graceful_timeout instance-attribute #

graceful_timeout: float | None

calls instance-attribute #

calls = calls

specification instance-attribute #

specification = specification

ack_policy instance-attribute #

ack_policy = config.ack_policy

running instance-attribute #

running = False

tasks instance-attribute #

tasks: list[Task[Any]] = []

consumer instance-attribute #

consumer: Optional[AIOKafkaConsumer] = None

batch instance-attribute #

batch: bool

parser instance-attribute #

parser = AioKafkaParser(
    msg_class=KafkaMessage
    if config.ack_first
    else KafkaAckableMessage,
    regex=reg,
)

group_id instance-attribute #

group_id = config.group_id

pattern property #

pattern: Address | None

The pattern this Subscriber was declared with, and its Broker address.

topics property #

topics: list[str]

partitions property #

partitions: list[TopicPartition]

The assignment as the consumer receives it: the client library's tuples, prefixed.

Declared with faststream.kafka.TopicPartition; handed to aiokafka as its own.

builder property #

builder: Callable[..., AIOKafkaConsumer]

client_id property #

client_id: str | None

topic_names property #

topic_names: list[str]

send_stream instance-attribute #

send_stream: MemoryObjectSendStream[MsgType]

receive_stream instance-attribute #

receive_stream: MemoryObjectReceiveStream[MsgType]

max_workers instance-attribute #

max_workers = max_workers

limiter instance-attribute #

limiter = anyio.Semaphore(max_workers)

start async #

start() -> None
Source code in faststream/kafka/subscriber/usecase.py
408
409
410
async def start(self) -> None:
    await super().start()
    self.start_consume_task()

consume_one async #

consume_one(msg: ConsumerRecord) -> None
Source code in faststream/kafka/subscriber/usecase.py
412
413
async def consume_one(self, msg: "ConsumerRecord") -> None:
    await self._put_msg(msg)

stop async #

stop() -> None
Source code in faststream/_internal/endpoint/subscriber/mixins.py
87
88
89
90
91
92
@override
async def stop(self) -> None:
    await super().stop()

    self.send_stream.close()
    self.receive_stream.close()

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_one async #

get_one(*, timeout: float = 5.0) -> KafkaMessage | None
Source code in faststream/kafka/subscriber/usecase.py
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
@override
async def get_one(
    self,
    *,
    timeout: float = 5.0,
) -> "KafkaMessage | None":
    assert not self.calls, (
        "You can't use `get_one` method if subscriber has registered handlers."
    )

    assert self.consumer, "You should start subscriber at first."

    raw_messages = await self.consumer.getmany(
        timeout_ms=timeout * 1000,
        max_records=1,
    )

    if not raw_messages:
        return None

    ((raw_message,),) = raw_messages.values()

    context = self._outer_config.context

    async_parser, async_decoder = self._get_parser_and_decoder()

    msg: KafkaMessage | None = await process_msg(  # type: ignore[assignment]
        msg=raw_message,
        middlewares=(
            m(raw_message, context=context) for m in self._broker_middlewares
        ),
        parser=async_parser,
        decoder=async_decoder,
    )
    return msg

get_log_context #

get_log_context(
    message: Optional[StreamMessage[ConsumerRecord]],
) -> dict[str, str]
Source code in faststream/kafka/subscriber/usecase.py
324
325
326
327
328
329
330
331
332
333
334
335
336
337
def get_log_context(
    self,
    message: Optional["StreamMessage[ConsumerRecord]"],
) -> dict[str, str]:
    if message is None:
        topic = ",".join(self.topic_names)
    else:
        topic = message.raw_message.topic

    return self.build_log_context(
        message=message,
        topic=topic,
        group_id=self.group_id,
    )

schema #

schema() -> dict[str, SubscriberSpec]
Source code in faststream/_internal/endpoint/subscriber/usecase.py
518
519
520
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)

get_msg async #

get_msg(consumer: AIOKafkaConsumer) -> ConsumerRecord
Source code in faststream/kafka/subscriber/usecase.py
319
320
321
322
@override
async def get_msg(self, consumer: "AIOKafkaConsumer") -> "ConsumerRecord":
    assert consumer, "You should setup subscriber at first."
    return await consumer.getone()

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/kafka/subscriber/usecase.py
283
284
285
286
287
288
289
290
291
292
293
@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", ""),
    }

start_consume_task #

start_consume_task() -> None
Source code in faststream/_internal/endpoint/subscriber/mixins.py
94
95
def start_consume_task(self) -> None:
    self.add_task(self._serve_consume_queue)