summaryrefslogtreecommitdiff
path: root/requests_cache/cache_keys.py
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-09-05 13:21:32 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-09-06 17:39:15 -0500
commit8c05674c426298da7cd8a333c2dfce53151e041f (patch)
treee9bf7b6eb2a105ae6843cf1d74503aa95e0d964c /requests_cache/cache_keys.py
parent7ed1b4dffdd2254a6c319f23bab43df3f6fad91e (diff)
downloadrequests-cache-8c05674c426298da7cd8a333c2dfce53151e041f.tar.gz
Alias/rename 'include_get_headers' to 'match_headers' for clarity (backwards-compatibile)
Diffstat (limited to 'requests_cache/cache_keys.py')
-rw-r--r--requests_cache/cache_keys.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/requests_cache/cache_keys.py b/requests_cache/cache_keys.py
index e58bb14..b83aa9a 100644
--- a/requests_cache/cache_keys.py
+++ b/requests_cache/cache_keys.py
@@ -30,7 +30,7 @@ RequestContent = Union[Mapping, str, bytes]
def create_key(
request: AnyRequest = None,
ignored_parameters: Iterable[str] = None,
- include_get_headers: bool = False,
+ match_headers: bool = False,
**kwargs,
) -> str:
"""Create a normalized cache key from a request object or :py:class:`~requests.Request`
@@ -51,7 +51,7 @@ def create_key(
body = remove_ignored_body_params(request, ignored_parameters)
if body:
key.update(body)
- if include_get_headers and request.headers != DEFAULT_HEADERS:
+ if match_headers and request.headers != DEFAULT_HEADERS:
exclude_headers = list(ignored_parameters or []) + DEFAULT_EXCLUDE_HEADERS
headers = normalize_dict(remove_ignored_headers(request, exclude_headers))
if TYPE_CHECKING: