Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

cache.py 4.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. # -*- coding: utf-8 -*-
  2. """
  3. celery.backends.cache
  4. ~~~~~~~~~~~~~~~~~~~~~
  5. Memcache and in-memory cache result backend.
  6. """
  7. from __future__ import absolute_import
  8. import sys
  9. from kombu.utils import cached_property
  10. from kombu.utils.encoding import bytes_to_str, ensure_bytes
  11. from celery.exceptions import ImproperlyConfigured
  12. from celery.utils.functional import LRUCache
  13. from .base import KeyValueStoreBackend
  14. __all__ = ['CacheBackend']
  15. _imp = [None]
  16. PY3 = sys.version_info[0] == 3
  17. REQUIRES_BACKEND = """\
  18. The memcached backend requires either pylibmc or python-memcached.\
  19. """
  20. UNKNOWN_BACKEND = """\
  21. The cache backend {0!r} is unknown,
  22. Please use one of the following backends instead: {1}\
  23. """
  24. def import_best_memcache():
  25. if _imp[0] is None:
  26. is_pylibmc, memcache_key_t = False, ensure_bytes
  27. try:
  28. import pylibmc as memcache
  29. is_pylibmc = True
  30. except ImportError:
  31. try:
  32. import memcache # noqa
  33. except ImportError:
  34. raise ImproperlyConfigured(REQUIRES_BACKEND)
  35. if PY3:
  36. memcache_key_t = bytes_to_str
  37. _imp[0] = (is_pylibmc, memcache, memcache_key_t)
  38. return _imp[0]
  39. def get_best_memcache(*args, **kwargs):
  40. is_pylibmc, memcache, key_t = import_best_memcache()
  41. Client = _Client = memcache.Client
  42. if not is_pylibmc:
  43. def Client(*args, **kwargs): # noqa
  44. kwargs.pop('behaviors', None)
  45. return _Client(*args, **kwargs)
  46. return Client, key_t
  47. class DummyClient(object):
  48. def __init__(self, *args, **kwargs):
  49. self.cache = LRUCache(limit=5000)
  50. def get(self, key, *args, **kwargs):
  51. return self.cache.get(key)
  52. def get_multi(self, keys):
  53. cache = self.cache
  54. return dict((k, cache[k]) for k in keys if k in cache)
  55. def set(self, key, value, *args, **kwargs):
  56. self.cache[key] = value
  57. def delete(self, key, *args, **kwargs):
  58. self.cache.pop(key, None)
  59. def incr(self, key, delta=1):
  60. return self.cache.incr(key, delta)
  61. backends = {'memcache': get_best_memcache,
  62. 'memcached': get_best_memcache,
  63. 'pylibmc': get_best_memcache,
  64. 'memory': lambda: (DummyClient, ensure_bytes)}
  65. class CacheBackend(KeyValueStoreBackend):
  66. servers = None
  67. supports_autoexpire = True
  68. supports_native_join = True
  69. implements_incr = True
  70. def __init__(self, app, expires=None, backend=None,
  71. options={}, url=None, **kwargs):
  72. super(CacheBackend, self).__init__(app, **kwargs)
  73. self.url = url
  74. self.options = dict(self.app.conf.CELERY_CACHE_BACKEND_OPTIONS,
  75. **options)
  76. self.backend = url or backend or self.app.conf.CELERY_CACHE_BACKEND
  77. if self.backend:
  78. self.backend, _, servers = self.backend.partition('://')
  79. self.servers = servers.rstrip('/').split(';')
  80. self.expires = self.prepare_expires(expires, type=int)
  81. try:
  82. self.Client, self.key_t = backends[self.backend]()
  83. except KeyError:
  84. raise ImproperlyConfigured(UNKNOWN_BACKEND.format(
  85. self.backend, ', '.join(backends)))
  86. self._encode_prefixes() # rencode the keyprefixes
  87. def get(self, key):
  88. return self.client.get(key)
  89. def mget(self, keys):
  90. return self.client.get_multi(keys)
  91. def set(self, key, value):
  92. return self.client.set(key, value, self.expires)
  93. def delete(self, key):
  94. return self.client.delete(key)
  95. def _apply_chord_incr(self, header, partial_args, group_id, body, **opts):
  96. self.client.set(self.get_key_for_chord(group_id), 0, time=86400)
  97. return super(CacheBackend, self)._apply_chord_incr(
  98. header, partial_args, group_id, body, **opts
  99. )
  100. def incr(self, key):
  101. return self.client.incr(key)
  102. @cached_property
  103. def client(self):
  104. return self.Client(self.servers, **self.options)
  105. def __reduce__(self, args=(), kwargs={}):
  106. servers = ';'.join(self.servers)
  107. backend = '{0}://{1}/'.format(self.backend, servers)
  108. kwargs.update(
  109. dict(backend=backend,
  110. expires=self.expires,
  111. options=self.options))
  112. return super(CacheBackend, self).__reduce__(args, kwargs)
  113. def as_uri(self, *args, **kwargs):
  114. """Return the backend as an URI.
  115. This properly handles the case of multiple servers.
  116. """
  117. servers = ';'.join(self.servers)
  118. return '{0}://{1}/'.format(self.backend, servers)