Skip to content

Commit 2c244c5

Browse files
hongqnvladvildanov
authored andcommitted
docs: Add timeout parameter for get_message example (#3129)
The `get_message()` method in asyncio PubSub has a `timeout` argument that defaults to 0.0, causing it to immediately return. This can cause high CPU usage with the given code example and should not be recommended. By setting `timeout=None`, it works with much more efficient resource usage.
1 parent 58f57e6 commit 2c244c5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/examples/asyncio_examples.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@
201201
"\n",
202202
"async def reader(channel: redis.client.PubSub):\n",
203203
" while True:\n",
204-
" message = await channel.get_message(ignore_subscribe_messages=True)\n",
204+
" message = await channel.get_message(ignore_subscribe_messages=True, timeout=None)\n",
205205
" if message is not None:\n",
206206
" print(f\"(Reader) Message Received: {message}\")\n",
207207
" if message[\"data\"].decode() == STOPWORD:\n",
@@ -264,7 +264,7 @@
264264
"\n",
265265
"async def reader(channel: redis.client.PubSub):\n",
266266
" while True:\n",
267-
" message = await channel.get_message(ignore_subscribe_messages=True)\n",
267+
" message = await channel.get_message(ignore_subscribe_messages=True, timeout=None)\n",
268268
" if message is not None:\n",
269269
" print(f\"(Reader) Message Received: {message}\")\n",
270270
" if message[\"data\"].decode() == STOPWORD:\n",

0 commit comments

Comments
 (0)