Skip to content

AioKafkaFastProducerImpl

faststream.kafka.publisher.producer.AioKafkaFastProducerImpl #

AioKafkaFastProducerImpl(
    parser: Optional[CustomCallable],
    decoder: Optional[CustomCallable],
)

Bases: AioKafkaFastProducer

A class to represent Kafka producer.

Source code in faststream/kafka/publisher/producer.py
80
81
82
83
84
85
86
87
88
89
90
91
92
def __init__(
    self,
    parser: Optional["CustomCallable"],
    decoder: Optional["CustomCallable"],
) -> None:
    self._producer: ProducerState = EmptyProducerState()
    self.serializer: SerializerProto | None = None
    self.codec: CodecProto = DefaultCodec()

    # NOTE: register default parser to be compatible with request
    default = AioKafkaParser(msg_class=KafkaMessage, regex=None)
    self._parser = ParserComposition(parser, default.parse_message)
    self._decoder = ParserComposition(decoder, default.decode_message)

serializer instance-attribute #

serializer: SerializerProto | None = None

codec instance-attribute #

codec: CodecProto = DefaultCodec()

closed property #

closed: bool

connect async #

connect(
    producer: AIOKafkaProducer,
    serializer: Optional[SerializerProto],
    codec: Optional[CodecProto] = None,
) -> None
Source code in faststream/kafka/publisher/producer.py
 94
 95
 96
 97
 98
 99
100
101
102
103
async def connect(
    self,
    producer: "AIOKafkaProducer",
    serializer: Optional["SerializerProto"],
    codec: Optional["CodecProto"] = None,
) -> None:
    self.serializer = serializer
    self.codec = codec or DefaultCodec()
    await producer.start()
    self._producer = RealProducer(producer)

disconnect async #

disconnect() -> None
Source code in faststream/kafka/publisher/producer.py
105
106
107
async def disconnect(self) -> None:
    await self._producer.stop()
    self._producer = EmptyProducerState()

flush async #

flush() -> None
Source code in faststream/kafka/publisher/producer.py
116
117
async def flush(self) -> None:
    await self._producer.flush()

publish async #

publish(
    cmd: KafkaPublishCommand,
) -> Union[Future[RecordMetadata], RecordMetadata]

Publish a message to a topic.

Source code in faststream/kafka/publisher/producer.py
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
147
148
@override
async def publish(
    self,
    cmd: "KafkaPublishCommand",
) -> Union["asyncio.Future[RecordMetadata]", "RecordMetadata"]:
    """Publish a message to a topic."""
    if cmd.body is None and cmd.key is not None:
        # keyed None is a tombstone: aiokafka requires at least key or value,
        # so a keyless None still goes through the codec as b""
        message, content_type = None, None
    else:
        message, content_type = await self.codec.encode(cmd.body, self.serializer)

    headers_to_send = {
        "content-type": content_type or "",
        **cmd.headers_to_publish(),
    }

    send_future = await self._producer.producer.send(
        topic=cmd.destination,
        value=message,
        key=cmd.key,
        partition=cmd.partition,
        timestamp_ms=cmd.timestamp_ms,
        headers=encode_headers(headers_to_send),
    )

    if not cmd.no_confirm:
        return await send_future
    return send_future

publish_batch async #

publish_batch(
    cmd: KafkaPublishCommand,
) -> Union[Future[RecordMetadata], RecordMetadata]

Publish a batch of messages to a topic.

Source code in faststream/kafka/publisher/producer.py
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
@override
async def publish_batch(
    self,
    cmd: "KafkaPublishCommand",
) -> Union["asyncio.Future[RecordMetadata]", "RecordMetadata"]:
    """Publish a batch of messages to a topic."""
    batch = self._producer.producer.create_batch()

    headers_to_send = cmd.headers_to_publish()

    if isinstance(self.codec, BatchCodecProto):
        encoded_batch = await self.codec.encode_batch(
            cmd.batch_bodies, self.serializer
        )
    else:
        encoded_batch = [
            await self.codec.encode(body, self.serializer)
            for body in cmd.batch_bodies
        ]

    for message_position, (message, content_type) in enumerate(encoded_batch):
        if content_type:
            final_headers = {
                "content-type": content_type,
                **headers_to_send,
            }
        else:
            final_headers = headers_to_send.copy()

        metadata = batch.append(
            key=cmd.key_for(message_position),
            value=message,
            timestamp=cmd.timestamp_ms,
            headers=encode_headers(final_headers),
        )
        if metadata is None:
            raise BatchBufferOverflowException(message_position=message_position)

    send_future = await self._producer.producer.send_batch(
        batch,
        cmd.destination,
        partition=cmd.partition,
    )
    if not cmd.no_confirm:
        return await send_future
    return send_future

request async #

request(cmd: KafkaPublishCommand) -> Any
Source code in faststream/kafka/publisher/producer.py
63
64
65
66
@override
async def request(self, cmd: "KafkaPublishCommand") -> Any:
    msg = "Kafka doesn't support `request` method without test client."
    raise FeatureNotSupportedException(msg)