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 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
|
import random
import re
import socket
from collections import OrderedDict
from datetime import datetime
from typing import Any, Dict, Iterator, List, Optional, Union
from django.conf import settings
from django.core.cache.backends.base import DEFAULT_TIMEOUT, BaseCache, get_key_func
from django.core.exceptions import ImproperlyConfigured
from django.utils.module_loading import import_string
from redis import Redis
from redis.exceptions import ConnectionError, ResponseError, TimeoutError
from .. import pool
from ..exceptions import CompressorError, ConnectionInterrupted
from ..util import CacheKey
_main_exceptions = (TimeoutError, ResponseError, ConnectionError, socket.timeout)
special_re = re.compile("([*?[])")
def glob_escape(s: str) -> str:
return special_re.sub(r"[\1]", s)
class DefaultClient:
def __init__(self, server, params: Dict[str, Any], backend: BaseCache) -> None:
self._backend = backend
self._server = server
self._params = params
self.reverse_key = get_key_func(
params.get("REVERSE_KEY_FUNCTION")
or "django_redis.util.default_reverse_key"
)
if not self._server:
raise ImproperlyConfigured("Missing connections string")
if not isinstance(self._server, (list, tuple, set)):
self._server = self._server.split(",")
self._clients: List[Optional[Redis]] = [None] * len(self._server)
self._options = params.get("OPTIONS", {})
self._replica_read_only = self._options.get("REPLICA_READ_ONLY", True)
serializer_path = self._options.get(
"SERIALIZER", "django_redis.serializers.pickle.PickleSerializer"
)
serializer_cls = import_string(serializer_path)
compressor_path = self._options.get(
"COMPRESSOR", "django_redis.compressors.identity.IdentityCompressor"
)
compressor_cls = import_string(compressor_path)
self._serializer = serializer_cls(options=self._options)
self._compressor = compressor_cls(options=self._options)
self.connection_factory = pool.get_connection_factory(options=self._options)
def __contains__(self, key: Any) -> bool:
return self.has_key(key)
def get_next_client_index(
self, write: bool = True, tried: Optional[List[int]] = None
) -> int:
"""
Return a next index for read client. This function implements a default
behavior for get a next read client for a replication setup.
Overwrite this function if you want a specific
behavior.
"""
if tried is None:
tried = list()
if tried and len(tried) < len(self._server):
not_tried = [i for i in range(0, len(self._server)) if i not in tried]
return random.choice(not_tried)
if write or len(self._server) == 1:
return 0
return random.randint(1, len(self._server) - 1)
def get_client(
self,
write: bool = True,
tried: Optional[List[int]] = None,
show_index: bool = False,
):
"""
Method used for obtain a raw redis client.
This function is used by almost all cache backend
operations for obtain a native redis client/connection
instance.
"""
index = self.get_next_client_index(write=write, tried=tried)
if self._clients[index] is None:
self._clients[index] = self.connect(index)
if show_index:
return self._clients[index], index
else:
return self._clients[index]
def connect(self, index: int = 0) -> Redis:
"""
Given a connection index, returns a new raw redis client/connection
instance. Index is used for replication setups and indicates that
connection string should be used. In normal setups, index is 0.
"""
return self.connection_factory.connect(self._server[index])
def disconnect(self, index=0, client=None):
"""delegates the connection factory to disconnect the client"""
if not client:
client = self._clients[index]
return self.connection_factory.disconnect(client) if client else None
def set(
self,
key: Any,
value: Any,
timeout: Optional[float] = DEFAULT_TIMEOUT,
version: Optional[int] = None,
client: Optional[Redis] = None,
nx: bool = False,
xx: bool = False,
) -> bool:
"""
Persist a value to the cache, and set an optional expiration time.
Also supports optional nx parameter. If set to True - will use redis
setnx instead of set.
"""
nkey = self.make_key(key, version=version)
nvalue = self.encode(value)
if timeout is DEFAULT_TIMEOUT:
timeout = self._backend.default_timeout
original_client = client
tried: List[int] = []
while True:
try:
if client is None:
client, index = self.get_client(
write=True, tried=tried, show_index=True
)
if timeout is not None:
# Convert to milliseconds
timeout = int(timeout * 1000)
if timeout <= 0:
if nx:
# Using negative timeouts when nx is True should
# not expire (in our case delete) the value if it exists.
# Obviously expire not existent value is noop.
return not self.has_key(key, version=version, client=client)
else:
# redis doesn't support negative timeouts in ex flags
# so it seems that it's better to just delete the key
# than to set it and than expire in a pipeline
return bool(
self.delete(key, client=client, version=version)
)
return bool(client.set(nkey, nvalue, nx=nx, px=timeout, xx=xx))
except _main_exceptions as e:
if (
not original_client
and not self._replica_read_only
and len(tried) < len(self._server)
):
tried.append(index)
client = None
continue
raise ConnectionInterrupted(connection=client) from e
def incr_version(
self,
key: Any,
delta: int = 1,
version: Optional[int] = None,
client: Optional[Redis] = None,
) -> int:
"""
Adds delta to the cache version for the supplied key. Returns the
new version.
"""
if client is None:
client = self.get_client(write=True)
if version is None:
version = self._backend.version
old_key = self.make_key(key, version)
value = self.get(old_key, version=version, client=client)
try:
ttl = self.ttl(old_key, version=version, client=client)
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
if value is None:
raise ValueError("Key '%s' not found" % key)
if isinstance(key, CacheKey):
new_key = self.make_key(key.original_key(), version=version + delta)
else:
new_key = self.make_key(key, version=version + delta)
self.set(new_key, value, timeout=ttl, client=client)
self.delete(old_key, client=client)
return version + delta
def add(
self,
key: Any,
value: Any,
timeout: Any = DEFAULT_TIMEOUT,
version: Optional[Any] = None,
client: Optional[Redis] = None,
) -> bool:
"""
Add a value to the cache, failing if the key already exists.
Returns ``True`` if the object was added, ``False`` if not.
"""
return self.set(key, value, timeout, version=version, client=client, nx=True)
def get(
self,
key: Any,
default=None,
version: Optional[int] = None,
client: Optional[Redis] = None,
) -> Any:
"""
Retrieve a value from the cache.
Returns decoded value if key is found, the default if not.
"""
if client is None:
client = self.get_client(write=False)
key = self.make_key(key, version=version)
try:
value = client.get(key)
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
if value is None:
return default
return self.decode(value)
def persist(
self, key: Any, version: Optional[int] = None, client: Optional[Redis] = None
) -> bool:
if client is None:
client = self.get_client(write=True)
key = self.make_key(key, version=version)
return client.persist(key)
def expire(
self,
key: Any,
timeout,
version: Optional[int] = None,
client: Optional[Redis] = None,
) -> bool:
if client is None:
client = self.get_client(write=True)
key = self.make_key(key, version=version)
return client.expire(key, timeout)
def pexpire(self, key, timeout, version=None, client=None) -> bool:
if client is None:
client = self.get_client(write=True)
key = self.make_key(key, version=version)
# Temporary casting until https://github.com/redis/redis-py/issues/1664
# is fixed.
return bool(client.pexpire(key, timeout))
def pexpire_at(
self,
key: Any,
when: Union[datetime, int],
version: Optional[int] = None,
client: Optional[Redis] = None,
) -> bool:
"""
Set an expire flag on a ``key`` to ``when``, which can be represented
as an integer indicating unix time or a Python datetime object.
"""
if client is None:
client = self.get_client(write=True)
key = self.make_key(key, version=version)
return bool(client.pexpireat(key, when))
def expire_at(
self,
key: Any,
when: Union[datetime, int],
version: Optional[int] = None,
client: Optional[Redis] = None,
) -> bool:
"""
Set an expire flag on a ``key`` to ``when``, which can be represented
as an integer indicating unix time or a Python datetime object.
"""
if client is None:
client = self.get_client(write=True)
key = self.make_key(key, version=version)
return client.expireat(key, when)
def lock(
self,
key,
version: Optional[int] = None,
timeout=None,
sleep=0.1,
blocking_timeout=None,
client: Optional[Redis] = None,
thread_local=True,
):
if client is None:
client = self.get_client(write=True)
key = self.make_key(key, version=version)
return client.lock(
key,
timeout=timeout,
sleep=sleep,
blocking_timeout=blocking_timeout,
thread_local=thread_local,
)
def delete(
self,
key: Any,
version: Optional[int] = None,
prefix: Optional[str] = None,
client: Optional[Redis] = None,
) -> int:
"""
Remove a key from the cache.
"""
if client is None:
client = self.get_client(write=True)
try:
return client.delete(self.make_key(key, version=version, prefix=prefix))
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
def delete_pattern(
self,
pattern: str,
version: Optional[int] = None,
prefix: Optional[str] = None,
client: Optional[Redis] = None,
itersize: Optional[int] = None,
) -> int:
"""
Remove all keys matching pattern.
"""
if client is None:
client = self.get_client(write=True)
pattern = self.make_pattern(pattern, version=version, prefix=prefix)
try:
count = 0
pipeline = client.pipeline()
for key in client.scan_iter(match=pattern, count=itersize):
pipeline.delete(key)
count += 1
pipeline.execute()
return count
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
def delete_many(
self, keys, version: Optional[int] = None, client: Optional[Redis] = None
):
"""
Remove multiple keys at once.
"""
if client is None:
client = self.get_client(write=True)
keys = [self.make_key(k, version=version) for k in keys]
if not keys:
return
try:
return client.delete(*keys)
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
def clear(self, client: Optional[Redis] = None) -> None:
"""
Flush all cache keys.
"""
if client is None:
client = self.get_client(write=True)
try:
client.flushdb()
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
def decode(self, value: Union[bytes, int]) -> Any:
"""
Decode the given value.
"""
try:
value = int(value)
except (ValueError, TypeError):
try:
value = self._compressor.decompress(value)
except CompressorError:
# Handle little values, chosen to be not compressed
pass
value = self._serializer.loads(value)
return value
def encode(self, value: Any) -> Union[bytes, Any]:
"""
Encode the given value.
"""
if isinstance(value, bool) or not isinstance(value, int):
value = self._serializer.dumps(value)
value = self._compressor.compress(value)
return value
return value
def get_many(
self, keys, version: Optional[int] = None, client: Optional[Redis] = None
) -> OrderedDict:
"""
Retrieve many keys.
"""
if client is None:
client = self.get_client(write=False)
if not keys:
return OrderedDict()
recovered_data = OrderedDict()
map_keys = OrderedDict((self.make_key(k, version=version), k) for k in keys)
try:
results = client.mget(*map_keys)
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
for key, value in zip(map_keys, results):
if value is None:
continue
recovered_data[map_keys[key]] = self.decode(value)
return recovered_data
def set_many(
self,
data: Dict[Any, Any],
timeout: Optional[float] = DEFAULT_TIMEOUT,
version: Optional[int] = None,
client: Optional[Redis] = None,
) -> None:
"""
Set a bunch of values in the cache at once from a dict of key/value
pairs. This is much more efficient than calling set() multiple times.
If timeout is given, that timeout will be used for the key; otherwise
the default cache timeout will be used.
"""
if client is None:
client = self.get_client(write=True)
try:
pipeline = client.pipeline()
for key, value in data.items():
self.set(key, value, timeout, version=version, client=pipeline)
pipeline.execute()
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
def _incr(
self,
key: Any,
delta: int = 1,
version: Optional[int] = None,
client: Optional[Redis] = None,
ignore_key_check: bool = False,
) -> int:
if client is None:
client = self.get_client(write=True)
key = self.make_key(key, version=version)
try:
try:
# if key expired after exists check, then we get
# key with wrong value and ttl -1.
# use lua script for atomicity
if not ignore_key_check:
lua = """
local exists = redis.call('EXISTS', KEYS[1])
if (exists == 1) then
return redis.call('INCRBY', KEYS[1], ARGV[1])
else return false end
"""
else:
lua = """
return redis.call('INCRBY', KEYS[1], ARGV[1])
"""
value = client.eval(lua, 1, key, delta)
if value is None:
raise ValueError("Key '%s' not found" % key)
except ResponseError:
# if cached value or total value is greater than 64 bit signed
# integer.
# elif int is encoded. so redis sees the data as string.
# In this situations redis will throw ResponseError
# try to keep TTL of key
timeout = self.ttl(key, version=version, client=client)
# returns -2 if the key does not exist
# means, that key have expired
if timeout == -2:
raise ValueError("Key '%s' not found" % key)
value = self.get(key, version=version, client=client) + delta
self.set(key, value, version=version, timeout=timeout, client=client)
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
return value
def incr(
self,
key: Any,
delta: int = 1,
version: Optional[int] = None,
client: Optional[Redis] = None,
ignore_key_check: bool = False,
) -> int:
"""
Add delta to value in the cache. If the key does not exist, raise a
ValueError exception. if ignore_key_check=True then the key will be
created and set to the delta value by default.
"""
return self._incr(
key=key,
delta=delta,
version=version,
client=client,
ignore_key_check=ignore_key_check,
)
def decr(
self,
key: Any,
delta: int = 1,
version: Optional[int] = None,
client: Optional[Redis] = None,
) -> int:
"""
Decreace delta to value in the cache. If the key does not exist, raise a
ValueError exception.
"""
return self._incr(key=key, delta=-delta, version=version, client=client)
def ttl(
self, key: Any, version: Optional[int] = None, client: Optional[Redis] = None
) -> Optional[int]:
"""
Executes TTL redis command and return the "time-to-live" of specified key.
If key is a non volatile key, it returns None.
"""
if client is None:
client = self.get_client(write=False)
key = self.make_key(key, version=version)
if not client.exists(key):
return 0
t = client.ttl(key)
if t >= 0:
return t
elif t == -1:
return None
elif t == -2:
return 0
else:
# Should never reach here
return None
def pttl(self, key, version=None, client=None):
"""
Executes PTTL redis command and return the "time-to-live" of specified key.
If key is a non volatile key, it returns None.
"""
if client is None:
client = self.get_client(write=False)
key = self.make_key(key, version=version)
if not client.exists(key):
return 0
t = client.pttl(key)
if t >= 0:
return t
elif t == -1:
return None
elif t == -2:
return 0
else:
# Should never reach here
return None
def has_key(
self, key: Any, version: Optional[int] = None, client: Optional[Redis] = None
) -> bool:
"""
Test if key exists.
"""
if client is None:
client = self.get_client(write=False)
key = self.make_key(key, version=version)
try:
return client.exists(key) == 1
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
def iter_keys(
self,
search: str,
itersize: Optional[int] = None,
client: Optional[Redis] = None,
version: Optional[int] = None,
) -> Iterator[str]:
"""
Same as keys, but uses redis >= 2.8 cursors
for make memory efficient keys iteration.
"""
if client is None:
client = self.get_client(write=False)
pattern = self.make_pattern(search, version=version)
for item in client.scan_iter(match=pattern, count=itersize):
yield self.reverse_key(item.decode())
def keys(
self, search: str, version: Optional[int] = None, client: Optional[Redis] = None
) -> List[Any]:
"""
Execute KEYS command and return matched results.
Warning: this can return huge number of results, in
this case, it strongly recommended use iter_keys
for it.
"""
if client is None:
client = self.get_client(write=False)
pattern = self.make_pattern(search, version=version)
try:
return [self.reverse_key(k.decode()) for k in client.keys(pattern)]
except _main_exceptions as e:
raise ConnectionInterrupted(connection=client) from e
def make_key(
self, key: Any, version: Optional[Any] = None, prefix: Optional[str] = None
) -> CacheKey:
if isinstance(key, CacheKey):
return key
if prefix is None:
prefix = self._backend.key_prefix
if version is None:
version = self._backend.version
return CacheKey(self._backend.key_func(key, prefix, version))
def make_pattern(
self, pattern: str, version: Optional[int] = None, prefix: Optional[str] = None
) -> CacheKey:
if isinstance(pattern, CacheKey):
return pattern
if prefix is None:
prefix = self._backend.key_prefix
prefix = glob_escape(prefix)
if version is None:
version = self._backend.version
version_str = glob_escape(str(version))
return CacheKey(self._backend.key_func(pattern, prefix, version_str))
def close(self, **kwargs):
close_flag = self._options.get(
"CLOSE_CONNECTION",
getattr(settings, "DJANGO_REDIS_CLOSE_CONNECTION", False),
)
if close_flag:
self.do_close_clients()
def do_close_clients(self):
"""default implementation: Override in custom client"""
num_clients = len(self._clients)
for idx in range(num_clients):
self.disconnect(index=idx)
self._clients = [None] * num_clients
def touch(
self,
key: Any,
timeout: Optional[float] = DEFAULT_TIMEOUT,
version: Optional[int] = None,
client: Optional[Redis] = None,
) -> bool:
"""
Sets a new expiration for a key.
"""
if timeout is DEFAULT_TIMEOUT:
timeout = self._backend.default_timeout
if client is None:
client = self.get_client(write=True)
key = self.make_key(key, version=version)
if timeout is None:
return bool(client.persist(key))
else:
# Convert to milliseconds
timeout = int(timeout * 1000)
return bool(client.pexpire(key, timeout))
|