Skip to content

RabbitPublishCommand

faststream.rabbit.RabbitPublishCommand #

RabbitPublishCommand(
    message: AioPikaSendableMessage,
    *,
    _publish_type: PublishType,
    routing_key: str = "",
    exchange: RabbitExchange | None = None,
    mandatory: bool = True,
    immediate: bool = False,
    timeout: TimeoutType = None,
    **message_options: Unpack[MessageOptions],
)

Bases: PublishCommand

Source code in faststream/rabbit/response.py 
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
def __init__(
    self,
    message: "AioPikaSendableMessage",
    *,
    _publish_type: PublishType,
    routing_key: str = "",
    exchange: RabbitExchange | None = None,
    # publish kwargs
    mandatory: bool = True,
    immediate: bool = False,
    timeout: "TimeoutType" = None,
    **message_options: Unpack["MessageOptions"],
) -> None:
    headers = message_options.pop("headers", {})
    reply_to = message_options.pop("reply_to", None) or ""
    correlation_id = message_options.pop("correlation_id", None)

    super().__init__(
        body=message,
        destination=routing_key,
        correlation_id=correlation_id,
        headers=headers,
        reply_to=reply_to,
        _publish_type=_publish_type,
    )

    self._exchange = exchange

    self.timeout = timeout

    self.message_options: BasicMessageOptions = message_options
    self.publish_options: PublishOptions = {
        "mandatory": mandatory,
        "immediate": immediate,
    }

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, ...]

timeout instance-attribute #

timeout = timeout

message_options instance-attribute #

message_options: BasicMessageOptions = message_options

publish_options instance-attribute #

publish_options: PublishOptions = {
    "mandatory": mandatory,
    "immediate": immediate,
}

exchange property writable #

exchange: RabbitExchange

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

from_cmd classmethod #

from_cmd(
    cmd: Union[PublishCommand, RabbitPublishCommand],
) -> RabbitPublishCommand
Source code in faststream/rabbit/response.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
@classmethod
def from_cmd(
    cls,
    cmd: Union["PublishCommand", "RabbitPublishCommand"],
) -> "RabbitPublishCommand":
    if isinstance(cmd, RabbitPublishCommand):
        # NOTE: Should return a copy probably.
        return cmd

    return cls(
        message=cmd.body,
        routing_key=cmd.destination,
        correlation_id=cmd.correlation_id,
        headers=cmd.headers,
        reply_to=cmd.reply_to,
        _publish_type=cmd.publish_type,
    )