From 97e249ac29c721bef19cf09e651fff6647cc270a Mon Sep 17 00:00:00 2001 From: Qiangning Hong Date: Tue, 30 Jan 2024 09:21:14 -0600 Subject: [PATCH] docs: Add timeout parameter for get_message example 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. --- docs/examples/asyncio_examples.ipynb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/examples/asyncio_examples.ipynb b/docs/examples/asyncio_examples.ipynb index 5eab4db1f7..5029e907da 100644 --- a/docs/examples/asyncio_examples.ipynb +++ b/docs/examples/asyncio_examples.ipynb @@ -201,7 +201,7 @@ "\n", "async def reader(channel: redis.client.PubSub):\n", " while True:\n", - " message = await channel.get_message(ignore_subscribe_messages=True)\n", + " message = await channel.get_message(ignore_subscribe_messages=True, timeout=None)\n", " if message is not None:\n", " print(f\"(Reader) Message Received: {message}\")\n", " if message[\"data\"].decode() == STOPWORD:\n", @@ -264,7 +264,7 @@ "\n", "async def reader(channel: redis.client.PubSub):\n", " while True:\n", - " message = await channel.get_message(ignore_subscribe_messages=True)\n", + " message = await channel.get_message(ignore_subscribe_messages=True, timeout=None)\n", " if message is not None:\n", " print(f\"(Reader) Message Received: {message}\")\n", " if message[\"data\"].decode() == STOPWORD:\n",