Patcher

Utilities for patching requests.

Warning

These functions are not thread-safe. Use CachedSession if you want to use caching in a multi-threaded environment.

clear	Clear the currently installed cache (if any)
disabled	Context manager for temporarily disabling caching for all requests functions
enabled	Context manager for temporarily enabling caching for all requests functions
get_cache	Get the internal cache object from the currently installed CachedSession (if any)
install_cache	Install the cache for all requests functions by monkey-patching requests.Session
is_installed	Indicate whether or not requests-cache is currently installed
remove_expired_responses	Remove expired responses from the cache, optionally with revalidation
uninstall_cache	Disable the cache by restoring the original requests.Session

requests_cache.patcher.clear()

Clear the currently installed cache (if any)

requests_cache.patcher.disabled()

Context manager for temporarily disabling caching for all requests functions

Example

>>> with requests_cache.disabled():
...     requests.get('http://httpbin.org/get')

requests_cache.patcher.enabled(*args, **kwargs)

Context manager for temporarily enabling caching for all requests functions

Accepts the same arguments as install_cache().

Example

>>> with requests_cache.enabled('cache_db'):
...     requests.get('http://httpbin.org/get')

requests_cache.patcher.get_cache()

Get the internal cache object from the currently installed CachedSession (if any)

Return type

Optional[BaseCache]

requests_cache.patcher.install_cache(cache_name='http_cache', backend=None, expire_after=-1, urls_expire_after=None, allowable_codes=(200, ), allowable_methods=('GET', 'HEAD'), filter_fn=None, stale_if_error=False, session_factory=<class 'requests_cache.session.CachedSession'>, **kwargs)

Install the cache for all requests functions by monkey-patching requests.Session

Example

>>> requests_cache.install_cache('demo_cache')

Accepts all the same parameters as CachedSession. Additional parameters:

Parameters

• session_factory (Type[Session]) – Session class to use. It must inherit from either CachedSession or CacheMixin

• cache_name (str) –

• backend (Union[str, BaseCache, Type[BaseCache], None]) –

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

• urls_expire_after (Optional[Dict[str, Union[None, int, float, str, datetime, timedelta]]]) –

• allowable_codes (Iterable[int]) –

• allowable_methods (Iterable[str]) –

• filter_fn (Optional[Callable]) –

• stale_if_error (bool) –

requests_cache.patcher.is_installed()

Indicate whether or not requests-cache is currently installed

Return type

bool

requests_cache.patcher.remove_expired_responses(expire_after=None)

Remove expired responses from the cache, optionally with revalidation

Parameters

expire_after (Union[None, int, float, str, datetime, timedelta]) – A new expiration time used to revalidate the cache

requests_cache.patcher.uninstall_cache()

Disable the cache by restoring the original requests.Session