Skip to content

MQTTConcurrentSubscriber

faststream.mqtt.subscriber.usecase.MQTTConcurrentSubscriber #

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

Bases: ConcurrentMixin[Message], MQTTBaseSubscriber

Concurrent MQTT subscriber — processes up to max_workers messages in parallel.

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] = nullcontext()

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]] = []

last_unsubscribe_result instance-attribute #

last_unsubscribe_result: UnsubscribeResult | None = None

address property #

address: Address

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

topic property #

topic: 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/mqtt/subscriber/usecase.py
231
232
233
234
@override
async def start(self) -> None:
    await super().start()
    self.start_consume_task()

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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
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  # ruff: ignore[try-except-pass]
        # 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
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
444
445
446
447
448
449
450
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(),
                ),
            ),
        )

        # reserve place for context scope under the middlewares __aexit__
        # because middlewares should be exited before context scope release
        message_scope = stack.enter_context(ExitStack())

        # enter all middlewares
        middlewares: list[BaseMiddleware] = []
        for base_m in self.__build__middlewares_stack():
            middleware = base_m(msg, context=context)
            middlewares.append(middleware)
            await stack.enter_async_context(middleware)

        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:
                message_scope.enter_context(
                    context.scopes(
                        (
                            ("log_context", self.get_log_context(message)),
                            ("message", message),
                        ),
                    ),
                )

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

    if self._subscription is None:
        auto_ack = self.ack_policy is AckPolicy.ACK_FIRST
        self._subscription = self._outer_config.client.subscribe(
            self.topic,
            qos=zmqtt.QoS(self._qos),
            auto_ack=auto_ack,
        )
        await self._subscription.start()

    async_parser, async_decoder = self._get_parser_and_decoder()

    raw_msg: zmqtt.Message | None = None
    with anyio.move_on_after(timeout):
        raw_msg = await self._subscription.get_message()

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

get_log_context #

get_log_context(
    message: StreamMessage[Message] | None,
) -> dict[str, str]
Source code in faststream/mqtt/subscriber/usecase.py
111
112
113
114
115
def get_log_context(
    self,
    message: "StreamMessage[zmqtt.Message] | None",
) -> dict[str, str]:
    return self.build_log_context(message=message, topic=self.topic)

schema #

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

build_log_context staticmethod #

build_log_context(
    message: StreamMessage[Message] | None, topic: str = ""
) -> dict[str, str]
Source code in faststream/mqtt/subscriber/usecase.py
101
102
103
104
105
106
107
108
109
@staticmethod
def build_log_context(
    message: "StreamMessage[zmqtt.Message] | None",
    topic: str = "",
) -> dict[str, str]:
    return {
        "topic": topic,
        "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)