Merge pull request #743 from requests-cache/fix-log-msg

Fix log message and DeprecationWarning (0.9)

Author: JWCook

.github/workflows/build.yml

@@ -2,10 +2,10 @@ name: Build
 
 on:
   push:
-    branches: [main]
+    branches: [main, v0.9]
     tags: ['v*']
   pull_request:
-    branches: [main]
+    branches: [main, v0.9]
   workflow_dispatch:
 env:
   LATEST_PY_VERSION: '3.11'

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
     rev: 5.10.1
     hooks:
       - id: isort
-  - repo: https://gitlab.com/pycqa/flake8
+  - repo: https://github.com/pycqa/flake8
     rev: 3.9.2
     hooks:
       - id: flake8

HISTORY.md

@@ -1,5 +1,10 @@
 # History
 
+## 0.9.8 (Unreleased)
+* Fix `DeprecationWarning` raised by `BaseCache.urls`
+* Reword ambiguous log message for `BaseCache.delete`
+* For custom serializers, handle using a cattrs converter that doesn't support `omit_if_default`
+
 ## 0.9.7 (2022-10-26)
 Backport compatibility fixes from 1.0:
 * **PyInstaller:** Fix potential `AttributeError` due to undetected imports when requests-cache is bundled in a PyInstaller package

docs/reference.md

@@ -12,18 +12,12 @@ from requests_cache import CachedSession, RedisCache, json_serializer
 :::
 
 ```{toctree}
-:maxdepth: 1
+:maxdepth: 2
 session
 modules/requests_cache.patcher
-```
-```{toctree}
-:maxdepth: 2
 modules/requests_cache.backends
 modules/requests_cache.models
+modules/requests_cache.policy
 modules/requests_cache.serializers
-```
-```{toctree}
-:maxdepth: 1
 modules/requests_cache.cache_keys
-modules/requests_cache.cache_control
 ```

docs/user_guide/inspection.md

@@ -59,27 +59,23 @@ For example, if you wanted to to see all URLs requested with a specific method:
 You can also inspect `CachedSession.cache.redirects`, which maps redirect URLs to keys of the
 responses they redirect to.
 
-Additional `keys()` and `values()` wrapper methods are available on {py:class}`.BaseCache` to get
-combined keys and responses.
+
+### Filtering responses
+Use {py:meth}`.BaseCache.filter` to get responses with optional filters. By default, it returns all
+responses except any invalid ones that would raise an exception:
 ```python
->>> print('All responses:')
->>> for response in session.cache.values():
+>>> for response in session.cache.filter():
 >>>     print(response)
-
->>> print('All cache keys for redirects and responses combined:')
->>> print(list(session.cache.keys()))
 ```
 
-Both methods also take a `check_expiry` argument to exclude expired responses:
+Get unexpired responses:
 ```python
->>> print('All unexpired responses:')
->>> for response in session.cache.values(check_expiry=True):
+>>> for response in session.cache.filter(expired=False):
 >>>     print(response)
 ```
 
-Similarly, you can get a count of responses with {py:meth}`.BaseCache.response_count`, and optionally
-exclude expired responses:
+Get keys for **only** expired responses:
 ```python
->>> print(f'Total responses: {session.cache.response_count()}')
->>> print(f'Unexpired responses: {session.cache.response_count(check_expiry=True)}')
+>>> expired_responses = session.cache.filter(valid=False, expired=True)
+>>> keys = [response.cache_key for response in expired_responses]
 ```