redis.client.PubSub().parse_response() calling

[stacywsmith]

Version: 4.5.5
Platform: CPython 3.8.16 on Ubuntu

Description:
redis.client.PubSub().parse_response() is calling redis.connection.PythonParser().read_response() with a non-existent disconnect_on_error keyword argument.

08:24:16 .tox/_docker/py/lib/python3.8/site-packages/redis/client.py:1690: in get_message
08:24:16     response = self.parse_response(block=(timeout is None), timeout=timeout)
08:24:16 .tox/_docker/py/lib/python3.8/site-packages/redis/client.py:1542: in parse_response
08:24:16     response = self._execute(conn, try_read)
08:24:16 .tox/_docker/py/lib/python3.8/site-packages/redis/client.py:1518: in _execute
08:24:16     return conn.retry.call_with_retry(
08:24:16 .tox/_docker/py/lib/python3.8/site-packages/redis/retry.py:46: in call_with_retry
08:24:16     return do()
08:24:16 .tox/_docker/py/lib/python3.8/site-packages/redis/client.py:1519: in <lambda>
08:24:16     lambda: command(*args, **kwargs),
08:24:16 _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
08:24:16 
08:24:16     def try_read():
08:24:16         if not block:
08:24:16             if not conn.can_read(timeout=timeout):
08:24:16                 return None
08:24:16         else:
08:24:16             conn.connect()
08:24:16 >       return conn.read_response(disconnect_on_error=False)
08:24:16 E       TypeError: read_response() got an unexpected keyword argument 'disconnect_on_error'
08:24:16 
08:24:16 .tox/_docker/py/lib/python3.8/site-packages/redis/client.py:1540: TypeError

[dvora-h]

@kristjanvalur Can you take a look here?

[kristjanvalur]

self.connection is supposed to be an redis.Connection object. If it is something else, then someone must have injected that into the PubSub instance.

[ArtsiomAntropau]

@kristjanvalur wtf?
I have the same error but with another class, error
TypeError: SentinelManagedConnection.read_response() got an unexpected keyword argument 'disconnect_on_error'

This arg passed in line 1540 in file client.py – https://github.com/redis/redis-py/blob/master/redis/client.py#L1540
go to SentinelManagedConnection and check read_response method – https://github.com/redis/redis-py/blob/master/redis/sentinel.py#L56

Someone simply broken it and I don't know how tests are passed – because any linter must catch it.

[kristjanvalur]

Ok, the unit tests don't test PubSub with Sentinel connections. I am not familiar with Sentinel at all. I presume then, that this connection comes from a SentinelConnectionPool.

I guess it means we need to add this functionality to Sentinel connections.

It is unfortunate that we have all these different combinations of different redis clients and the test suite does not, or isn't able to, test them all.

[kristjanvalur]

If you are able to, can you see if pr #2756 fixes your problem?

[ArtsiomAntropau]

@kristjanvalur for my error I think no, because the affected class is SentinelManagedConnection https://github.com/redis/redis-py/blob/master/redis/sentinel.py#L56 and, I think, we need to find and update all read_response methods in Connection childs no matter are them sync or async to unify theirs args/kwargs.

[kristjanvalur]

sorry, synchronous version now amended too, forgot about that.

[ArtsiomAntropau]

@kristjanvalur looks like the right fix for this problem 👍

[kristjanvalur]

Are you able to patch your code with this PR and test? I'm afraid that the standard redis-py test suite does not excercise all the possible cluster combinations.

[kristjanvalur]

don't worry if you can't, this looks like a straigth-forward enough fix and we ought to get it out pretty fast.

[noirbee]

I ran into the same problem this morning; for what it's worth your PR appears to fix it (at least for https://github.com/rq/rq 's use of pubsub/sentinel).

[msingermann-domino]

Hi! We hit the same issue.
Is there any ETA on when will this fix be released to 4.5?

[ns-khp]

Hello! We too hit the same issue.
Is there any ETA on when will this fix be available?

[ArtsiomAntropau]

Folks, I can suggest using a little fix in your requirements.txt or pyproject.toml, construction like

~=4.5, !=4.5.5

will work pretty well when you need the latest actual 4.X version that is more than 4.5.0 and not 4.5.5.
Take a look into PEP 440: Version specifiers for more details.

Please use it instead of pinging this thread, while release will not be provided.