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 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

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.3.1.tar.gz (426.7 kB view details)

Uploaded Source

Built Distribution

diskcache-2.3.1-py2.py3-none-any.whl (23.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for diskcache-2.3.1.tar.gz
Algorithm Hash digest
SHA256 818ca0b91eda6c4daa73907632babf0a43b9a6ac469568357034cb052f19b7e5
MD5 896cd968d30dd6125c5e2b831105263b
BLAKE2b-256 fa0b7cd1596e97108dce02f321d8901386e5c289e83e30d3027d04bde691df76

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for diskcache-2.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 42a8974f07538826434a337d01be7d2e7d7059bdf8a5569e7f0a106db44d79e3
MD5 b7b29c71cd7a0f66a958ad3bb12b0150
BLAKE2b-256 c616f660db38ee7a32095398a73761f24e35b25afa8f676e263497acafd30437

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