Index

Symbols

**kw (dogpile.cache.plugins.mako_cache.MakoPlugin.get parameter) (dogpile.cache.plugins.mako_cache.MakoPlugin.get_or_create parameter) (dogpile.cache.plugins.mako_cache.MakoPlugin.invalidate parameter) (dogpile.util.NameRegistry.get parameter)

A

AbstractFileLock (class in dogpile.cache.backends.file) acquire() (dogpile.cache.api.CacheMutex method) (dogpile.cache.backends.file.AbstractFileLock method) acquire_read_lock() (dogpile.cache.backends.file.AbstractFileLock method) (dogpile.cache.backends.file.FileLock method) (dogpile.util.ReadWriteMutex method) acquire_write_lock() (dogpile.cache.backends.file.AbstractFileLock method) (dogpile.cache.backends.file.FileLock method) (dogpile.util.ReadWriteMutex method)

actual_backend (dogpile.cache.region.CacheRegion property) arguments (dogpile.cache.region.CacheRegion.configure parameter), [1] asdict (dogpile.cache.region.CacheRegion.cache_multi_on_arguments parameter) async_creation_runner (dogpile.cache.region.CacheRegion parameter), [1] async_creator (dogpile.Lock parameter)

B

backend (dogpile.cache.region.CacheRegion.configure parameter), [1] BackendFormatted (in module dogpile.cache.api) BackendSetType (in module dogpile.cache.api)

behaviors (dogpile.cache.backends.memcached.PylibmcBackend parameter) binary (dogpile.cache.backends.memcached.PylibmcBackend parameter) BMemcachedBackend (class in dogpile.cache.backends.memcached) BytesBackend (class in dogpile.cache.api)

C

cache_multi_on_arguments() (dogpile.cache.region.CacheRegion method) cache_on_arguments() (dogpile.cache.region.CacheRegion method) CacheBackend (class in dogpile.cache.api) CachedValue (class in dogpile.cache.api) CacheMutex (class in dogpile.cache.api) CacheRegion (class in dogpile.cache.region) CacheReturnType (in module dogpile.cache.api) client (dogpile.cache.backends.memcached.GenericMemcachedBackend property) configure() (dogpile.cache.region.CacheRegion method)

configure_from_config() (dogpile.cache.region.CacheRegion method) connection_kwargs (dogpile.cache.backends.redis.RedisBackend parameter) (dogpile.cache.backends.redis.RedisSentinelBackend parameter) connection_pool (dogpile.cache.backends.redis.RedisBackend parameter) creation_function (dogpile.cache.plugins.mako_cache.MakoPlugin.get_or_create parameter) creator (dogpile.cache.region.CacheRegion.get_or_create parameter), [1] (dogpile.cache.region.CacheRegion.get_or_create_multi parameter) (dogpile.Lock parameter) (dogpile.util.NameRegistry parameter) creator_args (dogpile.cache.region.CacheRegion.get_or_create parameter), [1]

D

db (dogpile.cache.backends.redis.RedisBackend parameter) (dogpile.cache.backends.redis.RedisSentinelBackend parameter) DBMBackend (class in dogpile.cache.backends.file) dead_retry (dogpile.cache.backends.memcached.MemcachedBackend parameter) dead_timeout (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) default_noreply (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) DefaultInvalidationStrategy (class in dogpile.cache.region) delete() (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.file.DBMBackend method) (dogpile.cache.backends.memcached.GenericMemcachedBackend method) (dogpile.cache.backends.memory.MemoryBackend method) (dogpile.cache.backends.null.NullBackend method) (dogpile.cache.backends.redis.RedisBackend method) (dogpile.cache.proxy.ProxyBackend method) (dogpile.cache.region.CacheRegion method) delete_multi() (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.file.DBMBackend method) (dogpile.cache.backends.memcached.BMemcachedBackend method) (dogpile.cache.backends.memcached.GenericMemcachedBackend method) (dogpile.cache.backends.memory.MemoryBackend method) (dogpile.cache.backends.null.NullBackend method) (dogpile.cache.backends.redis.RedisBackend method) (dogpile.cache.proxy.ProxyBackend method) (dogpile.cache.region.CacheRegion method) deserializer (dogpile.cache.api.CacheBackend attribute) (dogpile.cache.region.CacheRegion parameter), [1]

distributed_lock (dogpile.cache.backends.memcached.GenericMemcachedBackend parameter) (dogpile.cache.backends.redis.RedisBackend parameter) (dogpile.cache.backends.redis.RedisSentinelBackend parameter) do_not_retry_for (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) dogpile.cache.api module dogpile.cache.backends.file module dogpile.cache.backends.memcached module dogpile.cache.backends.memory module dogpile.cache.backends.null module dogpile.cache.backends.redis module dogpile.cache.exception module dogpile.cache.plugins.mako_cache module dogpile.cache.proxy module dogpile.cache.region module dogpile_lockfile (dogpile.cache.backends.file.DBMBackend parameter) DogpileCacheException

E

enable_retry_client (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) expiration_time (dogpile.cache.region.CacheRegion.cache_multi_on_arguments parameter) (dogpile.cache.region.CacheRegion.cache_on_arguments parameter), [1] (dogpile.cache.region.CacheRegion.configure parameter), [1] (dogpile.cache.region.CacheRegion.get parameter), [1] (dogpile.cache.region.CacheRegion.get_or_create parameter), [1] (dogpile.cache.region.CacheRegion.get_or_create_multi parameter)

expiretime (dogpile.Lock parameter)

F

FileLock (class in dogpile.cache.backends.file) filename (dogpile.cache.backends.file.DBMBackend parameter) function_key_generator (dogpile.cache.region.CacheRegion parameter), [1] (dogpile.cache.region.CacheRegion.cache_on_arguments parameter), [1]

function_key_generator() (in module dogpile.cache.util) function_multi_key_generator (dogpile.cache.region.CacheRegion parameter), [1] (dogpile.cache.region.CacheRegion.cache_multi_on_arguments parameter)

G

GenericMemcachedBackend (class in dogpile.cache.backends.memcached) get() (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.memcached.GenericMemcachedBackend method) (dogpile.cache.backends.memory.MemoryBackend method) (dogpile.cache.backends.null.NullBackend method) (dogpile.cache.plugins.mako_cache.MakoPlugin method) (dogpile.cache.proxy.ProxyBackend method) (dogpile.cache.region.CacheRegion method) (dogpile.util.NameRegistry method) get_multi() (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.memcached.GenericMemcachedBackend method) (dogpile.cache.backends.memory.MemoryBackend method) (dogpile.cache.backends.null.NullBackend method) (dogpile.cache.proxy.ProxyBackend method) (dogpile.cache.region.CacheRegion method) get_mutex() (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.file.DBMBackend method) (dogpile.cache.backends.memcached.GenericMemcachedBackend method) (dogpile.cache.backends.null.NullBackend method) (dogpile.cache.backends.redis.RedisBackend method) (dogpile.cache.proxy.ProxyBackend method)

get_or_create() (dogpile.cache.plugins.mako_cache.MakoPlugin method) (dogpile.cache.region.CacheRegion method) get_or_create_multi() (dogpile.cache.region.CacheRegion method) get_serialized() (dogpile.cache.api.BytesBackend method) (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.file.DBMBackend method) (dogpile.cache.backends.redis.RedisBackend method) (dogpile.cache.proxy.ProxyBackend method) get_serialized_multi() (dogpile.cache.api.BytesBackend method) (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.file.DBMBackend method) (dogpile.cache.backends.redis.RedisBackend method) (dogpile.cache.proxy.ProxyBackend method)

H

hard (dogpile.cache.region.CacheRegion.invalidate parameter) hashclient_retry_attempts (dogpile.cache.backends.memcached.PyMemcacheBackend parameter)

hashclient_retry_timeout (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) host (dogpile.cache.backends.redis.RedisBackend parameter)

I

identifier (dogpile.util.NameRegistry.get parameter) ignore_expiration (dogpile.cache.region.CacheRegion.get parameter), [1] invalidate() (dogpile.cache.plugins.mako_cache.MakoPlugin method) (dogpile.cache.region.CacheRegion method) (dogpile.cache.region.DefaultInvalidationStrategy method) (dogpile.cache.region.RegionInvalidationStrategy method) is_configured (dogpile.cache.region.CacheRegion property)

is_hard_invalidated() (dogpile.cache.region.DefaultInvalidationStrategy method) (dogpile.cache.region.RegionInvalidationStrategy method) is_invalidated() (dogpile.cache.region.DefaultInvalidationStrategy method) (dogpile.cache.region.RegionInvalidationStrategy method) is_open (dogpile.cache.backends.file.AbstractFileLock property) (dogpile.cache.backends.file.FileLock property) is_soft_invalidated() (dogpile.cache.region.DefaultInvalidationStrategy method) (dogpile.cache.region.RegionInvalidationStrategy method)

K

key (dogpile.cache.api.BytesBackend.get_serialized parameter) (dogpile.cache.api.BytesBackend.set_serialized parameter) (dogpile.cache.api.CacheBackend.delete parameter) (dogpile.cache.api.CacheBackend.get parameter) (dogpile.cache.api.CacheBackend.get_serialized parameter) (dogpile.cache.api.CacheBackend.set parameter) (dogpile.cache.api.CacheBackend.set_serialized parameter) (dogpile.cache.backends.file.DBMBackend.delete parameter) (dogpile.cache.backends.file.DBMBackend.get_serialized parameter) (dogpile.cache.backends.file.DBMBackend.set_serialized parameter) (dogpile.cache.backends.memcached.GenericMemcachedBackend.delete parameter) (dogpile.cache.backends.memcached.GenericMemcachedBackend.get parameter) (dogpile.cache.backends.memcached.GenericMemcachedBackend.set parameter) (dogpile.cache.backends.memory.MemoryBackend.delete parameter) (dogpile.cache.backends.memory.MemoryBackend.get parameter) (dogpile.cache.backends.memory.MemoryBackend.set parameter) (dogpile.cache.backends.null.NullBackend.delete parameter) (dogpile.cache.backends.null.NullBackend.get parameter) (dogpile.cache.backends.null.NullBackend.set parameter) (dogpile.cache.backends.redis.RedisBackend.delete parameter) (dogpile.cache.backends.redis.RedisBackend.get_serialized parameter) (dogpile.cache.backends.redis.RedisBackend.set_serialized parameter) (dogpile.cache.plugins.mako_cache.MakoPlugin.get parameter) (dogpile.cache.plugins.mako_cache.MakoPlugin.get_or_create parameter) (dogpile.cache.plugins.mako_cache.MakoPlugin.invalidate parameter) (dogpile.cache.proxy.ProxyBackend.delete parameter) (dogpile.cache.proxy.ProxyBackend.get parameter) (dogpile.cache.proxy.ProxyBackend.get_serialized parameter) (dogpile.cache.proxy.ProxyBackend.set parameter) (dogpile.cache.proxy.ProxyBackend.set_serialized parameter) (dogpile.cache.region.CacheRegion.get parameter), [1] (dogpile.cache.region.CacheRegion.get_or_create parameter), [1]

key_is_locked() (dogpile.cache.region.CacheRegion method) key_mangler (dogpile.cache.api.CacheBackend attribute) (dogpile.cache.region.CacheRegion parameter), [1] keys (dogpile.cache.api.BytesBackend.get_serialized_multi parameter) (dogpile.cache.api.CacheBackend.delete_multi parameter) (dogpile.cache.api.CacheBackend.get_multi parameter) (dogpile.cache.api.CacheBackend.get_serialized_multi parameter) (dogpile.cache.backends.file.DBMBackend.delete_multi parameter) (dogpile.cache.backends.file.DBMBackend.get_serialized_multi parameter) (dogpile.cache.backends.memcached.GenericMemcachedBackend.delete_multi parameter) (dogpile.cache.backends.memcached.GenericMemcachedBackend.get_multi parameter) (dogpile.cache.backends.memory.MemoryBackend.delete_multi parameter) (dogpile.cache.backends.memory.MemoryBackend.get_multi parameter) (dogpile.cache.backends.null.NullBackend.delete_multi parameter) (dogpile.cache.backends.null.NullBackend.get_multi parameter) (dogpile.cache.backends.redis.RedisBackend.delete_multi parameter) (dogpile.cache.backends.redis.RedisBackend.get_serialized_multi parameter) (dogpile.cache.proxy.ProxyBackend.delete_multi parameter) (dogpile.cache.proxy.ProxyBackend.get_multi parameter) (dogpile.cache.proxy.ProxyBackend.get_serialized_multi parameter) (dogpile.cache.region.CacheRegion.get_or_create_multi parameter) KeyType (in module dogpile.cache.api) kwarg_function_key_generator() (in module dogpile.cache.util)

L

length_conditional_mangler() (in module dogpile.cache.util) Lock (class in dogpile) lock_factory (dogpile.cache.backends.file.DBMBackend parameter) lock_sleep (dogpile.cache.backends.redis.RedisBackend parameter) (dogpile.cache.backends.redis.RedisSentinelBackend parameter)

lock_timeout (dogpile.cache.backends.memcached.GenericMemcachedBackend parameter) (dogpile.cache.backends.redis.RedisBackend parameter) (dogpile.cache.backends.redis.RedisSentinelBackend parameter) locked() (dogpile.cache.api.CacheMutex method)

M

make_region() (in module dogpile.cache.region) MakoPlugin (class in dogpile.cache.plugins.mako_cache) mapping (dogpile.cache.api.BytesBackend.set_serialized_multi parameter) (dogpile.cache.api.CacheBackend.set_multi parameter) (dogpile.cache.api.CacheBackend.set_serialized_multi parameter) (dogpile.cache.backends.file.DBMBackend.set_serialized_multi parameter) (dogpile.cache.backends.memcached.GenericMemcachedBackend.set_multi parameter) (dogpile.cache.backends.memory.MemoryBackend.set_multi parameter) (dogpile.cache.backends.null.NullBackend.set_multi parameter) (dogpile.cache.backends.redis.RedisBackend.set_serialized_multi parameter) (dogpile.cache.proxy.ProxyBackend.set_multi parameter) (dogpile.cache.proxy.ProxyBackend.set_serialized_multi parameter) memcached_expire_time (dogpile.cache.backends.memcached.GenericMemcachedBackend parameter) MemcachedBackend (class in dogpile.cache.backends.memcached) MemcachedLock (class in dogpile.cache.backends.memcached)

MemoryBackend (class in dogpile.cache.backends.memory) MemoryPickleBackend (class in dogpile.cache.backends.memory) metadata (dogpile.cache.api.CachedValue attribute) min_compress_len (dogpile.cache.backends.memcached.PylibmcBackend parameter) module dogpile.cache.api dogpile.cache.backends.file dogpile.cache.backends.memcached dogpile.cache.backends.memory dogpile.cache.backends.null dogpile.cache.backends.redis dogpile.cache.exception dogpile.cache.plugins.mako_cache dogpile.cache.proxy dogpile.cache.region mutex (dogpile.Lock parameter)

N

name (dogpile.cache.region.CacheRegion parameter), [1] NameRegistry (class in dogpile.util) namespace (dogpile.cache.region.CacheRegion.cache_multi_on_arguments parameter) (dogpile.cache.region.CacheRegion.cache_on_arguments parameter), [1]

NeedRegenerationException (class in dogpile) NO_VALUE (in module dogpile.cache.api) NoValue (class in dogpile.cache.api) NullBackend (class in dogpile.cache.backends.null)

P

password (dogpile.cache.backends.memcached.BMemcachedBackend parameter) (dogpile.cache.backends.redis.RedisBackend parameter) payload (dogpile.cache.api.CachedValue attribute) PluginNotFound

port (dogpile.cache.backends.redis.RedisBackend parameter) ProxyBackend (class in dogpile.cache.proxy) PylibmcBackend (class in dogpile.cache.backends.memcached) PyMemcacheBackend (class in dogpile.cache.backends.memcached)

R

read() (dogpile.cache.backends.file.AbstractFileLock method) ReadWriteMutex (class in dogpile.util) redis_expiration_time (dogpile.cache.backends.redis.RedisBackend parameter) (dogpile.cache.backends.redis.RedisSentinelBackend parameter) RedisBackend (class in dogpile.cache.backends.redis) RedisSentinelBackend (class in dogpile.cache.backends.redis) region_invalidator (dogpile.cache.region.CacheRegion.configure parameter), [1] RegionAlreadyConfigured RegionInvalidationStrategy (class in dogpile.cache.region) RegionNotConfigured release() (dogpile.cache.api.CacheMutex method) (dogpile.cache.backends.file.AbstractFileLock method)

release_read_lock() (dogpile.cache.backends.file.AbstractFileLock method) (dogpile.cache.backends.file.FileLock method) (dogpile.util.ReadWriteMutex method) release_write_lock() (dogpile.cache.backends.file.AbstractFileLock method) (dogpile.cache.backends.file.FileLock method) (dogpile.util.ReadWriteMutex method) replace_existing_backend (dogpile.cache.region.CacheRegion.configure parameter), [1] retry_attempts (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) retry_delay (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) retry_for (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) rw_lockfile (dogpile.cache.backends.file.DBMBackend parameter)

S

sentinel_kwargs (dogpile.cache.backends.redis.RedisSentinelBackend parameter) sentinels (dogpile.cache.backends.redis.RedisSentinelBackend parameter) serde (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) SerializedReturnType (in module dogpile.cache.api) serializer (dogpile.cache.api.CacheBackend attribute) (dogpile.cache.region.CacheRegion parameter), [1] service_name (dogpile.cache.backends.redis.RedisSentinelBackend parameter) set() (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.memcached.GenericMemcachedBackend method) (dogpile.cache.backends.memory.MemoryBackend method) (dogpile.cache.backends.null.NullBackend method) (dogpile.cache.proxy.ProxyBackend method) (dogpile.cache.region.CacheRegion method) set_arguments (dogpile.cache.backends.memcached.GenericMemcachedBackend attribute) set_multi() (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.memcached.GenericMemcachedBackend method) (dogpile.cache.backends.memory.MemoryBackend method) (dogpile.cache.backends.null.NullBackend method) (dogpile.cache.proxy.ProxyBackend method) (dogpile.cache.region.CacheRegion method)

set_serialized() (dogpile.cache.api.BytesBackend method) (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.file.DBMBackend method) (dogpile.cache.backends.redis.RedisBackend method) (dogpile.cache.proxy.ProxyBackend method) set_serialized_multi() (dogpile.cache.api.BytesBackend method) (dogpile.cache.api.CacheBackend method) (dogpile.cache.backends.file.DBMBackend method) (dogpile.cache.backends.redis.RedisBackend method) (dogpile.cache.proxy.ProxyBackend method) sha1_mangle_key() (in module dogpile.cache.util) should_cache_fn (dogpile.cache.region.CacheRegion.cache_multi_on_arguments parameter) (dogpile.cache.region.CacheRegion.cache_on_arguments parameter), [1] (dogpile.cache.region.CacheRegion.get_or_create parameter), [1] (dogpile.cache.region.CacheRegion.get_or_create_multi parameter) socket_keepalive (dogpile.cache.backends.memcached.PyMemcacheBackend parameter) socket_timeout (dogpile.cache.backends.memcached.MemcachedBackend parameter) (dogpile.cache.backends.redis.RedisBackend parameter) (dogpile.cache.backends.redis.RedisSentinelBackend parameter)

T

thread_local_lock (dogpile.cache.backends.redis.RedisBackend parameter) (dogpile.cache.backends.redis.RedisSentinelBackend parameter) tls_context (dogpile.cache.backends.memcached.BMemcachedBackend parameter) (dogpile.cache.backends.memcached.PyMemcacheBackend parameter)

to_str (dogpile.cache.region.CacheRegion.cache_multi_on_arguments parameter) (dogpile.cache.region.CacheRegion.cache_on_arguments parameter), [1]

U

url (dogpile.cache.backends.memcached.GenericMemcachedBackend parameter) (dogpile.cache.backends.redis.RedisBackend parameter)

username (dogpile.cache.backends.memcached.BMemcachedBackend parameter)

V

ValidationError value (dogpile.cache.api.BytesBackend.set_serialized parameter) (dogpile.cache.api.CacheBackend.set parameter) (dogpile.cache.api.CacheBackend.set_serialized parameter) (dogpile.cache.backends.file.DBMBackend.set_serialized parameter) (dogpile.cache.backends.memcached.GenericMemcachedBackend.set parameter) (dogpile.cache.backends.memory.MemoryBackend.set parameter) (dogpile.cache.backends.null.NullBackend.set parameter) (dogpile.cache.backends.redis.RedisBackend.set_serialized parameter) (dogpile.cache.proxy.ProxyBackend.set parameter) (dogpile.cache.proxy.ProxyBackend.set_serialized parameter)

value_and_created_fn (dogpile.Lock parameter) value_version (in module dogpile.cache.region) ValuePayload (in module dogpile.cache.api)

W

wait (dogpile.cache.api.CacheMutex.acquire parameter) was_hard_invalidated() (dogpile.cache.region.DefaultInvalidationStrategy method) (dogpile.cache.region.RegionInvalidationStrategy method) was_soft_invalidated() (dogpile.cache.region.DefaultInvalidationStrategy method) (dogpile.cache.region.RegionInvalidationStrategy method)

wrap (dogpile.cache.region.CacheRegion.configure parameter), [1] wrap() (dogpile.cache.proxy.ProxyBackend method) (dogpile.cache.region.CacheRegion method) write() (dogpile.cache.backends.file.AbstractFileLock method)