BatchPullStreamSubscriber(
config: NatsSubscriberConfig,
specification: SubscriberSpecification[Any, Any],
calls: CallsCollection[list[Msg]],
*,
stream: JStream,
pull_sub: PullSub,
)
Bases: TasksMixin, DefaultSubscriber[list['Msg']]
Batch-message consumer class.
Source code in faststream/nats/subscriber/usecases/stream_pull_subscriber.py
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139 | def __init__(
self,
config: "NatsSubscriberConfig",
specification: "SubscriberSpecification[Any, Any]",
calls: "CallsCollection[list[Msg]]",
*,
stream: "JStream",
pull_sub: "PullSub",
) -> None:
parser = BatchParser(pattern=config.subject)
config.decoder = parser.decode_batch
config.parser = parser.parse_batch
super().__init__(config, specification, calls)
self.stream = stream
self.pull_sub = pull_sub
|
subscription instance-attribute
subscription: Optional[PullSubscription]
stream instance-attribute
pull_sub instance-attribute
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
config instance-attribute
config = config.sub_config
extra_options = config.extra_options or {}
subject property
The subject this Subscriber was declared with, and its Broker address.
filter_subjects property
filter_subjects: list[str]
jetstream property
jetstream: JetStreamContext
tasks instance-attribute
tasks: list[Task[Any]] = []
get_one async
get_one(*, timeout: float = 5) -> Optional[NatsMessage]
Source code in faststream/nats/subscriber/usecases/stream_pull_subscriber.py
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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 | @override
async def get_one(
self,
*,
timeout: float = 5,
) -> Optional["NatsMessage"]:
assert 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.jetstream.pull_subscribe(
subject=self.subject.broker_address,
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
context = self._outer_config.context
async_parser, async_decoder = self._get_parser_and_decoder()
return cast(
"NatsMessage",
await process_msg(
msg=raw_message,
middlewares=(
m(raw_message, context=context) for m in self._broker_middlewares
),
parser=async_parser,
decoder=async_decoder,
),
)
|
start async
Create NATS subscription and start consume tasks.
Source code in faststream/nats/subscriber/usecases/basic.py
| async def start(self) -> None:
"""Create NATS subscription and start consume tasks."""
await super().start()
if self.calls:
await self._create_subscription()
self._post_start()
|
stop async
Clean up handler subscription, cancel consume task in graceful mode.
Source code in faststream/_internal/endpoint/subscriber/mixins.py
45
46
47
48
49
50
51
52
53 | 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
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]
Log context factory using in self.consume scope.
Source code in faststream/nats/subscriber/usecases/basic.py
142
143
144
145
146
147
148
149
150 | def get_log_context(
self,
message: Optional["StreamMessage[MsgType]"],
) -> dict[str, str]:
"""Log context factory using in `self.consume` scope."""
return self.build_log_context(
message=message,
subject=self.subject.template,
)
|
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()
|
build_log_context staticmethod
build_log_context(
message: Optional[StreamMessage[MsgType]],
subject: str,
*,
queue: str = "",
stream: str = "",
) -> dict[str, str]
Static method to build log context out of self.consume scope.
Source code in faststream/nats/subscriber/usecases/basic.py
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118 | @staticmethod
def build_log_context(
message: Optional["StreamMessage[MsgType]"],
subject: str,
*,
queue: str = "",
stream: str = "",
) -> 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", ""),
}
|
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)
|