Skip to content

AioPikaParser

faststream.rabbit.parser.AioPikaParser #

AioPikaParser(pattern: Optional[Pattern[str]] = None)

A class for parsing, encoding, and decoding messages using aio-pika.

Source code in faststream/rabbit/parser.py 
34
35
def __init__(self, pattern: Optional["Pattern[str]"] = None) -> None:
    self.pattern = pattern

pattern instance-attribute #

pattern = pattern

parse_message async #

parse_message(
    message: IncomingMessage,
) -> StreamMessage[IncomingMessage]

Parses an incoming message and returns a RabbitMessage object.

Source code in faststream/rabbit/parser.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
async def parse_message(
    self,
    message: "IncomingMessage",
) -> StreamMessage["IncomingMessage"]:
    """Parses an incoming message and returns a RabbitMessage object."""
    path = match_path(self.pattern, message.routing_key or "")

    return RabbitMessage(
        body=message.body,
        headers=message.headers,
        reply_to=message.reply_to or "",
        content_type=message.content_type,
        message_id=message.message_id or gen_cor_id(),
        correlation_id=message.correlation_id or gen_cor_id(),
        path=path,
        raw_message=message,
    )

decode_message async #

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

Decode a message.

Source code in faststream/rabbit/parser.py 
55
56
57
58
59
60
async def decode_message(  # ruff: ignore[no-self-use]
    self,
    msg: StreamMessage["IncomingMessage"],
) -> "DecodedMessage":
    """Decode a message."""
    return decode_message(msg)

encode_message async staticmethod #

encode_message(
    message: AioPikaSendableMessage,
    *,
    persist: bool = False,
    reply_to: str | None = None,
    headers: Optional[HeadersType] = None,
    content_type: str | None = None,
    content_encoding: str | None = None,
    priority: int | None = None,
    correlation_id: str | None = None,
    expiration: DateType = None,
    message_id: str | None = None,
    timestamp: DateType = None,
    message_type: str | None = None,
    user_id: str | None = None,
    app_id: str | None = None,
    serializer: Optional[SerializerProto] = None,
    codec: Optional[CodecProto] = None,
    id_generator: IdGenerator = gen_cor_id,
) -> Message

Encodes a message for sending using AioPika.

Source code in faststream/rabbit/parser.py 
 62
 63
 64
 65
 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
106
107
108
109
110
@staticmethod
async def encode_message(
    message: "AioPikaSendableMessage",
    *,
    persist: bool = False,
    reply_to: str | None = None,
    headers: Optional["HeadersType"] = None,
    content_type: str | None = None,
    content_encoding: str | None = None,
    priority: int | None = None,
    correlation_id: str | None = None,
    expiration: "DateType" = None,
    message_id: str | None = None,
    timestamp: "DateType" = None,
    message_type: str | None = None,
    user_id: str | None = None,
    app_id: str | None = None,
    serializer: Optional["SerializerProto"] = None,
    codec: Optional["CodecProto"] = None,
    id_generator: IdGenerator = gen_cor_id,
) -> Message:
    """Encodes a message for sending using AioPika."""
    if isinstance(message, Message):
        return message

    message_body, generated_content_type = await (codec or DefaultCodec()).encode(
        message, serializer
    )

    delivery_mode = (
        DeliveryMode.PERSISTENT if persist else DeliveryMode.NOT_PERSISTENT
    )

    return Message(
        message_body,
        content_type=content_type or generated_content_type,
        delivery_mode=delivery_mode,
        reply_to=reply_to,
        correlation_id=correlation_id or id_generator(),
        headers=headers,
        content_encoding=content_encoding,
        priority=priority,
        expiration=expiration,
        message_id=message_id,
        timestamp=timestamp or datetime.now(tz=timezone.utc),
        type=message_type,
        user_id=user_id,
        app_id=app_id,
    )