Skip to main content

Paginator that caches pages automatically.

Project description


# About

A paginator that caches pages and result count. Very handy when you need to paginate an expensive query

This application was inspired by

## Changelog

* 0.0.4: Adds support for jinja. You should call the paginate function instad of using it as a tag

Build Status

[![Build Status](](

## Usage

### View

In your view:

from django_cachedpaginator import Paginator, PageNotAnInteger, EmptyPage

def my_view(request):
cache_key = 'user_your_own_key'
cache_timeout = 600 # 10 minutes
count_timeout = 3600
page = request.GET.get('page')

object_list = ExpensiveModel.objects.all()
paginator = Paginator(object_list, 20, cache_key, cache_timeout, count_timeout)

object_list =
except PageNotAnInteger:
object_list =
except EmptyPage:
object_list =

Or in you CBV view:

from django_cachedpaginator import CachedPaginatorViewMixin

class MyView(CachedPaginatorViewMixin, ListView):

paginate_by = 7
cache_timeout = 60
cache_key = "my_view"

And it will automatically caches the pagination.

## Templates

IMPORTANT: Make sure you add 'django_cachedpaginator' to your INSTALLLED_APPS settings, otherwide django cannot load the tag
All you need to do is to load the tags and pass your object_list to paginator tag like so:

In django templates:

{% load cached_paginator %}


{% paginate object_list %}

In jinja2 templates:


{{ paginate(object_list) }}

If you want to override the template that is used to render the paginator, you have a couple of options:
* Either create a file in your template folder (the one you've set in your settings file) by this name: django_cachedpaginator/paginator_template.html
* or set this variable in your settings file: PAGINATOR_TEMPLATE = 'path/to/your/template'

# Settings

You can set any of these in your settings file if you needed to:


default: 10


default: 'django_cachedpaginator/paginator_template.html'


default: 'paginator_page'
purpose: element's id prefix in your output


default: 'first'
purpose: element's class in your output


default: 'First'
purpose: String to show.


default: 'previous'


default: 'Previous'


default: 'next'


default: 'Next'


default: 'last'


default: 'Last'


default: 'page'
purpose: name of the parameter in your query string

# Notes

cache_timeout nad count_timeout are measured in seconds and are optional. Defaults are 300 and 600.

There is no need to add the page in cache_key because Paginator takes care of it. Actually here is a list of variables added to key:

* cache_key
* per_page
* page_number
* cache_timeout
* count_timeout

Therefore when you change any of these, your previous cache expires.

Project details

Release history Release notifications

This version
History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-cachedpaginator-0.0.5.tar.gz (7.7 kB) Copy SHA256 hash SHA256 Source None Mar 27, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page