summaryrefslogtreecommitdiff
path: root/requests_cache
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook.git@proton.me>2022-09-29 14:05:51 -0500
committerJordan Cook <jordan.cook.git@proton.me>2022-09-29 14:05:51 -0500
commitba8fe3770c38c60b94b055fd546ec009b809f43f (patch)
tree98c34460ff23184790a10d2441d40aaf31242341 /requests_cache
parent662ce95795574fcc5c4a36ac7d5eb0fd409c9310 (diff)
downloadrequests-cache-ba8fe3770c38c60b94b055fd546ec009b809f43f.tar.gz
Add delete() function for patcher
Diffstat (limited to 'requests_cache')
-rw-r--r--requests_cache/patcher.py18
1 files changed, 15 insertions, 3 deletions
diff --git a/requests_cache/patcher.py b/requests_cache/patcher.py
index 30ba908..137e928 100644
--- a/requests_cache/patcher.py
+++ b/requests_cache/patcher.py
@@ -10,6 +10,7 @@
from contextlib import contextmanager
from logging import getLogger
from typing import Optional, Type
+from warnings import warn
import requests
@@ -106,11 +107,22 @@ def clear():
get_cache().clear()
-def remove_expired_responses():
- """Remove expired and invalid responses from the cache"""
+def delete(*args, **kwargs):
+ """Remove responses from the cache according one or more conditions.
+ See :py:meth:`.BaseCache.delete for usage details.
+ """
session = requests.Session()
if isinstance(session, CachedSession):
- session.cache.delete(expired=True)
+ session.cache.delete(*args, **kwargs)
+
+
+def remove_expired_responses():
+ """Remove expired responses from the cache"""
+ warn(
+ 'remove_expired_responses() is deprecated; please use delete() instead',
+ DeprecationWarning,
+ )
+ delete(expired=True)
def _patch_session_factory(session_factory: Type[OriginalSession] = CachedSession):