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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
|
import collections
import socket
import time
import logging
from pymemcache.client.base import (
Client,
PooledClient,
check_key_helper,
normalize_server_spec,
)
from pymemcache.client.rendezvous import RendezvousHash
from pymemcache.exceptions import MemcacheError
logger = logging.getLogger(__name__)
class HashClient:
"""
A client for communicating with a cluster of memcached servers
"""
#: :class:`Client` class used to create new clients
client_class = Client
def __init__(
self,
servers,
hasher=RendezvousHash,
serde=None,
serializer=None,
deserializer=None,
connect_timeout=None,
timeout=None,
no_delay=False,
socket_module=socket,
socket_keepalive=None,
key_prefix=b"",
max_pool_size=None,
pool_idle_timeout=0,
lock_generator=None,
retry_attempts=2,
retry_timeout=1,
dead_timeout=60,
use_pooling=False,
ignore_exc=False,
allow_unicode_keys=False,
default_noreply=True,
encoding="ascii",
tls_context=None,
):
"""
Constructor.
Args:
servers: list() of tuple(hostname, port) or string containing a UNIX
socket path.
hasher: optional class three functions ``get_node``, ``add_node``,
and ``remove_node``
defaults to Rendezvous (HRW) hash.
use_pooling: use py:class:`.PooledClient` as the default underlying
class. ``max_pool_size`` and ``lock_generator`` can
be used with this. default: False
retry_attempts: Amount of times a client should be tried before it
is marked dead and removed from the pool.
retry_timeout (float): Time in seconds that should pass between retry
attempts.
dead_timeout (float): Time in seconds before attempting to add a node
back in the pool.
encoding: optional str, controls data encoding (defaults to 'ascii').
Further arguments are interpreted as for :py:class:`.Client`
constructor.
"""
self.clients = {}
self.retry_attempts = retry_attempts
self.retry_timeout = retry_timeout
self.dead_timeout = dead_timeout
self.use_pooling = use_pooling
self.key_prefix = key_prefix
self.ignore_exc = ignore_exc
self.allow_unicode_keys = allow_unicode_keys
self._failed_clients = {}
self._dead_clients = {}
self._last_dead_check_time = time.time()
self.hasher = hasher()
self.default_kwargs = {
"connect_timeout": connect_timeout,
"timeout": timeout,
"no_delay": no_delay,
"socket_module": socket_module,
"socket_keepalive": socket_keepalive,
"key_prefix": key_prefix,
"serde": serde,
"serializer": serializer,
"deserializer": deserializer,
"allow_unicode_keys": allow_unicode_keys,
"default_noreply": default_noreply,
"encoding": encoding,
"tls_context": tls_context,
}
if use_pooling is True:
self.default_kwargs.update(
{
"max_pool_size": max_pool_size,
"pool_idle_timeout": pool_idle_timeout,
"lock_generator": lock_generator,
}
)
for server in servers:
self.add_server(normalize_server_spec(server))
self.encoding = encoding
self.tls_context = tls_context
def _make_client_key(self, server):
if isinstance(server, (list, tuple)) and len(server) == 2:
return "%s:%s" % server
return server
def add_server(self, server, port=None) -> None:
# To maintain backward compatibility, if a port is provided, assume
# that server wasn't provided as a (host, port) tuple.
if port is not None:
if not isinstance(server, str):
raise TypeError("Server must be a string when passing port.")
server = (server, port)
_class = PooledClient if self.use_pooling else self.client_class
client = _class(server, **self.default_kwargs)
if self.use_pooling:
client.client_class = self.client_class
key = self._make_client_key(server)
self.clients[key] = client
self.hasher.add_node(key)
def remove_server(self, server, port=None) -> None:
# To maintain backward compatibility, if a port is provided, assume
# that server wasn't provided as a (host, port) tuple.
if port is not None:
if not isinstance(server, str):
raise TypeError("Server must be a string when passing port.")
server = (server, port)
key = self._make_client_key(server)
dead_time = time.time()
self._failed_clients.pop(server)
self._dead_clients[server] = dead_time
self.hasher.remove_node(key)
def _retry_dead(self) -> None:
current_time = time.time()
ldc = self._last_dead_check_time
# We have reached the retry timeout
if current_time - ldc > self.dead_timeout:
candidates = []
for server, dead_time in self._dead_clients.items():
if current_time - dead_time > self.dead_timeout:
candidates.append(server)
for server in candidates:
logger.debug("bringing server back into rotation %s", server)
self.add_server(server)
del self._dead_clients[server]
self._last_dead_check_time = current_time
def _get_client(self, key):
check_key_helper(key, self.allow_unicode_keys, self.key_prefix)
if self._dead_clients:
self._retry_dead()
server = self.hasher.get_node(key)
# We've ran out of servers to try
if server is None:
if self.ignore_exc is True:
return
raise MemcacheError("All servers seem to be down right now")
return self.clients[server]
def _safely_run_func(self, client, func, default_val, *args, **kwargs):
try:
if client.server in self._failed_clients:
# This server is currently failing, lets check if it is in
# retry or marked as dead
failed_metadata = self._failed_clients[client.server]
# we haven't tried our max amount yet, if it has been enough
# time lets just retry using it
if failed_metadata["attempts"] < self.retry_attempts:
failed_time = failed_metadata["failed_time"]
if time.time() - failed_time > self.retry_timeout:
logger.debug("retrying failed server: %s", client.server)
result = func(*args, **kwargs)
# we were successful, lets remove it from the failed
# clients
self._failed_clients.pop(client.server)
return result
return default_val
else:
# We've reached our max retry attempts, we need to mark
# the sever as dead
logger.debug("marking server as dead: %s", client.server)
self.remove_server(client.server)
result = func(*args, **kwargs)
return result
# Connecting to the server fail, we should enter
# retry mode
except OSError:
self._mark_failed_server(client.server)
# if we haven't enabled ignore_exc, don't move on gracefully, just
# raise the exception
if not self.ignore_exc:
raise
return default_val
except Exception:
# any exceptions that aren't socket.error we need to handle
# gracefully as well
if not self.ignore_exc:
raise
return default_val
def _safely_run_set_many(self, client, values, *args, **kwargs):
failed = []
succeeded = []
try:
if client.server in self._failed_clients:
# This server is currently failing, lets check if it is in
# retry or marked as dead
failed_metadata = self._failed_clients[client.server]
# we haven't tried our max amount yet, if it has been enough
# time lets just retry using it
if failed_metadata["attempts"] < self.retry_attempts:
failed_time = failed_metadata["failed_time"]
if time.time() - failed_time > self.retry_timeout:
logger.debug("retrying failed server: %s", client.server)
succeeded, failed, err = self._set_many(
client, values, *args, **kwargs
)
if err is not None:
raise err
# we were successful, lets remove it from the failed
# clients
self._failed_clients.pop(client.server)
return failed
return values.keys()
else:
# We've reached our max retry attempts, we need to mark
# the sever as dead
logger.debug("marking server as dead: %s", client.server)
self.remove_server(client.server)
succeeded, failed, err = self._set_many(client, values, *args, **kwargs)
if err is not None:
raise err
return failed
# Connecting to the server fail, we should enter
# retry mode
except OSError:
self._mark_failed_server(client.server)
# if we haven't enabled ignore_exc, don't move on gracefully, just
# raise the exception
if not self.ignore_exc:
raise
return list(set(values.keys()) - set(succeeded))
except Exception:
# any exceptions that aren't socket.error we need to handle
# gracefully as well
if not self.ignore_exc:
raise
return list(set(values.keys()) - set(succeeded))
def _mark_failed_server(self, server):
# This client has never failed, lets mark it for failure
if server not in self._failed_clients and self.retry_attempts > 0:
self._failed_clients[server] = {
"failed_time": time.time(),
"attempts": 0,
}
# We aren't allowing any retries, we should mark the server as
# dead immediately
elif server not in self._failed_clients and self.retry_attempts <= 0:
self._failed_clients[server] = {
"failed_time": time.time(),
"attempts": 0,
}
logger.debug("marking server as dead %s", server)
self.remove_server(server)
# This client has failed previously, we need to update the metadata
# to reflect that we have attempted it again
else:
failed_metadata = self._failed_clients[server]
failed_metadata["attempts"] += 1
failed_metadata["failed_time"] = time.time()
self._failed_clients[server] = failed_metadata
def _run_cmd(self, cmd, key, default_val, *args, **kwargs):
client = self._get_client(key)
if client is None:
return default_val
func = getattr(client, cmd)
args = list(args)
args.insert(0, key)
return self._safely_run_func(client, func, default_val, *args, **kwargs)
def _set_many(self, client, values, *args, **kwargs):
failed = []
succeeded = []
try:
failed = client.set_many(values, *args, **kwargs)
except Exception as e:
if not self.ignore_exc:
return succeeded, failed, e
succeeded = [key for key in values if key not in failed]
return succeeded, failed, None
def close(self):
for client in self.clients.values():
self._safely_run_func(client, client.close, False)
disconnect_all = close
def set(self, key, *args, **kwargs):
return self._run_cmd("set", key, False, *args, **kwargs)
def get(self, key, default=None, **kwargs):
return self._run_cmd("get", key, default, default=default, **kwargs)
def incr(self, key, *args, **kwargs):
return self._run_cmd("incr", key, False, *args, **kwargs)
def decr(self, key, *args, **kwargs):
return self._run_cmd("decr", key, False, *args, **kwargs)
def set_many(self, values, *args, **kwargs):
client_batches = collections.defaultdict(dict)
failed = []
for key, value in values.items():
client = self._get_client(key)
if client is None:
failed.append(key)
continue
client_batches[client.server][key] = value
for server, values in client_batches.items():
client = self.clients[self._make_client_key(server)]
failed += self._safely_run_set_many(client, values, *args, **kwargs)
return failed
set_multi = set_many
def get_many(self, keys, gets=False, *args, **kwargs):
client_batches = collections.defaultdict(list)
end = {}
for key in keys:
client = self._get_client(key)
if client is None:
continue
client_batches[client.server].append(key)
for server, keys in client_batches.items():
client = self.clients[self._make_client_key(server)]
new_args = list(args)
new_args.insert(0, keys)
if gets:
get_func = client.gets_many
else:
get_func = client.get_many
result = self._safely_run_func(client, get_func, {}, *new_args, **kwargs)
end.update(result)
return end
get_multi = get_many
def gets(self, key, *args, **kwargs):
return self._run_cmd("gets", key, None, *args, **kwargs)
def gets_many(self, keys, *args, **kwargs):
return self.get_many(keys, gets=True, *args, **kwargs)
gets_multi = gets_many
def add(self, key, *args, **kwargs):
return self._run_cmd("add", key, False, *args, **kwargs)
def prepend(self, key, *args, **kwargs):
return self._run_cmd("prepend", key, False, *args, **kwargs)
def append(self, key, *args, **kwargs):
return self._run_cmd("append", key, False, *args, **kwargs)
def delete(self, key, *args, **kwargs):
return self._run_cmd("delete", key, False, *args, **kwargs)
def delete_many(self, keys, *args, **kwargs) -> bool:
for key in keys:
self._run_cmd("delete", key, False, *args, **kwargs)
return True
delete_multi = delete_many
def cas(self, key, *args, **kwargs):
return self._run_cmd("cas", key, False, *args, **kwargs)
def replace(self, key, *args, **kwargs):
return self._run_cmd("replace", key, False, *args, **kwargs)
def touch(self, key, *args, **kwargs):
return self._run_cmd("touch", key, False, *args, **kwargs)
def flush_all(self, *args, **kwargs) -> None:
for client in self.clients.values():
self._safely_run_func(client, client.flush_all, False, *args, **kwargs)
def quit(self) -> None:
for client in self.clients.values():
self._safely_run_func(client, client.quit, False)
|