shuup.core.cache package

Submodules

shuup.core.cache.impl module

shuup.core.cache.impl.get_cache_duration(cache_key)

Determine a cache duration for the given cache key.

Parameters:

cache_key (str) – Cache key string

Returns:

Timeout seconds

Return type:

int

class shuup.core.cache.impl.VersionedCache(using)

Bases: object

Parameters:

using (str) – Cache alias

__init__(using)

Parameters:

using (str) – Cache alias

bump_version(cache_key)

Bump up the cache version for the given cache key/namespace.

Parameters:

cache_key (str) – Cache key or namespace

get_version(cache_key)

Get the cache version (or None) for the given cache key/namespace.

The cache version is stored in thread-local storage for the current request, so unless bumped in-request, all gets within a single request should get coherently versioned data from the cache.

Parameters:

cache_key (str) – Cache key or namespace

Returns:

Version ID or none

Return type:

str|None

set(key, value, timeout=None, version=None)

Set the value for key key in the cache.

Unlike django.core.caches[using].set(), this also derives timeout and versioning information from the key (and cached version data) if the key begins with a colon-separated namespace, such as foo:bar.

Parameters:

• key (str) – Cache key

• value (object) – Value to cache

• timeout (int|None) – Timeout seconds or None (for auto-determination)

• version (str|None) – Version string or None (for auto-determination)

• using (str) – Cache alias

get(key, version=None, default=None)

Get the value for key key in the cache.

Unlike django.core.caches[using].get(), versioning information can be auto-derived from the key (and cached version data) if the key begins with a colon-separated namespace, such as foo:bar.

Parameters:

• key (str) – Cache key

• version (str|None) – Version string or None (for auto-determination)

• default (object) – Default value, if the key is not found

• using (str) – Cache alias

Returns:

cached value

Return type:

object

clear()

Module contents

Utilities for versioned caching and automatic timeout determination.

Versioning works by way of namespaces. Namespaces are the first colon-separated part of cache keys.

For instance, the cache keys price:10, price:20, and price all belong to the price namespace and can be invalidated with one bump_version("price") call.

The versions themselves are stored within the cache, within the _version namespace. (As an implementation detail, this allows one to invalidate _all_ versioned keys by bumping the version of _version. Very meta!)

shuup.core.cache.bump_version(cache_key)

Bump up the cache version for the given cache key/namespace.

Parameters:

cache_key (str) – Cache key or namespace

shuup.core.cache.clear()

shuup.core.cache.get(key, version=None, default=None)

Get the value for key key in the cache.

Unlike django.core.caches[using].get(), versioning information can be auto-derived from the key (and cached version data) if the key begins with a colon-separated namespace, such as foo:bar.

Parameters:

• key (str) – Cache key

• version (str|None) – Version string or None (for auto-determination)

• default (object) – Default value, if the key is not found

• using (str) – Cache alias

Returns:

cached value

Return type:

object

shuup.core.cache.set(key, value, timeout=None, version=None)

Set the value for key key in the cache.

Unlike django.core.caches[using].set(), this also derives timeout and versioning information from the key (and cached version data) if the key begins with a colon-separated namespace, such as foo:bar.

Parameters:

• key (str) – Cache key

• value (object) – Value to cache

• timeout (int|None) – Timeout seconds or None (for auto-determination)

• version (str|None) – Version string or None (for auto-determination)

• using (str) – Cache alias

class shuup.core.cache.VersionedCache(using)

Bases: object

Parameters:

using (str) – Cache alias

__init__(using)

Parameters:

using (str) – Cache alias

bump_version(cache_key)

Bump up the cache version for the given cache key/namespace.

Parameters:

cache_key (str) – Cache key or namespace

clear()

get(key, version=None, default=None)

Get the value for key key in the cache.

Unlike django.core.caches[using].get(), versioning information can be auto-derived from the key (and cached version data) if the key begins with a colon-separated namespace, such as foo:bar.

Parameters:

• key (str) – Cache key

• version (str|None) – Version string or None (for auto-determination)

• default (object) – Default value, if the key is not found

• using (str) – Cache alias

Returns:

cached value

Return type:

object

get_version(cache_key)

Get the cache version (or None) for the given cache key/namespace.

The cache version is stored in thread-local storage for the current request, so unless bumped in-request, all gets within a single request should get coherently versioned data from the cache.

Parameters:

cache_key (str) – Cache key or namespace

Returns:

Version ID or none

Return type:

str|None

set(key, value, timeout=None, version=None)

Set the value for key key in the cache.

Unlike django.core.caches[using].set(), this also derives timeout and versioning information from the key (and cached version data) if the key begins with a colon-separated namespace, such as foo:bar.

Parameters:

• key (str) – Cache key

• value (object) – Value to cache

• timeout (int|None) – Timeout seconds or None (for auto-determination)

• version (str|None) – Version string or None (for auto-determination)

• using (str) – Cache alias