Skip to content

RedisFastProducer

faststream.redis.publisher.producer.RedisFastProducer #

RedisFastProducer(connection, parser, decoder)

Bases: ProducerProto

A class to represent a Redis producer.

Source code in faststream/redis/publisher/producer.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def __init__(
    self,
    connection: "Redis[bytes]",
    parser: Optional["CustomCallable"],
    decoder: Optional["CustomCallable"],
) -> None:
    self._connection = connection

    default = RedisPubSubParser()
    self._parser = resolve_custom_func(
        parser,
        default.parse_message,
    )
    self._decoder = resolve_custom_func(
        decoder,
        default.decode_message,
    )

publish async #

publish(
    message,
    *,
    correlation_id,
    channel=None,
    list=None,
    stream=None,
    maxlen=None,
    headers=None,
    reply_to="",
    rpc=False,
    rpc_timeout=30.0,
    raise_timeout=False,
)
Source code in faststream/redis/publisher/producer.py 
 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
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
@override
async def publish(  # type: ignore[override]
    self,
    message: "SendableMessage",
    *,
    correlation_id: str,
    channel: Optional[str] = None,
    list: Optional[str] = None,
    stream: Optional[str] = None,
    maxlen: Optional[int] = None,
    headers: Optional["AnyDict"] = None,
    reply_to: str = "",
    rpc: bool = False,
    rpc_timeout: Optional[float] = 30.0,
    raise_timeout: bool = False,
) -> Optional[Any]:
    if not any((channel, list, stream)):
        raise SetupError(INCORRECT_SETUP_MSG)

    psub: Optional[PubSub] = None
    if rpc:
        if reply_to:
            raise WRONG_PUBLISH_ARGS
        nuid = NUID()
        rpc_nuid = str(nuid.next(), "utf-8")
        reply_to = rpc_nuid
        psub = self._connection.pubsub()
        await psub.subscribe(reply_to)

    msg = RawMessage.encode(
        message=message,
        reply_to=reply_to,
        headers=headers,
        correlation_id=correlation_id,
    )

    if channel is not None:
        await self._connection.publish(channel, msg)
    elif list is not None:
        await self._connection.rpush(list, msg)
    elif stream is not None:
        await self._connection.xadd(
            name=stream,
            fields={DATA_KEY: msg},
            maxlen=maxlen,
        )
    else:
        raise AssertionError("unreachable")

    if psub is None:
        return None

    else:
        m = None
        with timeout_scope(rpc_timeout, raise_timeout):
            # skip subscribe message
            await psub.get_message(
                ignore_subscribe_messages=True,
                timeout=rpc_timeout or 0.0,
            )

            # get real response
            m = await psub.get_message(
                ignore_subscribe_messages=True,
                timeout=rpc_timeout or 0.0,
            )

        await psub.unsubscribe()
        await psub.aclose()  # type: ignore[attr-defined]

        if m is None:
            if raise_timeout:
                raise TimeoutError()
            else:
                return None
        else:
            return await self._decoder(await self._parser(m))

request async #

request(
    message,
    *,
    correlation_id,
    channel=None,
    list=None,
    stream=None,
    maxlen=None,
    headers=None,
    timeout=30.0,
)
Source code in faststream/redis/publisher/producer.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
@override
async def request(  # type: ignore[override]
    self,
    message: "SendableMessage",
    *,
    correlation_id: str,
    channel: Optional[str] = None,
    list: Optional[str] = None,
    stream: Optional[str] = None,
    maxlen: Optional[int] = None,
    headers: Optional["AnyDict"] = None,
    timeout: Optional[float] = 30.0,
) -> "Any":
    if not any((channel, list, stream)):
        raise SetupError(INCORRECT_SETUP_MSG)

    nuid = NUID()
    reply_to = str(nuid.next(), "utf-8")
    psub = self._connection.pubsub()
    await psub.subscribe(reply_to)

    msg = RawMessage.encode(
        message=message,
        reply_to=reply_to,
        headers=headers,
        correlation_id=correlation_id,
    )

    if channel is not None:
        await self._connection.publish(channel, msg)
    elif list is not None:
        await self._connection.rpush(list, msg)
    elif stream is not None:
        await self._connection.xadd(
            name=stream,
            fields={DATA_KEY: msg},
            maxlen=maxlen,
        )
    else:
        raise AssertionError("unreachable")

    with anyio.fail_after(timeout) as scope:
        # skip subscribe message
        await psub.get_message(
            ignore_subscribe_messages=True,
            timeout=timeout or 0.0,
        )

        # get real response
        response_msg = await psub.get_message(
            ignore_subscribe_messages=True,
            timeout=timeout or 0.0,
        )

    await psub.unsubscribe()
    await psub.aclose()  # type: ignore[attr-defined]

    if scope.cancel_called:
        raise TimeoutError

    return response_msg

publish_batch async #

publish_batch(*msgs, list, correlation_id, headers=None)
Source code in faststream/redis/publisher/producer.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
async def publish_batch(
    self,
    *msgs: "SendableMessage",
    list: str,
    correlation_id: str,
    headers: Optional["AnyDict"] = None,
) -> None:
    batch = (
        RawMessage.encode(
            message=msg,
            correlation_id=correlation_id,
            reply_to=None,
            headers=headers,
        )
        for msg in msgs
    )
    await self._connection.rpush(list, *batch)