diff options
Diffstat (limited to 'django/core/cache')
| -rw-r--r-- | django/core/cache/__init__.py | 2 | ||||
| -rw-r--r-- | django/core/cache/backends/base.py | 54 | ||||
| -rw-r--r-- | django/core/cache/backends/filebased.py | 5 | ||||
| -rw-r--r-- | django/core/cache/backends/memcached.py | 2 |
4 files changed, 32 insertions, 31 deletions
diff --git a/django/core/cache/__init__.py b/django/core/cache/__init__.py index d51c1cb38e..7aaa057229 100644 --- a/django/core/cache/__init__.py +++ b/django/core/cache/__init__.py @@ -59,7 +59,7 @@ class CacheHandler: """ A Cache Handler to manage access to Cache instances. - Ensures only one instance of each alias exists per thread. + Ensure only one instance of each alias exists per thread. """ def __init__(self): self._caches = local() diff --git a/django/core/cache/backends/base.py b/django/core/cache/backends/base.py index 2d5b0634a1..b5661891d6 100644 --- a/django/core/cache/backends/base.py +++ b/django/core/cache/backends/base.py @@ -26,7 +26,7 @@ def default_key_func(key, key_prefix, version): """ Default function to generate keys. - Constructs the key used by all other methods. By default it prepends + Construct the key used by all other methods. By default, prepend the `key_prefix'. KEY_FUNCTION can be used to specify an alternate function with custom key making behavior. """ @@ -37,7 +37,7 @@ def get_key_func(key_func): """ Function to decide which key function to use. - Defaults to ``default_key_func``. + Default to ``default_key_func``. """ if key_func is not None: if callable(key_func): @@ -76,7 +76,7 @@ class BaseCache: def get_backend_timeout(self, timeout=DEFAULT_TIMEOUT): """ - Returns the timeout value usable by this backend based upon the provided + Return the timeout value usable by this backend based upon the provided timeout. """ if timeout == DEFAULT_TIMEOUT: @@ -87,12 +87,12 @@ class BaseCache: return None if timeout is None else time.time() + timeout def make_key(self, key, version=None): - """Constructs the key used by all other methods. By default it - uses the key_func to generate a key (which, by default, - prepends the `key_prefix' and 'version'). A different key - function can be provided at the time of cache construction; - alternatively, you can subclass the cache backend to provide - custom key making behavior. + """ + Construct the key used by all other methods. By default, use the + key_func to generate a key (which, by default, prepends the + `key_prefix' and 'version'). A different key function can be provided + at the time of cache construction; alternatively, you can subclass the + cache backend to provide custom key making behavior. """ if version is None: version = self.version @@ -103,10 +103,10 @@ class BaseCache: def add(self, key, value, timeout=DEFAULT_TIMEOUT, version=None): """ Set a value in the cache if the key does not already exist. If - timeout is given, that timeout will be used for the key; otherwise - the default cache timeout will be used. + timeout is given, use that timeout for the key; otherwise use the + default cache timeout. - Returns True if the value was stored, False otherwise. + Return True if the value was stored, False otherwise. """ raise NotImplementedError('subclasses of BaseCache must provide an add() method') @@ -119,8 +119,8 @@ class BaseCache: def set(self, key, value, timeout=DEFAULT_TIMEOUT, version=None): """ - Set a value in the cache. If timeout is given, that timeout will be - used for the key; otherwise the default cache timeout will be used. + Set a value in the cache. If timeout is given, use that timeout for the + key; otherwise use the default cache timeout. """ raise NotImplementedError('subclasses of BaseCache must provide a set() method') @@ -135,7 +135,7 @@ class BaseCache: Fetch a bunch of keys from the cache. For certain backends (memcached, pgsql) this can be *much* faster when fetching multiple values. - Returns a dict mapping each key in keys to its value. If the given + Return a dict mapping each key in keys to its value. If the given key is missing, it will be missing from the response dict. """ d = {} @@ -148,9 +148,9 @@ class BaseCache: def get_or_set(self, key, default, timeout=DEFAULT_TIMEOUT, version=None): """ Fetch a given key from the cache. If the key does not exist, - the key is added and set to the default value. The default value can - also be any callable. If timeout is given, that timeout will be used - for the key; otherwise the default cache timeout will be used. + add the key and set it to the default value. The default value can + also be any callable. If timeout is given, use that timeout for the + key; otherwise use the default cache timeout. Return the value of the key stored or retrieved. """ @@ -166,7 +166,7 @@ class BaseCache: def has_key(self, key, version=None): """ - Returns True if the key is in the cache and has not expired. + Return True if the key is in the cache and has not expired. """ return self.get(key, version=version) is not None @@ -191,7 +191,7 @@ class BaseCache: def __contains__(self, key): """ - Returns True if the key is in the cache and has not expired. + Return True if the key is in the cache and has not expired. """ # This is a separate method, rather than just a copy of has_key(), # so that it always has the same functionality as has_key(), even @@ -204,8 +204,8 @@ class BaseCache: pairs. For certain backends (memcached), 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 timeout is given, use that timeout for the key; otherwise use the + default cache timeout. """ for key, value in data.items(): self.set(key, value, timeout=timeout, version=version) @@ -243,8 +243,9 @@ class BaseCache: break def incr_version(self, key, delta=1, version=None): - """Adds delta to the cache version for the supplied key. Returns the - new version. + """ + Add delta to the cache version for the supplied key. Return the new + version. """ if version is None: version = self.version @@ -258,8 +259,9 @@ class BaseCache: return version + delta def decr_version(self, key, delta=1, version=None): - """Subtracts delta from the cache version for the supplied key. Returns - the new version. + """ + Subtract delta from the cache version for the supplied key. Return the + new version. """ return self.incr_version(key, -delta, version) diff --git a/django/core/cache/backends/filebased.py b/django/core/cache/backends/filebased.py index a381ebc265..56d2cf5b6d 100644 --- a/django/core/cache/backends/filebased.py +++ b/django/core/cache/backends/filebased.py @@ -75,7 +75,7 @@ class FileBasedCache(BaseCache): def _cull(self): """ - Removes random cache entries if max_entries is reached at a ratio + Remove random cache entries if max_entries is reached at a ratio of num_entries / cull_frequency. A value of 0 for CULL_FREQUENCY means that the entire cache will be purged. """ @@ -119,8 +119,7 @@ class FileBasedCache(BaseCache): def _is_expired(self, f): """ - Takes an open cache file and determines if it has expired, - deletes the file if it is has passed its expiry time. + Take an open cache file `f` and delete it if it's expired. """ exp = pickle.load(f) if exp is not None and exp < time.time(): diff --git a/django/core/cache/backends/memcached.py b/django/core/cache/backends/memcached.py index 8f87f487bf..6e8211bdff 100644 --- a/django/core/cache/backends/memcached.py +++ b/django/core/cache/backends/memcached.py @@ -30,7 +30,7 @@ class BaseMemcachedCache(BaseCache): @property def _cache(self): """ - Implements transparent thread-safe access to a memcached client. + Implement transparent thread-safe access to a memcached client. """ if getattr(self, '_client', None) is None: self._client = self._lib.Client(self._servers, **self._options) |