Skip to main content

DiskCache is an Apache2 licensed disk and file backed cache library, written in pure-Python, and compatible with Django.

The cloud-based computing of 2016 puts a premium on memory. Gigabytes of empty space is left on disks as processes vie for memory. Among these processes is Memcached (and sometimes Redis) which is used as a cache. Wouldn’t it be nice to leverage empty disk space for caching?

Django is Python’s most popular web framework and ships with several caching backends. Unfortunately the file-based cache in Django is essentially broken. The culling method is random and large caches repeatedly scan a cache directory which slows linearly with growth. Can you really allow it to take sixty milliseconds to store a key in a cache with a thousand items?

In Python, we can do better. And we can do it in pure-Python!

In [1]: import pylibmc
In [2]: client = pylibmc.Client(['127.0.0.1'], binary=True)
In [3]: client[b'key'] = b'value'
In [4]: %timeit client[b'key']

10000 loops, best of 3: 25.4 µs per loop

In [5]: import diskcache as dc
In [6]: cache = dc.Cache('tmp')
In [7]: cache[b'key'] = b'value'
In [8]: %timeit cache[b'key']

100000 loops, best of 3: 11.8 µs per loop

Note: Micro-benchmarks have their place but are not a substitute for real measurements. DiskCache offers cache benchmarks to defend its performance claims. Micro-optimizations are avoided but your mileage may vary.

DiskCache efficiently makes gigabytes of storage space available for caching. By leveraging rock-solid database libraries and memory-mapped files, cache performance can match and exceed industry-standard solutions. There’s no need for a C compiler or running another process. Performance is a feature and testing has 100% coverage with unit tests and hours of stress.

Testimonials

Does your company or website use DiskCache? Send us a message and let us know.

Features

  • Pure-Python

  • Fully Documented

  • Benchmark comparisons (alternatives, Django cache backends)

  • 100% test coverage

  • Hours of stress testing

  • Performance matters

  • Django compatible API

  • Thread-safe and process-safe

  • Supports multiple eviction policies (LRU and LFU included)

  • Keys support “tag” metadata and eviction

  • Developed on Python 2.7

  • Tested on CPython 2.7, 3.4, 3.5, 3.6 and PyPy

  • Tested on Linux, Mac OS X, and Windows

  • Tested using Travis CI and AppVeyor CI

https://api.travis-ci.org/grantjenks/python-diskcache.svg?branch=master https://ci.appveyor.com/api/projects/status/github/grantjenks/python-diskcache?branch=master&svg=true

Quickstart

Installing DiskCache is simple with pip:

$ pip install diskcache

You can access documentation in the interpreter with Python’s built-in help function:

>>> from diskcache import Cache, FanoutCache, DjangoCache
>>> help(Cache)
>>> help(FanoutCache)
>>> help(DjangoCache)

User Guide

For those wanting more details, this part of the documentation describes introduction, benchmarks, development, and API.

Reference and Indices

DiskCache License

Copyright 2016 Grant Jenks

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Release files for diskcache 2.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for diskcache 2.7.0
File Size Uploaded
diskcache-2.7.0.tar.gz 436.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for diskcache 2.7.0
File Interpreter ABI Platform
diskcache-2.7.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 469.2 kB

Release files / diskcache-2.7.0.tar.gz

Download URL diskcache-2.7.0.tar.gz
Size 436.7 kB
Tags Source
SHA-256 checksum
How to use checksums
85e10031899b5a6bb83bb31f56dfc95d25a2ae7ed11b660e465171094f204404
BLAKE2b-256 checksum
How to use checksums
3437d45b4e2d73bb43ba03c2312c61786044c4a01d0998d43f9867f714eb677c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / diskcache-2.7.0-py2.py3-none-any.whl

Download URL diskcache-2.7.0-py2.py3-none-any.whl
Size 32.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
30762573f45367b5b1f1168efee9d60a9f1eec2c0cf8600e12884f3097b799d3
BLAKE2b-256 checksum
How to use checksums
14ba1313028c065f9ed20cc67cb7043bd098521a28f0878ba1ae6035b28241a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

5.6.3

2 release files

5.6.1

2 release files

5.6.0

2 release files

5.5.1

2 release files

5.4.0

2 release files

5.3.0

2 release files

5.2.1

2 release files

5.1.0

2 release files

5.0.3

2 release files

5.0.2

2 release files

5.0.1

2 release files

5.0.0

2 release files

4.1.0

2 release files

4.0.0

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.6

2 release files

3.0.5

2 release files

3.0.4

2 release files

3.0.3

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.9.0

2 release files

2.8.3

2 release files

2.8.2

2 release files

This release

2.7.0 This release

2 release files

2.6.5

2 release files

2.6.4

2 release files

2.6.0

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.2

2 release files

1.7.0

2 release files

1.6.7

2 release files

1.6.6

2 release files

1.6.5

2 release files

1.6.4

2 release files

1.6.3

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.5

2 release files

1.3.4

2 release files

1.3.3

2 release files

1.3.1

1 release file

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.9.0

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

1 release file

0.2.10

1 release file

0.2.9

1 release file

0.2.8

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page