Welcome to cache3’s documentation!

Cache3 is a MIT licensed safe and lightweight cache library, written in pure-Python.

Check out the usage section for further information, including how to install the project.

Note

This project is under active development.

Contents

• Overview
• Installation
• Quick start
  • set, get, delete(del), has_key(in)
  • ex_set
  • get_many
  • memoize
  • inspect
  • others
  • iterable
• memory-based cache
  • MiniCache
  • Cache
• disk-based cache
  • DiskCache
• API
  • MiniCache
    • MiniCache
      • MiniCache.__init__()
      • MiniCache.__repr__()
      • MiniCache.incr()
      • MiniCache.inspect()
      • MiniCache.memoize()
      • MiniCache.ttl()
  • Cache
    • Cache
      • Cache.__init__()
      • Cache.__repr__()
      • Cache.memoize()
  • DiskCache
    • DiskCache
      • DiskCache.__contains__()
      • DiskCache.__delitem__()
      • DiskCache.__getitem__()
      • DiskCache.__init__()
      • DiskCache.__iter__()
      • DiskCache.__repr__()
      • DiskCache.__setitem__()
      • DiskCache.clear()
      • DiskCache.delete()
      • DiskCache.ex_set()
      • DiskCache.get()
      • DiskCache.get_many()
      • DiskCache.has_key()
      • DiskCache.incr()
      • DiskCache.inspect()
      • DiskCache.items()
      • DiskCache.keys()
      • DiskCache.memoize()
      • DiskCache.pop()
      • DiskCache.set()
      • DiskCache.touch()
      • DiskCache.try_evict()
      • DiskCache.ttl()
      • DiskCache.values()

Feature

• Pure-Python

• Thread-safe and process-safe

• High performance

• 100% test coverage

• Extension friendly

• Supports multiple eviction policies and is easy to scale

• Supports multiple data types

• Compatible with all platforms

TODO

• Improve documentation

• Faster serialization protocol

Indices and tables

• Index

• Module Index

• Search Page