cache_keys

Summary

create_key(method, url[, params, data, ...])	Create a unique cache key based on request details
encode_data(data)
encode_dict(data)
encode_json(data[, serializer])
filter_ignored_params(data, ignored_params)	Remove any ignored params from an object, if it's dict-like
hash_parts(parts)
normalize_url_params(url[, params])	Normalize any combination of request parameter formats that aiohttp accepts

Module Contents

Functions for creating keys used for cache requests

create_key(method, url, params=None, data=None, json=None, headers=None, include_headers=False, ignored_params=None, json_serialize=<function dumps>, **kwargs)

Create a unique cache key based on request details

Parameters:

• method (str)

• url (Union[str, URL])

• params (Mapping | Sequence | str | None)

• data (dict | None)

• json (dict | None)

• headers (dict | None)

• include_headers (bool)

• ignored_params (Iterable[str] | None)

• json_serialize (Callable[[Any], str | bytes])

Return type:

str

encode_data(data)

Parameters:

data (Any)

Return type:

tuple[bytes, bytes | memoryview]

encode_dict(data)

Parameters:

data (Any)

Return type:

bytes

encode_json(data, serializer=<function dumps>)

Parameters:

• data (Any)

• serializer (Callable[[Any], str | bytes])

Return type:

bytes

filter_ignored_params(data, ignored_params)

Remove any ignored params from an object, if it’s dict-like

Parameters:

ignored_params (Iterable[str])

hash_parts(parts)

Parameters:

parts (Iterable[bytes | memoryview])

Return type:

bytes

normalize_url_params(url, params=None)

Normalize any combination of request parameter formats that aiohttp accepts

Parameters:

• url (Union[str, URL])

• params (Mapping | Sequence | str | None)

Return type:

URL