response¶
Summary¶
|
A dataclass containing cached response information, used for serialization. |
|
A StreamReader loaded from previously consumed response content. |
|
Set some default CachedResponse values on a ClientResponse object, so they can be expected to always be present |
Module Contents¶
- class CachedResponse(method, reason, status, url, version, body=b'', content=None, links=NOTHING, cookies=None, created_at=NOTHING, encoding='utf-8', expires=None, raw_headers=NOTHING, real_url=None, history=NOTHING, last_used=NOTHING)¶
Bases:
object
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 (yarl.URL) –
version (str) –
body (Any) –
content (
aiohttp.StreamReader
) –cookies (http.cookies.SimpleCookie) –
created_at (datetime.datetime) –
encoding (str) –
expires (Optional[datetime.datetime]) –
real_url (Union[str, yarl.URL]) –
history (Iterable) –
last_used (datetime.datetime) –
- Return type
- _body¶
- _content¶
- _links¶
- property _released¶
- async close()¶
- property connection¶
- property content: aiohttp.streams.StreamReader¶
- Return type
- property content_disposition: Optional[aiohttp.client_reqrep.ContentDisposition]¶
Get Content-Disposition headers, if any
- Return type
- cookies¶
- created_at¶
- encoding¶
- expires¶
- property from_cache¶
- async classmethod from_client_response(client_response, expires=None)¶
Convert a ClientResponse into a CachedReponse
- Parameters
client_response (
aiohttp.ClientResponse
) –expires (Optional[datetime.datetime]) –
- get_encoding()¶
- property headers: multidict._multidict.CIMultiDictProxy¶
Get headers as an immutable, case-insensitive multidict from raw headers
- Return type
CIMultiDictProxy
- history¶
- async json(encoding=None, **kwargs)¶
Read and decode JSON response
- last_used¶
- property links: multidict._multidict.MultiDictProxy¶
Convert stored links into the format returned by
ClientResponse.links
- Return type
MultiDictProxy
- method¶
- raise_for_status()¶
- raw_headers¶
- real_url¶
- reason¶
- release()¶
- property request_info: aiohttp.client_reqrep.RequestInfo¶
- Return type
- reset()¶
Reset the stream reader to re-read a streamed response
- async start()¶
- status¶
- async terminate()¶
- async text(encoding=None, errors='strict')¶
Read response payload and decode
- url¶
- version¶
- async wait_for_close()¶
- class CachedStreamReader(body=None)¶
Bases:
aiohttp.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) –
- set_response_defaults(response)¶
Set some default CachedResponse values on a ClientResponse object, so they can be expected to always be present
- Return type
- Parameters
response (Union[
aiohttp.ClientResponse
, aiohttp_client_cache.response.CachedResponse]) –