1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
80
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
from typing import Dict
from urllib.parse import parse_qs, urlparse
from django.conf import settings
from django.core.exceptions import ImproperlyConfigured
from django.utils.module_loading import import_string
from redis import Redis
from redis.connection import DefaultParser, to_bool
from redis.sentinel import Sentinel
class ConnectionFactory:
# Store connection pool by cache backend options.
#
# _pools is a process-global, as otherwise _pools is cleared every time
# ConnectionFactory is instantiated, as Django creates new cache client
# (DefaultClient) instance for every request.
_pools: Dict[str, Redis] = {}
def __init__(self, options):
pool_cls_path = options.get(
"CONNECTION_POOL_CLASS", "redis.connection.ConnectionPool"
)
self.pool_cls = import_string(pool_cls_path)
self.pool_cls_kwargs = options.get("CONNECTION_POOL_KWARGS", {})
redis_client_cls_path = options.get("REDIS_CLIENT_CLASS", "redis.client.Redis")
self.redis_client_cls = import_string(redis_client_cls_path)
self.redis_client_cls_kwargs = options.get("REDIS_CLIENT_KWARGS", {})
self.options = options
def make_connection_params(self, url):
"""
Given a main connection parameters, build a complete
dict of connection parameters.
"""
kwargs = {
"url": url,
"parser_class": self.get_parser_cls(),
}
password = self.options.get("PASSWORD", None)
if password:
kwargs["password"] = password
socket_timeout = self.options.get("SOCKET_TIMEOUT", None)
if socket_timeout:
assert isinstance(
socket_timeout, (int, float)
), "Socket timeout should be float or integer"
kwargs["socket_timeout"] = socket_timeout
socket_connect_timeout = self.options.get("SOCKET_CONNECT_TIMEOUT", None)
if socket_connect_timeout:
assert isinstance(
socket_connect_timeout, (int, float)
), "Socket connect timeout should be float or integer"
kwargs["socket_connect_timeout"] = socket_connect_timeout
return kwargs
def connect(self, url: str) -> Redis:
"""
Given a basic connection parameters,
return a new connection.
"""
params = self.make_connection_params(url)
connection = self.get_connection(params)
return connection
def disconnect(self, connection):
"""
Given a not null client connection it disconnect from the Redis server.
The default implementation uses a pool to hold connections.
"""
connection.connection_pool.disconnect()
def get_connection(self, params):
"""
Given a now preformatted params, return a
new connection.
The default implementation uses a cached pools
for create new connection.
"""
pool = self.get_or_create_connection_pool(params)
return self.redis_client_cls(
connection_pool=pool, **self.redis_client_cls_kwargs
)
def get_parser_cls(self):
cls = self.options.get("PARSER_CLASS", None)
if cls is None:
return DefaultParser
return import_string(cls)
def get_or_create_connection_pool(self, params):
"""
Given a connection parameters and return a new
or cached connection pool for them.
Reimplement this method if you want distinct
connection pool instance caching behavior.
"""
key = params["url"]
if key not in self._pools:
self._pools[key] = self.get_connection_pool(params)
return self._pools[key]
def get_connection_pool(self, params):
"""
Given a connection parameters, return a new
connection pool for them.
Overwrite this method if you want a custom
behavior on creating connection pool.
"""
cp_params = dict(params)
cp_params.update(self.pool_cls_kwargs)
pool = self.pool_cls.from_url(**cp_params)
if pool.connection_kwargs.get("password", None) is None:
pool.connection_kwargs["password"] = params.get("password", None)
pool.reset()
return pool
class SentinelConnectionFactory(ConnectionFactory):
def __init__(self, options):
# allow overriding the default SentinelConnectionPool class
options.setdefault(
"CONNECTION_POOL_CLASS", "redis.sentinel.SentinelConnectionPool"
)
super().__init__(options)
sentinels = options.get("SENTINELS")
if not sentinels:
raise ImproperlyConfigured(
"SENTINELS must be provided as a list of (host, port)."
)
# provide the connection pool kwargs to the sentinel in case it
# needs to use the socket options for the sentinels themselves
connection_kwargs = self.make_connection_params(None)
connection_kwargs.pop("url")
connection_kwargs.update(self.pool_cls_kwargs)
self._sentinel = Sentinel(
sentinels,
sentinel_kwargs=options.get("SENTINEL_KWARGS"),
**connection_kwargs,
)
def get_connection_pool(self, params):
"""
Given a connection parameters, return a new sentinel connection pool
for them.
"""
url = urlparse(params["url"])
# explicitly set service_name and sentinel_manager for the
# SentinelConnectionPool constructor since will be called by from_url
cp_params = dict(params)
cp_params.update(service_name=url.hostname, sentinel_manager=self._sentinel)
pool = super().get_connection_pool(cp_params)
# convert "is_master" to a boolean if set on the URL, otherwise if not
# provided it defaults to True.
is_master = parse_qs(url.query).get("is_master")
if is_master:
pool.is_master = to_bool(is_master[0])
return pool
def get_connection_factory(path=None, options=None):
if path is None:
path = getattr(
settings,
"DJANGO_REDIS_CONNECTION_FACTORY",
"django_redis.pool.ConnectionFactory",
)
opt_conn_factory = options.get("CONNECTION_FACTORY")
if opt_conn_factory:
path = opt_conn_factory
cls = import_string(path)
return cls(options or {})
|
