Introduction - Collab Docs

Improved Caching

Collab uses the django-cache-tools package to improve Django's basic caching.

You can find the full documentation for django cache tools here: http://django-cache-tools.readthedocs.org/en/latest/

The basic tools django-cache-tools provides are:

Here are some basic examples:

Keyable model lets you cache blocks using a caching key to leverage memcached's LRU algorithm.

First, make a model that inherits from KeyableModel:

from cache_tools.models import KeyableModel
# ...
class Profile(KeyableModel):
# Your model stuff

Then, pass the cache key to the cache template tag:

{% load cache %}
{% cache 86400 cache_tools profile.cache_key %}
    <p>
        Lots of very time consuming code.
    </p>
{% endcache %}

To cache a page in a group, you just use the cache_page_in_group decorator:

#views.py
from cache_tools.tools import cache_page_in_group

@cache_page_in_group('profiles')
def show(req, slug):
# ...

Or, to cache directly in a template:

# cacheable.html

{% get_group_key group_name as group_key %}

{% cache 600 page_title group_key %}
<!-- Long running code -->
{% endcache %}

To expire the group:

from cache_tools.tools import expire_cache_group
# ...
expire_cache_group('profiles')

If you have a view like:

#views.py
@cache_page(60 * 10)
def show(req, slug):
# ...

#urls.py
# ...
url(r'^profile/(?P<stub>.*)/$', 'show', name='show_profile'),
# ...

Then you can use expire_page like:

from cache_tools.tools import expire_page
# ...
expire_page(reverse('show_profile', args=(stub,)))