Fix docs for "hosts" #335

vanschelven · 2022-10-21T11:12:52Z

Fixes #334

A more thorough (and backward compatible) fix would be to actually make tuples work again.

Fixes django#334 A more thorough (and backward compatible) fix would be to actually make tuples work again.

The pointer to redis.connection.Connection was misleading, because in actualitly from_url is used: https://github.com/django/channels_redis/blob/95d87449c2b899c1cfdf8a10cfa1425e30127ef2/channels_redis/pubsub.py#L349

sevdog

Tuple "decoding" is not working only in RedisPubSubChannelLayer, the base RedisChannelLayer has a dedicated method to handle it:

channels_redis/channels_redis/core.py

Lines 146 to 169 in a7094c5

    
               def decode_hosts(self, hosts): 
        
                   """ 
        
                   Takes the value of the "hosts" argument passed to the class and returns 
        
                   a list of kwargs to use for the Redis connection constructor. 
        
                   """ 
        
                   # If no hosts were provided, return a default value 
        
                   if not hosts: 
        
                       return [{"address": "redis://localhost:6379"}] 
        
                   # If they provided just a string, scold them. 
        
                   if isinstance(hosts, (str, bytes)): 
        
                       raise ValueError( 
        
                           "You must pass a list of Redis hosts, even if there is only one." 
        
                       ) 
        
                   # Decode each hosts entry into a kwargs dict 
        
                   result = [] 
        
                   for entry in hosts: 
        
                       if isinstance(entry, dict): 
        
                           result.append(entry) 
        
                       elif isinstance(entry, tuple): 
        
                           result.append({"host": entry[0], "port": entry[1]}) 
        
                       else: 
        
                           result.append({"address": entry}) 
        
                   return result

The right way to address #334 would be to move that method out from RedisChannelLayer to utils module and to use it for both layers.

Anyway the docs for RedisChannelLayer should not be changed.

carltongibson · 2023-03-28T10:06:53Z

Resolved in #352

vanschelven added 2 commits October 21, 2022 13:12

Fix docs to reflect that tuples don't work

cde3939

Fixes django#334 A more thorough (and backward compatible) fix would be to actually make tuples work again.

Update README

ef4a9fb

The pointer to redis.connection.Connection was misleading, because in actualitly from_url is used: https://github.com/django/channels_redis/blob/95d87449c2b899c1cfdf8a10cfa1425e30127ef2/channels_redis/pubsub.py#L349

vanschelven changed the title ~~Fix docs to reflect that tuples don't work~~ Fix docs for "hosts" Oct 21, 2022

sevdog suggested changes Feb 24, 2023

View reviewed changes

sevdog mentioned this pull request Mar 6, 2023

Refactored Redis connection utilities to share between layers. #352

Merged

carltongibson closed this Mar 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix docs for "hosts" #335

Fix docs for "hosts" #335

vanschelven commented Oct 21, 2022

sevdog left a comment

carltongibson commented Mar 28, 2023

	def decode_hosts(self, hosts):
	"""
	Takes the value of the "hosts" argument passed to the class and returns
	a list of kwargs to use for the Redis connection constructor.
	"""
	# If no hosts were provided, return a default value
	if not hosts:
	return [{"address": "redis://localhost:6379"}]
	# If they provided just a string, scold them.
	if isinstance(hosts, (str, bytes)):
	raise ValueError(
	"You must pass a list of Redis hosts, even if there is only one."
	)

	# Decode each hosts entry into a kwargs dict
	result = []
	for entry in hosts:
	if isinstance(entry, dict):
	result.append(entry)
	elif isinstance(entry, tuple):
	result.append({"host": entry[0], "port": entry[1]})
	else:
	result.append({"address": entry})
	return result

Fix docs for "hosts" #335

Fix docs for "hosts" #335

Conversation

vanschelven commented Oct 21, 2022

sevdog left a comment

Choose a reason for hiding this comment

carltongibson commented Mar 28, 2023