Skip to content

RedisFastProducer

faststream.redis.producer.RedisFastProducer #

RedisFastProducer(connection: Redis[bytes], parser: Union[None, AsyncCustomParser[OneMessage, OneRedisMessage], AsyncCustomParser[BatchMessage, BatchRedisMessage]], decoder: Union[None, AsyncCustomDecoder[OneRedisMessage], AsyncCustomDecoder[BatchRedisMessage]])

A class to represent a Redis producer.

Initialize the Redis producer.

PARAMETER DESCRIPTION
connection

The Redis connection.

TYPE: Redis[bytes]

parser

The parser.

TYPE: Union[None, AsyncCustomParser[OneMessage, OneRedisMessage], AsyncCustomParser[BatchMessage, BatchRedisMessage]]

decoder

The decoder.

TYPE: Union[None, AsyncCustomDecoder[OneRedisMessage], AsyncCustomDecoder[BatchRedisMessage]]

Source code in faststream/redis/producer.py 
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
def __init__(
    self,
    connection: "Redis[bytes]",
    parser: Union[
        None,
        AsyncCustomParser[OneMessage, OneRedisMessage],
        AsyncCustomParser[BatchMessage, BatchRedisMessage],
    ],
    decoder: Union[
        None,
        AsyncCustomDecoder[OneRedisMessage],
        AsyncCustomDecoder[BatchRedisMessage],
    ],
) -> None:
    """Initialize the Redis producer.

    Args:
        connection: The Redis connection.
        parser: The parser.
        decoder: The decoder.
    """
    self._connection = connection
    self._parser = resolve_custom_func(
        parser,  # type: ignore[arg-type,assignment]
        RedisParser.parse_message,
    )
    self._decoder = resolve_custom_func(decoder, RedisParser.decode_message)

publish async #

publish(message: SendableMessage, channel: Optional[str] = None, reply_to: str = '', headers: Optional[AnyDict] = None, correlation_id: Optional[str] = None, *, list: Optional[str] = None, stream: Optional[str] = None, rpc: bool = False, rpc_timeout: Optional[float] = 30.0, raise_timeout: bool = False, maxlen: Optional[int] = None) -> Optional[Any]
Source code in faststream/redis/producer.py 
 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
127
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
async def publish(
    self,
    message: SendableMessage,
    channel: Optional[str] = None,
    reply_to: str = "",
    headers: Optional[AnyDict] = None,
    correlation_id: Optional[str] = None,
    *,
    list: Optional[str] = None,
    stream: Optional[str] = None,
    rpc: bool = False,
    rpc_timeout: Optional[float] = 30.0,
    raise_timeout: bool = False,
    maxlen: Optional[int] = None,
) -> Optional[Any]:
    if not any((channel, list, stream)):
        raise ValueError(INCORRECT_SETUP_MSG)

    psub: Optional["PubSub"] = None
    if rpc is True:
        if reply_to:
            raise WRONG_PUBLISH_ARGS

        reply_to = str(uuid4())
        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))

publish_batch async #

publish_batch(*msgs: SendableMessage, list: str) -> None
Source code in faststream/redis/producer.py 
157
158
159
160
161
162
163
async def publish_batch(
    self,
    *msgs: SendableMessage,
    list: str,
) -> None:
    batch = (encode_message(msg)[0] for msg in msgs)
    await self._connection.rpush(list, *batch)