Cache Keys

Internal utilities for generating cache keys that are used for request matching

create_key	Create a normalized cache key based on a request object
normalize_body	Normalize and filter a request body if possible, depending on Content-Type
normalize_headers	Sort and filter request headers, and normalize minor variations in multi-value headers
normalize_request	Normalize and remove ignored parameters from request URL, body, and headers.
normalize_params	Normalize and filter urlencoded params from either a URL or request body with form data
normalize_url	Normalize and filter a URL.

requests_cache.cache_keys.create_key(request, ignored_parameters=None, match_headers=False, serializer=None, **request_kwargs)

Create a normalized cache key based on a request object

Parameters:

• request (Union[Request, PreparedRequest, CachedRequest]) – Request object to generate a cache key from

• ignored_parameters (Optional[Iterable[str]]) – Request paramters, headers, and/or JSON body params to exclude

• match_headers (Union[Iterable[str], None, bool]) – Match only the specified headers, or True to match all headers

• request_kwargs – Additional keyword arguments for request()

• serializer (Any) –

Return type:

str

requests_cache.cache_keys.filter_sort_dict(data, ignored_parameters=None)

Parameters:

• data (Mapping[str, str]) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

Dict[str, str]

requests_cache.cache_keys.filter_sort_json(data, ignored_parameters)

Parameters:

• data (Union[List, Mapping]) –

• ignored_parameters (Optional[Iterable[str]]) –

requests_cache.cache_keys.filter_sort_list(data, ignored_parameters=None)

Parameters:

• data (List) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

List

requests_cache.cache_keys.filter_sort_multidict(data, ignored_parameters=None)

Parameters:

• data (List[Tuple[str, str]]) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

List[Tuple[str, str]]

requests_cache.cache_keys.filter_url(url, ignored_parameters)

Filter ignored parameters out of a URL

Parameters:

• url (str) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

str

requests_cache.cache_keys.get_matched_headers(headers, match_headers)

Get only the headers we should match against as a list of k=v strings, given an optional include list.

Parameters:

• headers (CaseInsensitiveDict) –

• match_headers (Union[Iterable[str], None, bool]) –

Return type:

List[str]

requests_cache.cache_keys.normalize_body(request, ignored_parameters)

Normalize and filter a request body if possible, depending on Content-Type

Parameters:

• request (Union[PreparedRequest, CachedRequest]) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

bytes

requests_cache.cache_keys.normalize_headers(headers, ignored_parameters=None)

Sort and filter request headers, and normalize minor variations in multi-value headers

Parameters:

• headers (MutableMapping[str, str]) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

CaseInsensitiveDict

requests_cache.cache_keys.normalize_json_body(original_body, ignored_parameters)

Normalize and filter a request body with serialized JSON data

Parameters:

• original_body (Union[str, bytes]) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

Union[str, bytes]

requests_cache.cache_keys.normalize_params(value, ignored_parameters=None)

Normalize and filter urlencoded params from either a URL or request body with form data

Parameters:

• value (Union[str, bytes]) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

str

requests_cache.cache_keys.normalize_request(request, ignored_parameters=None)

Normalize and remove ignored parameters from request URL, body, and headers. This is used for both:

• Increasing cache hits by generating more precise cache keys

• Redacting potentially sensitive info from cached requests

Parameters:

• request (Union[Request, PreparedRequest, CachedRequest]) – Request object to normalize

• ignored_parameters (Optional[Iterable[str]]) – Request paramters, headers, and/or JSON body params to exclude

Return type:

Union[PreparedRequest, CachedRequest]

requests_cache.cache_keys.normalize_url(url, ignored_parameters)

Normalize and filter a URL. This includes request parameters, IDN domains, scheme, host, port, etc.

Parameters:

• url (str) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

str

requests_cache.cache_keys.redact_response(response, ignored_parameters)

Redact any ignored parameters (potentially containing sensitive info) from a cached request

Parameters:

• response (CachedResponse) –

• ignored_parameters (Optional[Iterable[str]]) –

Return type:

CachedResponse