Skip to main content

Disk and file backed cache.

Project description

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.

Project details


Release history Release notifications | RSS feed

This version

2.5.2

Download files

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

Source Distribution

diskcache-2.5.2.tar.gz (435.2 kB view details)

Uploaded Source

Built Distribution

diskcache-2.5.2-py2.py3-none-any.whl (31.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file diskcache-2.5.2.tar.gz.

File metadata

  • Download URL: diskcache-2.5.2.tar.gz
  • Upload date:
  • Size: 435.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for diskcache-2.5.2.tar.gz
Algorithm Hash digest
SHA256 30a903997100ad3f64d88a7b0c276ced712836861bdf1f777a73a8933e4b7a47
MD5 2e3842a5963d441fccbd7977ecf88ec7
BLAKE2b-256 5cecf8baa8e3f29394d825c7a7382821b7116d873f562c221850fa949f1c28ec

See more details on using hashes here.

File details

Details for the file diskcache-2.5.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for diskcache-2.5.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2b1c35541418ea6cfb87e98c52d452ad6df3ed80ae0968786571e2acc5f80a2e
MD5 ce39844630c3ce990452f0212cbbb339
BLAKE2b-256 e1deec30f2b349fa3dbd935c3df4f1b37db0b5d82954d24cd6f3e13503f1b0ae

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page