summaryrefslogtreecommitdiff
path: root/requests_cache/session.py
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2022-04-10 12:15:46 -0500
committerJordan Cook <jordan.cook@pioneer.com>2022-04-10 14:23:43 -0500
commitd39fbfac0192fc9a2dc825dc17ede29776863f5f (patch)
treef222add93c23c4fabd68be204da86f8eb616ad90 /requests_cache/session.py
parent4a593b0c16aa96d5912fb6605dec46b0dc4bf66e (diff)
downloadrequests-cache-d39fbfac0192fc9a2dc825dc17ede29776863f5f.tar.gz
Add default list of ignored_parameters for most common authentication params/headers
Diffstat (limited to 'requests_cache/session.py')
-rw-r--r--requests_cache/session.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/requests_cache/session.py b/requests_cache/session.py
index 3a1b1a3..99d0509 100644
--- a/requests_cache/session.py
+++ b/requests_cache/session.py
@@ -31,6 +31,7 @@ from .models import AnyResponse, CachedResponse, OriginalResponse
from .serializers import SerializerPipeline
from .settings import (
DEFAULT_CACHE_NAME,
+ DEFAULT_IGNORED_PARAMS,
DEFAULT_METHODS,
DEFAULT_STATUS_CODES,
CacheSettings,
@@ -62,7 +63,7 @@ class CacheMixin(MIXIN_BASE):
cache_control: bool = False,
allowable_codes: Iterable[int] = DEFAULT_STATUS_CODES,
allowable_methods: Iterable[str] = DEFAULT_METHODS,
- ignored_parameters: Iterable[str] = None,
+ ignored_parameters: Iterable[str] = DEFAULT_IGNORED_PARAMS,
match_headers: Union[Iterable[str], bool] = False,
filter_fn: FilterCallback = None,
key_fn: KeyCallback = None,
@@ -335,7 +336,8 @@ class CachedSession(CacheMixin, OriginalSession):
allowable_methods: Cache only responses for one of these HTTP methods
match_headers: Match request headers when reading from the cache; may be either ``True`` or
a list of specific headers to match
- ignored_parameters: List of request parameters to not match against, and exclude from the cache
+ ignored_parameters: Request paramters, headers, and/or JSON body params to exclude from both
+ request matching and cached request data
stale_if_error: Return stale cache data if a new request raises an exception
filter_fn: Response filtering function that indicates whether or not a given response should
be cached. See :ref:`custom-filtering` for details.