python-diskcache API reference

50 public APIs from python-diskcache (grantjenks/python-diskcache) — 12 classes, 0 functions, 38 methods. Signatures extracted by static analysis of the actual source.

Repository: grantjenks/python-diskcache

Kind	Count
Classes	12
Functions	0
Methods	38

API list

classdiskcache.core.Cache

Disk and file backed cache.

methoddiskcache.core.Cache.clear(retry=False)

Remove all items from cache.

methoddiskcache.core.Cache.close()

Close database connection.

methoddiskcache.core.Cache.create_tag_index()

Create tag index on cache database.

methoddiskcache.core.Cache.directory()

Cache directory.

methoddiskcache.core.Cache.disk()

Disk used for serialization.

methoddiskcache.core.Cache.drop_tag_index()

Drop tag index on cache database.

methoddiskcache.core.Cache.expire(now=None, retry=False)

Remove expired items from cache.

methoddiskcache.core.Cache.memoize(name=None, typed=False, expire=None, tag=None, ignore=())

Memoizing cache decorator.

methoddiskcache.core.Cache.set(key, value, expire=None, read=False, tag=None, retry=False)

Set `key` and `value` item in cache.

classdiskcache.core.Constant

Pretty display of immutable constant.

methoddiskcache.core.Disk.hash(key)

Compute portable hash for `key`.

methoddiskcache.core.Disk.put(key)

Convert `key` to fields key and raw for Cache table.

methoddiskcache.core.Disk.remove(file_path)

Remove a file given by `file_path`.

classdiskcache.core.EmptyDirWarning

Warning used by Cache.check for empty directories.

classdiskcache.core.Timeout

Database timeout expired.

classdiskcache.core.UnknownFileWarning

Warning used by Cache.check for unknown files.

classdiskcache.djangocache.DjangoCache

Django-compatible disk and file backed cache.

methoddiskcache.djangocache.DjangoCache.close(**kwargs)

Close the cache connection.

methoddiskcache.djangocache.DjangoCache.directory()

Cache directory.

methoddiskcache.djangocache.DjangoCache.expire()

Remove expired items from cache.

classdiskcache.fanout.FanoutCache

Cache that shards keys and values.

methoddiskcache.fanout.FanoutCache.clear(retry=False)

Remove all items from cache.

methoddiskcache.fanout.FanoutCache.close()

Close database connection.

methoddiskcache.fanout.FanoutCache.directory()

Cache directory.

methoddiskcache.fanout.FanoutCache.drop_tag_index()

Drop tag index on cache database.

methoddiskcache.fanout.FanoutCache.expire(retry=False)

Remove expired items from cache.

classdiskcache.persistent.Deque

Persistent sequence with double-ended queue semantics.

methoddiskcache.persistent.Deque.append(value)

Add `value` to back of deque.

methoddiskcache.persistent.Deque.appendleft(value)

Add `value` to front of deque.

methoddiskcache.persistent.Deque.cache()

Cache used by deque.

methoddiskcache.persistent.Deque.clear()

Remove all elements from deque.

methoddiskcache.persistent.Deque.maxlen()

Max length of the deque.

methoddiskcache.persistent.Deque.peek()

Peek at value at back of deque.

methoddiskcache.persistent.Deque.peekleft()

Peek at value at front of deque.

methoddiskcache.persistent.Deque.reverse()

Reverse deque in place.

methoddiskcache.persistent.Deque.rotate(steps=1)

Rotate deque right by `steps`.

classdiskcache.persistent.Index

Persistent mutable mapping with insertion order iteration.

methoddiskcache.persistent.Index.cache()

Cache used by index.

methoddiskcache.persistent.Index.clear()

Remove all items from index.

methoddiskcache.persistent.Index.memoize(name=None, typed=False, ignore=())

Memoizing cache decorator.

methoddiskcache.persistent.Index.popitem(last=True)

Remove and return item pair.

classdiskcache.recipes.Averager

Recipe for calculating a running average.

methoddiskcache.recipes.Averager.add(value)

Add `value` to average.

classdiskcache.recipes.Lock

Recipe for cross-process and cross-thread lock.

methoddiskcache.recipes.Lock.acquire()

Acquire lock using spin-lock algorithm.

methoddiskcache.recipes.Lock.locked()

Return true if the lock is acquired.

methoddiskcache.recipes.Lock.release()

Release lock by deleting key.

classdiskcache.recipes.RLock

Recipe for cross-process and cross-thread re-entrant lock.

methoddiskcache.recipes.RLock.release()

Release lock by decrementing count.

About this data

These signatures were extracted from the public source of grantjenks/python-diskcache using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries