BatchPublisher
faststream.kafka.publisher.BatchPublisher #
BatchPublisher(
config: KafkaPublisherConfig,
specification: PublisherSpecification[Any, Any],
)
Bases: LogicPublisher
Source code in faststream/kafka/publisher/usecase.py
328 329 330 331 332 333 334 | |
mock property #
mock: MagicMock
The mock recording the endpoint's calls, available under a test broker.
request async #
request(
message: SendableMessage,
topic: str = "",
*,
key: bytes | Any | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
correlation_id: str | None = None,
timeout: float = 0.5,
) -> KafkaMessage
Send a request message to Kafka topic.
| PARAMETER | DESCRIPTION |
|---|---|
message | Message body to send. TYPE: |
topic | Topic where the message will be published. TYPE: |
key | A key to associate with the message. Can be used to determine which partition to send the message to. If partition is TYPE: |
partition | Specify a partition. If not set, the partition will be selected using the configured TYPE: |
timestamp_ms | Epoch milliseconds (from Jan 1 1970 UTC) to use as the message timestamp. Defaults to current time. TYPE: |
headers | Message headers to store metainformation. TYPE: |
correlation_id | Manual message correlation_id setter. correlation_id is a useful option to trace messages. TYPE: |
timeout | Timeout to send RPC request. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
KafkaMessage | The response message. TYPE: |
Source code in faststream/kafka/publisher/usecase.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 | |
assert_called_once_with async #
assert_called_once_with(
body: Any = EMPTY,
/,
*,
headers: Any = EMPTY,
correlation_id: Any = EMPTY,
reply_to: Any = EMPTY,
content_type: Any = EMPTY,
path: Any = EMPTY,
context: Mapping[str, Any] = EMPTY,
key: Any = EMPTY,
partition: Any = EMPTY,
) -> None
Assert the endpoint was called once, with the message described here.
| PARAMETER | DESCRIPTION |
|---|---|
body | The body as a dict, a model or a matcher; it goes through the codec. TYPE: |
headers | Headers the message must carry; the rest may carry more. TYPE: |
correlation_id | The exact correlation id. TYPE: |
reply_to | The exact reply-to destination. TYPE: |
content_type | The exact content type. TYPE: |
path | The exact path parameters the subject template matched. TYPE: |
context | Context paths, as given to TYPE: |
key | The exact record key, as the bytes the client delivered. TYPE: |
partition | The exact partition the record was read from. TYPE: |
Source code in faststream/_internal/kafka/calls.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | |
assert_called_with async #
assert_called_with(
body: Any = EMPTY,
/,
*,
headers: Any = EMPTY,
correlation_id: Any = EMPTY,
reply_to: Any = EMPTY,
content_type: Any = EMPTY,
path: Any = EMPTY,
context: Mapping[str, Any] = EMPTY,
key: Any = EMPTY,
partition: Any = EMPTY,
) -> None
Assert the last message the endpoint saw is the one described here.
| PARAMETER | DESCRIPTION |
|---|---|
body | The body as a dict, a model or a matcher; it goes through the codec. TYPE: |
headers | Headers the message must carry; the rest may carry more. TYPE: |
correlation_id | The exact correlation id. TYPE: |
reply_to | The exact reply-to destination. TYPE: |
content_type | The exact content type. TYPE: |
path | The exact path parameters the subject template matched. TYPE: |
context | Context paths, as given to TYPE: |
key | The exact record key, as the bytes the client delivered. TYPE: |
partition | The exact partition the record was read from. TYPE: |
Source code in faststream/_internal/kafka/calls.py
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | |
assert_any_call async #
assert_any_call(
body: Any = EMPTY,
/,
*,
headers: Any = EMPTY,
correlation_id: Any = EMPTY,
reply_to: Any = EMPTY,
content_type: Any = EMPTY,
path: Any = EMPTY,
context: Mapping[str, Any] = EMPTY,
key: Any = EMPTY,
partition: Any = EMPTY,
) -> None
Assert one of the messages the endpoint saw is the one described here.
| PARAMETER | DESCRIPTION |
|---|---|
body | The body as a dict, a model or a matcher; it goes through the codec. TYPE: |
headers | Headers the message must carry; the rest may carry more. TYPE: |
correlation_id | The exact correlation id. TYPE: |
reply_to | The exact reply-to destination. TYPE: |
content_type | The exact content type. TYPE: |
path | The exact path parameters the subject template matched. TYPE: |
context | Context paths, as given to TYPE: |
key | The exact record key, as the bytes the client delivered. TYPE: |
partition | The exact partition the record was read from. TYPE: |
Source code in faststream/_internal/kafka/calls.py
107 108 109 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 135 136 137 138 139 140 141 142 143 144 145 146 | |
start async #
start() -> None
Source code in faststream/_internal/endpoint/publisher/usecase.py
57 58 | |
set_test #
set_test(
*, recorder: CallRecorder | None = None, with_fake: bool
) -> None
Turn publisher to testing mode, sharing recorder when one is given.
Source code in faststream/_internal/endpoint/publisher/usecase.py
60 61 62 63 64 65 66 67 68 69 70 71 72 | |
reset_test #
reset_test() -> None
Turn off publisher's testing mode.
Source code in faststream/_internal/endpoint/publisher/usecase.py
74 75 76 77 78 79 80 | |
schema #
schema() -> dict[str, PublisherSpec]
Source code in faststream/_internal/endpoint/publisher/usecase.py
157 158 | |
flush async #
flush() -> None
Source code in faststream/kafka/publisher/usecase.py
124 125 126 | |
publish async #
publish(
*messages: KafkaSendableMessage,
topic: str = "",
key: bytes | Any | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
reply_to: str = "",
correlation_id: str | None = None,
no_confirm: Literal[False] = False,
) -> RecordMetadata
publish(
*messages: KafkaSendableMessage,
topic: str = "",
key: bytes | Any | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
reply_to: str = "",
correlation_id: str | None = None,
no_confirm: Literal[True] = ...,
) -> Future[RecordMetadata]
publish(
*messages: KafkaSendableMessage,
topic: str = "",
key: bytes | Any | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
reply_to: str = "",
correlation_id: str | None = None,
no_confirm: bool = False,
) -> Union[Future[RecordMetadata], RecordMetadata]
publish(
*messages: KafkaSendableMessage,
topic: str = "",
key: bytes | Any | None = None,
partition: int | None = None,
timestamp_ms: int | None = None,
headers: Mapping[str, str | bytes | None] | None = None,
reply_to: str = "",
correlation_id: str | None = None,
no_confirm: bool = False,
) -> Union[Future[RecordMetadata], RecordMetadata]
Publish a message batch as a single request to broker.
| PARAMETER | DESCRIPTION |
|---|---|
*messages | Messages bodies to send. TYPE: |
topic | Topic where the message will be published. TYPE: |
key | A single key to associate with every message in this batch. If a partition is not specified and the producer uses the default partitioner, messages with the same key will be routed to the same partition. Must be bytes or serializable to bytes via the configured key serializer. If omitted, falls back to the publisher's default key (if configured). TYPE: |
partition | Specify a partition. If not set, the partition will be selected using the configured TYPE: |
timestamp_ms | Epoch milliseconds (from Jan 1 1970 UTC) to use as the message timestamp. Defaults to current time. TYPE: |
headers | Message headers to store metainformation. TYPE: |
reply_to | Reply message topic name to send response. TYPE: |
correlation_id | Manual message correlation_id setter. correlation_id is a useful option to trace messages. TYPE: |
no_confirm | Do not wait for Kafka publish confirmation. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
Union[Future[RecordMetadata], RecordMetadata] |
|
Union[Future[RecordMetadata], RecordMetadata] |
|
Source code in faststream/kafka/publisher/usecase.py
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 | |