RabbitPublisher

faststream.rabbit.RabbitPublisher

RabbitPublisher(
    queue="",
    exchange=None,
    *,
    routing_key="",
    mandatory=True,
    immediate=False,
    timeout=None,
    persist=False,
    reply_to=None,
    priority=None,
    middlewares=(),
    title=None,
    description=None,
    schema=None,
    include_in_schema=True,
    headers=None,
    content_type=None,
    content_encoding=None,
    expiration=None,
    message_type=None,
    user_id=None,
)

Bases: ArgsContainer

Delayed RabbitPublisher registration object.

Just a copy of RabbitRegistrator.publisher(...) arguments.

Initialized RabbitPublisher.

PARAMETER	DESCRIPTION
queue	Default message routing key to publish with. Can be any RabbitQueue instance or string representation of the queue. TYPE: Union[RabbitQueue, str] DEFAULT: ''
exchange	Target exchange to publish message to. Any RabbitExchange instance or string representation of the exchange. If not specified, it will default to the value provided in queue. TYPE: Union[RabbitExchange, str, None] DEFAULT: None
routing_key	Default message routing key to publish with. Overrides queue option if presented. TYPE: str DEFAULT: ''
mandatory	Client waits for confirmation that the message is placed to some queue. RabbitMQ returns message to client if there is no suitable queue. TYPE: bool DEFAULT: True
immediate	Client expects that there is consumer ready to take the message to work. RabbitMQ returns message to client if there is no suitable consumer. TYPE: bool DEFAULT: False
timeout	Send confirmation time from RabbitMQ. TYPE: TimeoutType DEFAULT: None
persist	Restore the message on RabbitMQ reboot. TYPE: bool DEFAULT: False
reply_to	Reply message routing key to send with (always sending to default exchange). TYPE: str | None DEFAULT: None
priority	The message priority (0 by default). TYPE: int | None DEFAULT: None
middlewares	Publisher middlewares to wrap outgoing messages. TYPE: Sequence[PublisherMiddleware] DEFAULT: ()
title	AsyncAPI publisher object title. TYPE: str | None DEFAULT: None
description	AsyncAPI publisher object description. TYPE: str | None DEFAULT: None
schema	AsyncAPI publishing message type. Should be any python-native object annotation or pydantic.BaseModel. TYPE: Any | None DEFAULT: None
include_in_schema	Whetever to include operation in AsyncAPI schema or not. TYPE: bool DEFAULT: True
headers	Message headers to store metainformation. Can be overridden by publish.headers if specified. TYPE: Optional[HeadersType] DEFAULT: None
content_type	Message content-type header. Used by application, not core RabbitMQ. Will be set automatically if not specified. TYPE: str | None DEFAULT: None
content_encoding	Message body content encoding, e.g. gzip. TYPE: str | None DEFAULT: None
expiration	Message expiration (lifetime) in seconds (or datetime or timedelta). TYPE: Optional[DateType] DEFAULT: None
message_type	Application-specific message type, e.g. orders.created. TYPE: str | None DEFAULT: None
user_id	Publisher connection User ID, validated if set. TYPE: str | None DEFAULT: None

Source code in faststream/rabbit/broker/router.py

def __init__(
    self,
    queue: Union["RabbitQueue", str] = "",
    exchange: Union["RabbitExchange", str, None] = None,
    *,
    routing_key: str = "",
    mandatory: bool = True,
    immediate: bool = False,
    timeout: "TimeoutType" = None,
    persist: bool = False,
    reply_to: str | None = None,
    priority: int | None = None,
    # basic args
    middlewares: Annotated[
        Sequence["PublisherMiddleware"],
        deprecated(
            "This option was deprecated in 0.6.0. Use router-level middlewares instead."
            "Scheduled to remove in 0.7.0",
        ),
    ] = (),
    # AsyncAPI args
    title: str | None = None,
    description: str | None = None,
    schema: Any | None = None,
    include_in_schema: bool = True,
    # message args
    headers: Optional["HeadersType"] = None,
    content_type: str | None = None,
    content_encoding: str | None = None,
    expiration: Optional["DateType"] = None,
    message_type: str | None = None,
    user_id: str | None = None,
) -> None:
    """Initialized RabbitPublisher.

    Args:
        queue:
            Default message routing key to publish with.
            Can be any `RabbitQueue` instance or string representation of the queue.
        exchange:
            Target exchange to publish message to.
            Any `RabbitExchange` instance or string representation of the exchange. If not
            specified, it will default to the value provided in `queue`.
        routing_key:
            Default message routing key to publish with. Overrides `queue`
            option if presented.
        mandatory:
            Client waits for confirmation that the message is placed to some queue.
            RabbitMQ returns message to client if there is no suitable queue.
        immediate:
            Client expects that there is consumer ready to take the message to work.
            RabbitMQ returns message to client if there is no suitable consumer.
        timeout:
            Send confirmation time from RabbitMQ.
        persist:
            Restore the message on RabbitMQ reboot.
        reply_to:
            Reply message routing key to send with (always sending to default exchange).
        priority:
            The message priority (0 by default).
        middlewares:
            Publisher middlewares to wrap outgoing messages.
        title:
            AsyncAPI publisher object title.
        description:
            AsyncAPI publisher object description.
        schema:
            AsyncAPI publishing message type. Should be any python-native object annotation or `pydantic.BaseModel`.
        include_in_schema:
            Whetever to include operation in AsyncAPI schema or not.
        headers:
            Message headers to store metainformation. Can be overridden by `publish.headers` if specified.
        content_type:
            Message **content-type** header. Used by application, not core RabbitMQ. Will be set automatically if not specified.
        content_encoding:
            Message body content encoding, e.g. **gzip**.
        expiration:
            Message expiration (lifetime) in seconds (or datetime or timedelta).
        message_type:
            Application-specific message type, e.g. **orders.created**.
        user_id:
            Publisher connection User ID, validated if set.
    """
    super().__init__(
        queue=queue,
        exchange=exchange,
        routing_key=routing_key,
        mandatory=mandatory,
        immediate=immediate,
        timeout=timeout,
        persist=persist,
        reply_to=reply_to,
        priority=priority,
        headers=headers,
        content_type=content_type,
        content_encoding=content_encoding,
        expiration=expiration,
        message_type=message_type,
        user_id=user_id,
        # basic args
        middlewares=middlewares,
        # AsyncAPI args
        title=title,
        description=description,
        schema=schema,
        include_in_schema=include_in_schema,
    )

args instance-attribute

args = args

kwargs instance-attribute

kwargs = kwargs