Filesystem#
This backend stores responses in files on the local filesystem (one file per response).
File Formats#
By default, responses are saved as pickle files, since this format is generally the fastest. If you want to save responses in a human-readable format, you can use one of the other available Serializers. For example, to save responses as JSON files:
>>> session = CachedSession('~/http_cache', backend='filesystem', serializer='json')
>>> session.get('https://httpbin.org/get')
>>> print(list(session.cache.paths()))
['/home/user/http_cache/4dc151d95200ec.json']
Or as YAML (requires pyyaml
):
>>> session = CachedSession('~/http_cache', backend='filesystem', serializer='yaml')
>>> session.get('https://httpbin.org/get')
>>> print(list(session.cache.paths()))
['/home/user/http_cache/4dc151d95200ec.yaml']
Cache Files#
See Cache Files for general info on specifying cache paths
The path for a given response will be in the format
<cache_name>/<cache_key>
Redirects are stored in a separate SQLite database, located at
<cache_name>/redirects.sqlite
Use
FileCache.paths()
to get a list of all cached response paths
API Reference#
- class requests_cache.backends.filesystem.FileCache(cache_name='http_cache', use_temp=False, **kwargs)[source]#
Bases:
requests_cache.backends.base.BaseCache
Filesystem backend.
- Parameters
cache_name (
Union
[Path
,str
]) – Base directory for cache filesuse_cache_dir – Store datebase in a user cache directory (e.g., ~/.cache/)
use_temp (
bool
) – Store cache files in a temp directory (e.g.,/tmp/http_cache/
). Note: ifcache_name
is an absolute path, this option will be ignored.extension – Extension for cache files. If not specified, the serializer default extension will be used.
- bulk_delete(keys)#
Remove multiple responses and their associated redirects from the cache
- contains(key=None, request=None, url=None)#
Check if the specified request is cached
- Parameters
request (
Union
[Request
,PreparedRequest
,CachedRequest
,None
]) – Check for a matching request, according to current request matching settingsurl (
Optional
[str
]) – 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
- delete(*keys, expired=False, invalid=False, requests=None, urls=None)#
Remove responses from the cache according one or more conditions.
- Parameters
keys (
str
) – Remove responses with these cache keysexpired (
bool
) – Remove all expired responsesinvalid (
bool
) – Remove all invalid responses (that can’t be deserialized with current settings)requests (
Optional
[Iterable
[Union
[Request
,PreparedRequest
,CachedRequest
]]]) – Remove matching responses, according to current request matching settingsurls (
Optional
[Iterable
[str
]]) – Remove matching GET requests for the specified URL(s)
- filter(valid=True, expired=True, invalid=False)#
Get responses from the cache, with optional filters
- Parameters
- Return type
- get_response(key, default=None)#
Retrieve a response from the cache, if it exists
- Parameters
key (
str
) – Cache key for the responsedefault – Value to return if key is not in the cache
- Return type
- reset_expiration(expire_after=None)#
Set a new expiration value on existing cache items
- save_response(response, cache_key=None, expires=None)#
Save a response to the cache
- class requests_cache.backends.filesystem.FileDict(cache_name, use_temp=False, use_cache_dir=False, extension=None, **kwargs)[source]#
Bases:
requests_cache.backends.base.BaseStorage
A dictionary-like interface to files on the local filesystem
- Parameters
- 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.
- 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 #
- 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 #