summaryrefslogtreecommitdiff
path: root/HISTORY.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2022-06-10 17:36:20 -0500
committerJordan Cook <jordan.cook@pioneer.com>2022-06-11 11:50:24 -0500
commit275f675bc2fd6d5ffa3363a436867258a8eccd26 (patch)
tree7272c4076ad0c0dd7b375d2052b6f7c0b232d968 /HISTORY.md
parent319a68b6f5a38344fd70c3db346e78f9a78a0d8c (diff)
downloadrequests-cache-275f675bc2fd6d5ffa3363a436867258a8eccd26.tar.gz
Split up remove_expired_reponses() into remove() and reset_expiration() methods, with more granular arguments
Diffstat (limited to 'HISTORY.md')
-rw-r--r--HISTORY.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/HISTORY.md b/HISTORY.md
index 454eb87..f10f94f 100644
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -55,6 +55,13 @@
* Always skip both cache read and write for requests excluded by `allowable_methods` (previously only skipped write)
* Ignore and redact common authentication headers and request parameters by default. This provides some default recommended values for `ignored_parameters`, to avoid accidentally storing common credentials (e.g., OAuth tokens) in the cache. This will have no effect if you are already setting `ignored_parameters`.
+**Other features:**
+* Split existing features of `BaseCache.remove_expired_responses()` into multiple methods and arguments:
+ * Add `BaseCache.remove()` method with `expired` and `invalid` arguments
+ * Add `BaseCache.reset_expiration()` method to reset expiration for existing responses
+* Add `older_than` argument to `BaseCache.remove()` to remove responses older than a given value
+* Add `BaseCache.items()` method
+
**Type hints:**
* Add `OriginalResponse` type, which adds type hints to `requests.Response` objects for extra attributes added by requests-cache:
* `cache_key`
@@ -69,6 +76,9 @@
**Dependencies:**
* Replace `appdirs` with `platformdirs`
+**Deprecations:**
+* `BaseCache.remove_expired_responses()` and `CachedSession.remove_expired_responses()` are deprecated in favor of `BaseCache.remove()`
+
**Breaking changes:**
Some relatively minor breaking changes have been made that are not expected to affect most users.