session

Summary

CacheMixin([base_url, cache])	A mixin class for aiohttp.ClientSession that adds caching support
CachedSession([base_url, cache])	A drop-in replacement for aiohttp.ClientSession that adds caching support

Module Contents

class CachedSession(base_url=None, *, cache=None, **kwargs)

Bases: CacheMixin, ClientSession

A drop-in replacement for aiohttp.ClientSession that adds caching support

Parameters:

• cache (CacheBackend | None) – A cache backend object. See aiohttp_client_cache.backends for options. If not provided, an in-memory cache will be used.

• base_url (Union[str, URL, None])

• connector (aiohttp.BaseConnector | None)

• loop (AbstractEventLoop | None)

• cookies (Mapping[str, str | BaseCookie[str] | Morsel[Any]] | Iterable[Tuple[str, str | BaseCookie[str] | Morsel[Any]]] | BaseCookie[str] | None)

• headers (Mapping[str, str] | Mapping[istr, str] | CIMultiDict | CIMultiDictProxy | Iterable[Tuple[str | istr, str]] | None)

• proxy (str | URL | None)

• proxy_auth (aiohttp.BasicAuth | None)

• skip_auto_headers (Iterable[str] | None)

• auth (aiohttp.BasicAuth | None)

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

• request_class (Type[aiohttp.ClientRequest])

• response_class (Type[aiohttp.ClientResponse])

• ws_response_class (Type[aiohttp.ClientWebSocketResponse])

• version (HttpVersion)

• cookie_jar (AbstractCookieJar | None)

• connector_owner (bool)

• raise_for_status (bool | Callable[[aiohttp.ClientResponse], Awaitable[None]])

• read_timeout (float | _SENTINEL)

• conn_timeout (float | None)

• timeout (object | aiohttp.ClientTimeout)

• auto_decompress (bool)

• trust_env (bool)

• requote_redirect_url (bool)

• trace_configs (List[aiohttp.TraceConfig] | None)

• read_bufsize (int)

• max_line_size (int)

• max_field_size (int)

• fallback_charset_resolver (Callable[[aiohttp.ClientResponse, bytes], str])

• middlewares (Sequence[Callable[[aiohttp.ClientRequest, Callable[[aiohttp.ClientRequest], Awaitable[aiohttp.ClientResponse]]], Awaitable[aiohttp.ClientResponse]]])

• ssl_shutdown_timeout (_SENTINEL | None | float)

async _request(method, str_or_url, expire_after=None, refresh=False, **kwargs)

Wrapper around SessionClient._request() that adds caching

Args:

Parameters:

• method (str)

• str_or_url (Union[str, URL])

• expire_after (Union[None, int, float, str, datetime, timedelta])

• refresh (bool)

• params (None | str | Mapping[str, str | SupportsInt | float | Sequence[str | SupportsInt | float]] | Sequence[tuple[str, str | SupportsInt | float | Sequence[str | SupportsInt | float]]])

• data (Any)

• json (Any)

• cookies (Mapping[str, str | BaseCookie[str] | Morsel[Any]] | Iterable[Tuple[str, str | BaseCookie[str] | Morsel[Any]]] | BaseCookie[str] | None)

• headers (Mapping[str, str] | Mapping[istr, str] | CIMultiDict | CIMultiDictProxy | Iterable[Tuple[str | istr, str]] | None)

• skip_auto_headers (Iterable[str] | None)

• auth (aiohttp.BasicAuth | None)

• allow_redirects (bool)

• max_redirects (int)

• compress (str | bool | None)

• chunked (bool | None)

• expect100 (bool)

• raise_for_status (None | bool | Callable[[aiohttp.ClientResponse], Awaitable[None]])

• read_until_eof (bool)

• proxy (str | URL | None)

• proxy_auth (aiohttp.BasicAuth | None)

• timeout (aiohttp.ClientTimeout | _SENTINEL)

• verify_ssl (bool | None)

• fingerprint (bytes | None)

• ssl_context (None)

• ssl (None | bool | aiohttp.Fingerprint)

• server_hostname (str | None)

• proxy_headers (Mapping[str, str] | Mapping[istr, str] | CIMultiDict | CIMultiDictProxy | Iterable[Tuple[str | istr, str]] | None)

• trace_request_ctx (Mapping[str, Any] | None)

• read_bufsize (int | None)

• auto_decompress (bool | None)

• max_line_size (int | None)

• max_field_size (int | None)

• middlewares (Sequence[Callable[[aiohttp.ClientRequest, Callable[[aiohttp.ClientRequest], Awaitable[aiohttp.ClientResponse]]], Awaitable[aiohttp.ClientResponse]]] | None)

Return type:

CachedResponse

async delete_expired_responses()

Remove all expired responses from the cache

disabled()

Temporarily disable the cache

Example

>>> async with CachedSession() as session:
>>>     await session.get('http://httpbin.org/ip')
>>>     async with session.disabled():
>>>         # Will return a new response, not a cached one
>>>         await session.get('http://httpbin.org/ip')

class CacheMixin(base_url=None, *, cache=None, **kwargs)

A mixin class for aiohttp.ClientSession that adds caching support

Parameters:

• base_url (Union[str, URL, None])

• cache (CacheBackend | None)

• connector (aiohttp.BaseConnector | None)

• loop (AbstractEventLoop | None)

• cookies (Mapping[str, str | BaseCookie[str] | Morsel[Any]] | Iterable[Tuple[str, str | BaseCookie[str] | Morsel[Any]]] | BaseCookie[str] | None)

• headers (Mapping[str, str] | Mapping[istr, str] | CIMultiDict | CIMultiDictProxy | Iterable[Tuple[str | istr, str]] | None)

• proxy (str | URL | None)

• proxy_auth (aiohttp.BasicAuth | None)

• skip_auto_headers (Iterable[str] | None)

• auth (aiohttp.BasicAuth | None)

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

• request_class (Type[aiohttp.ClientRequest])

• response_class (Type[aiohttp.ClientResponse])

• ws_response_class (Type[aiohttp.ClientWebSocketResponse])

• version (HttpVersion)

• cookie_jar (AbstractCookieJar | None)

• connector_owner (bool)

• raise_for_status (bool | Callable[[aiohttp.ClientResponse], Awaitable[None]])

• read_timeout (float | _SENTINEL)

• conn_timeout (float | None)

• timeout (object | aiohttp.ClientTimeout)

• auto_decompress (bool)

• trust_env (bool)

• requote_redirect_url (bool)

• trace_configs (List[aiohttp.TraceConfig] | None)

• read_bufsize (int)

• max_line_size (int)

• max_field_size (int)

• fallback_charset_resolver (Callable[[aiohttp.ClientResponse, bytes], str])

• middlewares (Sequence[Callable[[aiohttp.ClientRequest, Callable[[aiohttp.ClientRequest], Awaitable[aiohttp.ClientResponse]]], Awaitable[aiohttp.ClientResponse]]])

• ssl_shutdown_timeout (_SENTINEL | None | float)