Welcome to aiocache’s documentation!

Installing

  • pip install aiocache

  • pip install aiocache[redis]

  • pip install aiocache[memcached]

  • pip install aiocache[redis,memcached]

Usage

Using a cache is as simple as

>>> import asyncio
>>> from aiocache import SimpleMemoryCache
>>> cache = SimpleMemoryCache()
>>> with asyncio.Runner() as runner:
>>>     runner.run(cache.set("key", "value"))
True
>>>     runner.run(cache.get("key"))
'value'

Here we are using the SimpleMemoryCache but you can use any other supported backends as listed in Caches. All caches contain the same minimum interface which consists of the following functions:

  • add: Only adds key/value if key does not exist. Otherwise raises ValueError.

  • get: Retrieve value identified by key.

  • set: Sets key/value.

  • multi_get: Retrieves multiple key/values.

  • multi_set: Sets multiple key/values.

  • exists: Returns True if key exists False otherwise.

  • increment: Increment the value stored in the given key.

  • delete: Deletes key and returns number of deleted items.

  • clear: Clears the items stored.

  • raw: Executes the specified command using the underlying client.

See the examples folder for different use cases:

Contents

Indices and tables