Skip to content

AioKafkaParser

faststream.kafka.parser.AioKafkaParser #

AioKafkaParser(
    msg_class: type[KafkaMessage],
    regex: Optional[Pattern[str]],
)

A class to parse Kafka messages.

Source code in faststream/kafka/parser.py 
23
24
25
26
27
28
29
30
31
def __init__(
    self,
    msg_class: type[KafkaMessage],
    regex: Optional["Pattern[str]"],
) -> None:
    self.msg_class = msg_class
    self.regex = regex

    self._consumer: ConsumerProtocol = FAKE_CONSUMER

msg_class instance-attribute #

msg_class = msg_class

regex instance-attribute #

regex = regex

parse_message async #

parse_message(
    message: Union[ConsumerRecord, KafkaRawMessage],
) -> StreamMessage[ConsumerRecord]

Parses a Kafka message.

Source code in faststream/kafka/parser.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
async def parse_message(
    self,
    message: Union["ConsumerRecord", "KafkaRawMessage"],
) -> "StreamMessage[ConsumerRecord]":
    """Parses a Kafka message."""
    headers = {i: j.decode() for i, j in message.headers}

    return self.msg_class(
        body=message.value or b"",
        headers=headers,
        reply_to=headers.get("reply_to", ""),
        content_type=headers.get("content-type"),
        message_id=f"{message.offset}-{message.timestamp}",
        correlation_id=headers.get("correlation_id"),
        raw_message=message,
        path=self.get_path(message.topic),
        consumer=getattr(message, "consumer", self._consumer),
    )

decode_message async #

decode_message(
    msg: StreamMessage[ConsumerRecord],
) -> DecodedMessage

Decodes a message.

Source code in faststream/kafka/parser.py 
55
56
57
58
59
60
async def decode_message(
    self,
    msg: "StreamMessage[ConsumerRecord]",
) -> "DecodedMessage":
    """Decodes a message."""
    return decode_message(msg)

get_path #

get_path(topic: str) -> dict[str, str]
Source code in faststream/kafka/parser.py 
62
63
64
65
def get_path(self, topic: str) -> dict[str, str]:
    if self.regex and (match := self.regex.match(topic)):
        return match.groupdict()
    return {}