Skip to content

build_message

faststream.mqtt.testing.build_message async #

build_message(
    message: SendableMessage,
    topic: str,
    *,
    version: MQTTVersion = "5.0",
    qos: int = 0,
    retain: bool = False,
    reply_to: str = "",
    correlation_id: str | None = None,
    headers: dict[str, str] | None = None,
    serializer: Optional[SerializerProto] = None,
    codec: Optional[CodecProto] = None,
) -> Message

Build a fake zmqtt.Message from publish parameters.

For MQTT 5.0 uses PublishProperties to carry metadata so that MQTTParserV5 can extract them transparently. For MQTT 3.1.1 returns a plain message with raw payload only.

Source code in faststream/mqtt/testing.py
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
async def build_message(
    message: "SendableMessage",
    topic: str,
    *,
    version: MQTTVersion = "5.0",
    qos: int = 0,
    retain: bool = False,
    reply_to: str = "",
    correlation_id: str | None = None,
    headers: dict[str, str] | None = None,
    serializer: Optional["SerializerProto"] = None,
    codec: Optional["CodecProto"] = None,
) -> zmqtt.Message:
    """Build a fake ``zmqtt.Message`` from publish parameters.

    For MQTT 5.0 uses *PublishProperties* to carry metadata so that
    ``MQTTParserV5`` can extract them transparently.
    For MQTT 3.1.1 returns a plain message with raw payload only.
    """
    if codec is None:
        codec = DefaultCodec()
    payload, content_type = await codec.encode(message, serializer=serializer)

    if version == "3.1.1":
        return zmqtt.Message(
            topic=topic,
            payload=payload,
            qos=zmqtt.QoS(qos),
            retain=retain,
        )

    user_props: list[tuple[str, str]] = list((headers or {}).items())

    properties = zmqtt.PublishProperties(
        content_type=content_type or None,
        response_topic=reply_to or None,
        correlation_data=correlation_id.encode() if correlation_id else None,
        user_properties=tuple(user_props),
    )

    return zmqtt.Message(
        topic=topic,
        payload=payload,
        qos=zmqtt.QoS(qos),
        retain=retain,
        properties=properties,
    )