response¶

Summary¶

`CachedResponse`(method, reason, status, url, ...)	A dataclass containing cached response information, used for serialization.
`CachedStreamReader`([body])	A StreamReader loaded from previously consumed response content.
`UnsupportedExpiresError`(expires)

set_response_defaults(response)

Module Contents¶

class CachedResponse(method, reason, status, url, version, body=None, content=None, links=NOTHING, cookies=NOTHING, created_at=NOTHING, encoding='utf-8', expires=None, raw_headers=NOTHING, request_raw_headers=NOTHING, real_url=None, history=NOTHING, last_used=NOTHING)¶

Bases: HeadersMixin

A dataclass containing cached response information, used for serialization. It will mostly behave the same as a aiohttp.ClientResponse that has been read, with some additional cache-related info.

Parameters:

method (str)
reason (str)
status (int)
url (Union[str, SplitResult, URL, UndefinedType])
version (str)
body (Any)
content (StreamReader | None)
links (list[tuple[str, list[tuple[str, str]]]])
cookies (SimpleCookie)
created_at (datetime)
encoding (str)
expires (datetime | None)
raw_headers (Tuple[Tuple[bytes, bytes], ...])
request_raw_headers (Tuple[Tuple[bytes, bytes], ...])
real_url (Union[str, URL])
history (tuple)
last_used (datetime)

close()¶

property closed: bool¶

property connection¶

property content: aiohttp.StreamReader¶

property content_disposition: aiohttp.ContentDisposition | None¶: Get Content-Disposition headers, if any

cookies: SimpleCookie¶

created_at: datetime¶

encoding: str¶

expires: datetime | None¶

property from_cache¶

async classmethod from_client_response(client_response, expires=None)¶

Convert a ClientResponse into a CachedResponse

Parameters:

client_response (ClientResponse)
expires (datetime | None)

get_encoding()¶

property headers: CIMultiDictProxy[str]¶: Get headers as an immutable, case-insensitive multidict from raw headers

history: tuple¶

property host: str¶

property is_expired: bool¶: Determine if this cached response is expired

async json(encoding=None, **kwargs)¶

Read and decode JSON response

Parameters:: encoding (str | None)
Return type:: dict[str, Any] | None

last_used: datetime¶

property links: MultiDictProxy¶: Convert stored links into the format returned by ClientResponse.links

method: str¶

property ok: bool¶: Returns True if status is less than 400, False if not

raise_for_status()¶

raw_headers: RawHeaders¶

async read()¶

Read response payload.

Return type:: bytes

real_url: StrOrURL¶

reason: str¶

release()¶

property request_headers: CIMultiDictProxy[str]¶: Get request headers as an immutable, case-insensitive multidict from raw headers

property request_info: aiohttp.RequestInfo¶

request_raw_headers: RawHeaders¶

reset()¶: Reset the stream reader to re-read a streamed response

async start()¶

status: int¶

async terminate()¶

async text(encoding=None, errors='strict')¶

Read response payload and decode

Parameters:

encoding (str | None)
errors (str)

Return type:

str

url: URL¶

version: str¶

async wait_for_close()¶

class CachedStreamReader(body=None)¶

Bases: StreamReader

A StreamReader loaded from previously consumed response content. This feeds cached data into the stream so it can support all the same behavior as the original stream: async iteration, chunked reads, etc.

Parameters:: body (bytes | None)

total_bytes¶

total_compressed_bytes: Optional[int]¶

exception UnsupportedExpiresError(expires)¶

Bases: Exception

Parameters:: expires (datetime)

set_response_defaults(response)¶