Skip to content

RedisPublisher

faststream.redis.RedisPublisher #

RedisPublisher(
    channel: str | None = None,
    *,
    list: str | None = None,
    stream: str | None = None,
    headers: dict[str, Any] | None = None,
    reply_to: str = "",
    middlewares: Sequence[PublisherMiddleware] = (),
    title: str | None = None,
    description: str | None = None,
    schema: Any | None = None,
    include_in_schema: bool = True,
)

Bases: ArgsContainer

Delayed RedisPublisher registration object.

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

Initialize the RedisPublisher.

PARAMETER DESCRIPTION
channel

Redis PubSub object name to send message.

TYPE: str | None DEFAULT: None

list

Redis List object name to send message.

TYPE: str | None DEFAULT: None

stream

Redis Stream object name to send message.

TYPE: str | None DEFAULT: None

headers

Message headers to store metainformation. Can be overridden by publish.headers if specified.

TYPE: dict[str, Any] | None DEFAULT: None

reply_to

Reply message destination PubSub object name.

TYPE: str DEFAULT: ''

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.

TYPE: Any | None DEFAULT: None

include_in_schema

Whetever to include operation in AsyncAPI schema or not.

TYPE: bool DEFAULT: True

Source code in faststream/redis/broker/router.py 
35
36
37
38
39
40
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def __init__(
    self,
    channel: str | None = None,
    *,
    list: str | None = None,
    stream: str | None = None,
    headers: dict[str, Any] | None = None,
    reply_to: str = "",
    middlewares: Sequence["PublisherMiddleware"] = (),
    title: str | None = None,
    description: str | None = None,
    schema: Any | None = None,
    include_in_schema: bool = True,
) -> None:
    """Initialize the RedisPublisher.

    Args:
        channel:
            Redis PubSub object name to send message.
        list:
            Redis List object name to send message.
        stream:
            Redis Stream object name to send message.
        headers:
            Message headers to store metainformation. Can be overridden by `publish.headers` if specified.
        reply_to:
            Reply message destination PubSub object name.
        middlewares:
            Publisher middlewares to wrap outgoing messages.
        title:
            AsyncAPI publisher object title.
        description:
            AsyncAPI publisher object description.
        schema:
            AsyncAPI publishing message type.
        include_in_schema:
            Whetever to include operation in AsyncAPI schema or not.

    """
    super().__init__(
        channel=channel,
        list=list,
        stream=stream,
        headers=headers,
        reply_to=reply_to,
        middlewares=middlewares,
        title=title,
        description=description,
        schema=schema,
        include_in_schema=include_in_schema,
    )

args instance-attribute #

args: Iterable[Any] = args

kwargs instance-attribute #

kwargs: dict[str, Any] = kwargs