AsyncAPIBatchPullStreamSubscriber

@override
def setup(  # type: ignore[override]
    self,
    *,
    connection: ConnectionType,
    # basic args
    logger: Optional["LoggerProto"],
    producer: Optional["ProducerProto"],
    graceful_timeout: Optional[float],
    extra_context: "AnyDict",
    # broker options
    broker_parser: Optional["CustomCallable"],
    broker_decoder: Optional["CustomCallable"],
    # dependant args
    apply_types: bool,
    is_validate: bool,
    _get_dependant: Optional[Callable[..., Any]],
    _call_decorators: Iterable["Decorator"],
) -> None:
    self._connection = connection

    super().setup(
        logger=logger,
        producer=producer,
        graceful_timeout=graceful_timeout,
        extra_context=extra_context,
        broker_parser=broker_parser,
        broker_decoder=broker_decoder,
        apply_types=apply_types,
        is_validate=is_validate,
        _get_dependant=_get_dependant,
        _call_decorators=_call_decorators,
    )

def add_prefix(self, prefix: str) -> None:
    """Include Subscriber in router."""
    if self.subject:
        self.subject = "".join((prefix, self.subject))
    else:
        self.config.filter_subjects = [
            "".join((prefix, subject))
            for subject in (self.config.filter_subjects or ())
        ]

def schema(self) -> Dict[str, Channel]:
    """Returns the schema of the API operation as a dictionary of channel names and channel objects."""
    if self.include_in_schema:
        return self.get_schema()
    else:
        return {}

def add_middleware(self, middleware: "BrokerMiddleware[MsgType]") -> None:
    self._broker_middlewares = (*self._broker_middlewares, middleware)

def get_log_context(
    self,
    message: Annotated[
        Optional["StreamMessage[MsgType]"],
        Doc("Message which we are building context for"),
    ],
) -> Dict[str, str]:
    """Log context factory using in `self.consume` scope."""
    return self.build_log_context(
        message=message,
        subject=self.subject,
    )

async def start(self) -> None:
    """Create NATS subscription and start consume tasks."""
    assert self._connection, NOT_CONNECTED_YET  # nosec B101

    await super().start()

    if self.calls:
        await self._create_subscription(connection=self._connection)

async def close(self) -> None:
    """Clean up handler subscription, cancel consume task in graceful mode."""
    await super().close()

    for task in self.tasks:
        if not task.done():
            task.cancel()

    self.tasks = []

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.close()

    except SystemExit:
        # Stop handler at `exit()` call
        await self.close()

        if app := context.get("app"):
            app.exit()

    except Exception:  # nosec B110
        # All other exceptions were logged by CriticalLogMiddleware
        pass

async def process_message(self, msg: MsgType) -> "Response":
    """Execute all message processing stages."""
    async with AsyncExitStack() as stack:
        stack.enter_context(self.lock)

        # Enter context before middlewares
        for k, v in self.extra_context.items():
            stack.enter_context(context.scope(k, v))

        stack.enter_context(context.scope("handler_", self))

        # enter all middlewares
        middlewares: List[BaseMiddleware] = []
        for base_m in self._broker_middlewares:
            middleware = base_m(msg)
            middlewares.append(middleware)
            await middleware.__aenter__()

        cache: Dict[Any, Any] = {}
        parsing_error: Optional[Exception] = 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:
                # Acknowledgement scope
                # TODO: move it to scope enter at `retry` option deprecation
                await stack.enter_async_context(
                    self.watcher(
                        message,
                        **self.extra_watcher_options,
                    )
                )

                stack.enter_context(
                    context.scope("log_context", self.get_log_context(message))
                )
                stack.enter_context(context.scope("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.body,
                        **result_msg.as_publish_kwargs(),
                        # publisher middlewares
                        _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__)

        if parsing_error:
            raise parsing_error

        else:
            raise SubscriberNotFound(f"There is no suitable handler for {msg=}")

    # An error was raised and processed by some middleware
    return ensure_response(None)

@override
async def get_one(
    self,
    *,
    timeout: float = 5,
) -> Optional["NatsMessage"]:
    assert self._connection, "Please, start() subscriber first"  # nosec B101
    assert (  # nosec B101
        not self.calls
    ), "You can't use `get_one` method if subscriber has registered handlers."

    if not self._fetch_sub:
        fetch_sub = self._fetch_sub = await self._connection.pull_subscribe(
            subject=self.clear_subject,
            config=self.config,
            **self.extra_options,
        )
    else:
        fetch_sub = self._fetch_sub

    try:
        raw_message = await fetch_sub.fetch(
            batch=1,
            timeout=timeout,
        )
    except TimeoutError:
        return None

    msg = cast(
        NatsMessage,
        await process_msg(
            msg=raw_message,
            middlewares=self._broker_middlewares,
            parser=self._parser,
            decoder=self._decoder,
        ),
    )
    return msg

def add_call(
    self,
    *,
    filter_: "Filter[Any]",
    parser_: Optional["CustomCallable"],
    decoder_: Optional["CustomCallable"],
    middlewares_: Sequence["SubscriberMiddleware[Any]"],
    dependencies_: Iterable["Depends"],
) -> Self:
    self._call_options = _CallOptions(
        filter=filter_,
        parser=parser_,
        decoder=decoder_,
        middlewares=middlewares_,
        dependencies=dependencies_,
    )
    return self

def get_name(self) -> str:
    return f"{self.subject}:{self.call_name}"

def get_description(self) -> Optional[str]:
    """Returns the description of the handler."""
    if not self.calls:  # pragma: no cover
        return None

    else:
        return self.calls[0].description

def get_schema(self) -> Dict[str, Channel]:
    payloads = self.get_payloads()

    return {
        self.name: Channel(
            description=self.description,
            subscribe=Operation(
                message=Message(
                    title=f"{self.name}:Message",
                    payload=resolve_payloads(payloads),
                    correlationId=CorrelationId(
                        location="$message.header#/correlation_id"
                    ),
                ),
            ),
            bindings=ChannelBinding(
                nats=nats.ChannelBinding(
                    subject=self.subject,
                    queue=getattr(self, "queue", "") or None,
                )
            ),
        )
    }

def get_payloads(self) -> List[Tuple["AnyDict", str]]:
    """Get the payloads of the handler."""
    payloads: List[Tuple[AnyDict, str]] = []

    for h in self.calls:
        if h.dependant is None:
            raise SetupError("You should setup `Handler` at first.")

        body = parse_handler_params(
            h.dependant,
            prefix=f"{self.title_ or self.call_name}:Message",
        )

        payloads.append((body, to_camelcase(h.call_name)))

    if not self.calls:
        payloads.append(
            (
                {
                    "title": f"{self.title_ or self.call_name}:Message:Payload",
                },
                to_camelcase(self.call_name),
            )
        )

    return payloads

@staticmethod
def build_log_context(
    message: Annotated[
        Optional["StreamMessage[MsgType]"],
        Doc("Message which we are building context for"),
    ],
    subject: Annotated[
        str,
        Doc("NATS subject we are listening"),
    ],
    *,
    queue: Annotated[
        str,
        Doc("Using queue group name"),
    ] = "",
    stream: Annotated[
        str,
        Doc("Stream object we are listening"),
    ] = "",
) -> Dict[str, str]:
    """Static method to build log context out of `self.consume` scope."""
    return {
        "subject": subject,
        "queue": queue,
        "stream": stream,
        "message_id": getattr(message, "message_id", ""),
    }

@staticmethod
def get_routing_hash(
    subject: Annotated[
        str,
        Doc("NATS subject to consume messages"),
    ],
) -> int:
    """Get handler hash by outer data.

    Using to find handler in `broker.handlers` dictionary.
    """
    return hash(subject)

def add_task(self, coro: Coroutine[Any, Any, Any]) -> None:
    self.tasks.append(asyncio.create_task(coro))