Skip to content

Response

faststream.Response #

Response(
    body: Any,
    *,
    headers: dict[str, Any] | None = None,
    correlation_id: str | None = None,
)

Initialize a handler.

Source code in faststream/response/response.py 
11
12
13
14
15
16
17
18
19
20
21
def __init__(
    self,
    body: Any,
    *,
    headers: dict[str, Any] | None = None,
    correlation_id: str | None = None,
) -> None:
    """Initialize a handler."""
    self.body = body
    self.headers = headers or {}
    self.correlation_id = correlation_id

body instance-attribute #

body = body

headers instance-attribute #

headers = headers or {}

correlation_id instance-attribute #

correlation_id = correlation_id

as_publish_command #

as_publish_command() -> PublishCommand

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

Source code in faststream/response/response.py 
23
24
25
26
27
28
29
30
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 
32
33
34
35
36
37
38
39
40
41
def get_publish_key(self) -> 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:
        The key for publishing, or None if this Response type doesn't use keys.
    """
    return None