Skip to content

MQTTPublishCommand

faststream.mqtt.response.MQTTPublishCommand #

MQTTPublishCommand(
    message: SendableMessage,
    *,
    topic: str = "",
    correlation_id: str | None = None,
    headers: dict[str, str] | None = None,
    reply_to: str = "",
    qos: QoS = AT_MOST_ONCE,
    retain: bool = False,
    message_expiry_interval: int | None = None,
    timeout: float | None = 30.0,
    _publish_type: PublishType,
)

Bases: PublishCommand

Source code in faststream/mqtt/response.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def __init__(
    self,
    message: "SendableMessage",
    *,
    topic: str = "",
    correlation_id: str | None = None,
    headers: dict[str, str] | None = None,
    reply_to: str = "",
    qos: QoS = QoS.AT_MOST_ONCE,
    retain: bool = False,
    message_expiry_interval: int | None = None,
    timeout: float | None = 30.0,
    _publish_type: PublishType,
) -> None:
    super().__init__(
        body=message,
        destination=topic,
        correlation_id=correlation_id,
        headers=headers,
        reply_to=reply_to,
        _publish_type=_publish_type,
    )
    self.qos = qos
    self.retain = retain
    self.message_expiry_interval = message_expiry_interval
    self.timeout = timeout

qos instance-attribute #

qos = qos

retain instance-attribute #

retain = retain

message_expiry_interval instance-attribute #

message_expiry_interval = message_expiry_interval

timeout instance-attribute #

timeout = timeout

body instance-attribute #

body = body

headers instance-attribute #

headers = headers or {}

correlation_id instance-attribute #

correlation_id = correlation_id

destination instance-attribute #

destination = destination

reply_to instance-attribute #

reply_to = reply_to

publish_type instance-attribute #

publish_type = _publish_type

batch_bodies property #

batch_bodies: tuple[Any, ...]

from_cmd classmethod #

from_cmd(
    cmd: Union[PublishCommand, MQTTPublishCommand],
) -> MQTTPublishCommand
Source code in faststream/mqtt/response.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
@classmethod
def from_cmd(
    cls,
    cmd: Union["PublishCommand", "MQTTPublishCommand"],
) -> "MQTTPublishCommand":
    if isinstance(cmd, MQTTPublishCommand):
        return cmd

    return cls(
        message=cmd.body,
        topic=cmd.destination,
        correlation_id=cmd.correlation_id,
        headers=cmd.headers,
        reply_to=cmd.reply_to,
        timeout=getattr(cmd, "timeout", None),
        _publish_type=cmd.publish_type,
    )

as_publish_command #

as_publish_command() -> PublishCommand

Method to transform handlers' Response result to DTO for publishers.

Source code in faststream/response/response.py 
22
23
24
25
26
27
28
29
def as_publish_command(self) -> "PublishCommand":
    """Method to transform handlers' Response result to DTO for publishers."""
    return PublishCommand(
        body=self.body,
        headers=self.headers,
        correlation_id=self.correlation_id,
        _publish_type=PublishType.PUBLISH,
    )

get_publish_key #

get_publish_key() -> Any | None

Get the key for publishing this message.

Override this method in subclasses to provide broker-specific keys. Default implementation returns None (no key).

RETURNS DESCRIPTION
Any | None

The key for publishing, or None if this Response type doesn't use keys.
Source code in faststream/response/response.py 
31
32
33
34
35
36
37
38
39
40
def get_publish_key(self) -> Any | None:  # noqa: PLR6301
    """Get the key for publishing this message.

    Override this method in subclasses to provide broker-specific keys.
    Default implementation returns None (no key).

    Returns:
        The key for publishing, or None if this Response type doesn't use keys.
    """
    return None

add_headers #

add_headers(
    headers: dict[str, Any], *, override: bool = True
) -> None
Source code in faststream/response/response.py 
71
72
73
74
75
76
77
78
79
80
def add_headers(
    self,
    headers: dict[str, Any],
    *,
    override: bool = True,
) -> None:
    if override:
        self.headers |= headers
    else:
        self.headers = headers | self.headers