Base

Base classes for all cache backends.

BaseCache	Base class for cache backends.
BaseStorage	Base class for backend storage implementations.
DictStorage	A basic dict wrapper class for non-persistent, in-memory storage

class requests_cache.backends.base.BaseCache(cache_name='http_cache', match_headers=False, ignored_parameters=None, key_fn=None, **kwargs)

Bases: object

Base class for cache backends. Can be used as a non-persistent, in-memory cache.

This manages higher-level cache operations, including:

• Cache expiration

• Generating cache keys

• Managing redirect history

• Convenience methods for general cache info

Lower-level storage operations are handled by BaseStorage.

To extend this with your own custom backend, see Custom Backends.

Parameters

• cache_name (str) –

• match_headers (Union[Iterable[str], bool]) –

• ignored_parameters (Optional[Iterable[str]]) –

• key_fn (Optional[Callable[..., str]]) –

bulk_delete(keys)

Remove multiple responses and their associated redirects from the cache

Parameters

keys (Iterable[str]) –

clear()

Delete all items from the cache

contains(key=None, request=None, url=None)

Check if the specified request is cached :type key: Optional[str] :param key: Check for a specific cache key :type request: Union[Request, PreparedRequest, CachedRequest, None] :param request: Check for a matching request, according to current request matching settings :type url: Optional[str] :param url: Check for a matching GET request with the specified URL

create_key(request=None, **kwargs)

Create a normalized cache key from a request object

Parameters

request (Union[Request, PreparedRequest, CachedRequest, None]) –

Return type

str

delete(*keys, expired=False, invalid=False, requests=None, urls=None)

Remove responses from the cache according one or more conditions. :type keys: str :param keys: Remove responses with these cache keys :type expired: bool :param expired: Remove all expired responses :type invalid: bool :param invalid: Remove all invalid responses (that can’t be deserialized with current settings) :type requests: Optional[Iterable[Union[Request, PreparedRequest, CachedRequest]]] :param requests: Remove matching responses, according to current request matching settings :type urls: Optional[Iterable[str]] :param urls: Remove matching GET requests for the specified URL(s)

delete_url(url, method='GET', **kwargs)

Parameters

• url (str) –

• method (str) –

delete_urls(urls, method='GET', **kwargs)

Parameters

• urls (Iterable[str]) –

• method (str) –

filter(valid=True, expired=True, invalid=False)

Get responses from the cache, with optional filters :type valid: bool :param valid: Include valid and unexpired responses; set to False to get only

expired/invalid/old responses

Parameters

• expired (bool) – Include expired responses

• invalid (bool) – Include invalid responses (as an empty CachedResponse)

Return type

Iterator[CachedResponse]

get_response(key, default=None)

Retrieve a response from the cache, if it exists

Parameters

• key (str) – Cache key for the response

• default – Value to return if key is not in the cache

Return type

Optional[CachedResponse]

has_key(key)

Parameters

key (str) –

Return type

bool

has_url(url, method='GET', **kwargs)

Parameters

• url (str) –

• method (str) –

Return type

bool

keys(check_expiry=False)

Parameters

check_expiry (bool) –

Return type

Iterator[str]

remove_expired_responses(expire_after=None)

Parameters

expire_after (Union[None, int, float, str, datetime, timedelta]) –

reset_expiration(expire_after=None)

Set a new expiration value on existing cache items :type expire_after: Union[None, int, float, str, datetime, timedelta] :param expire_after: New expiration value, relative to the current time

response_count(check_expiry=False)

Parameters

check_expiry (bool) –

Return type

int

save_response(response, cache_key=None, expires=None)

Save a response to the cache

Parameters

• cache_key (Optional[str]) – Cache key for this response; will otherwise be generated based on request

• response (Union[Response, CachedResponse]) – Response to save

• expires (Optional[datetime]) – Absolute expiration time for this response

update(other)

Update this cache with the contents of another cache

Parameters

other (BaseCache) –

property urls

Get all URLs currently in the cache (excluding redirects)

Return type

Iterator[str]

values(check_expiry=False)

Parameters

check_expiry (bool) –

Return type

Iterator[CachedResponse]

class requests_cache.backends.base.BaseStorage(serializer=None, **kwargs)

Bases: collections.abc.MutableMapping, abc.ABC

Base class for backend storage implementations. This provides a common dictionary-like interface for the underlying storage operations (create, read, update, delete). One BaseStorage instance corresponds to a single table/hash/collection, or whatever the backend-specific equivalent may be.

BaseStorage subclasses contain no behavior specific to requests or caching, which are handled by BaseCache.

BaseStorage also contains a serializer module or instance (defaulting to pickle), which determines how CachedResponse objects are saved internally. See Serializers for details.

Parameters

• serializer – Custom serializer that provides loads and dumps methods

• kwargs – Additional serializer or backend-specific keyword arguments

bulk_delete(keys)

Delete multiple keys from the cache, without raising errors for missing keys. This is a naive implementation that subclasses should override with a more efficient backend-specific implementation, if possible.

Parameters

keys (Iterable[str]) –

clear() → None.  Remove all items from D.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

property serializer

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values

class requests_cache.backends.base.DictStorage(*args, **kwargs)

Bases: collections.UserDict, requests_cache.backends.base.BaseStorage

A basic dict wrapper class for non-persistent, in-memory storage

Note

This is mostly a placeholder for when no other backends are available. For in-memory caching, either SQLiteCache (with use_memory=True) or RedisCache is recommended instead.

bulk_delete(keys)

Delete multiple keys from the cache, without raising errors for missing keys. This is a naive implementation that subclasses should override with a more efficient backend-specific implementation, if possible.

Parameters

keys (Iterable[str]) –

clear() → None.  Remove all items from D.

copy()

classmethod fromkeys(iterable, value=None)

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

property serializer

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values