Response

class requests_cache.models.response.CachedResponse(content=None, next=None, cookies=NOTHING, created_at=NOTHING, elapsed=NOTHING, encoding=None, expires=None, headers=NOTHING, history=NOTHING, raw=NOTHING, reason=None, request=NOTHING, status_code=0, url=None)[source]

Bases: requests.Response

A class that emulates requests.Response, with some additional optimizations for serialization.

Parameters
property apparent_encoding

The apparent encoding, provided by the charset_normalizer or chardet libraries.

cache_key = None
close()

Releases the connection back to the pool. Once this method has been called the underlying raw object must not be accessed again.

Note: Should not normally need to be called explicitly.

property content

Content of the response, in bytes.

cookies

A CookieJar of Cookies the server sent back.

created_at
elapsed

The amount of time elapsed between sending the request and the arrival of the response (as a timedelta). This property specifically measures the time taken between sending the first byte of the request and finishing parsing the headers. It is therefore unaffected by consuming the response content or the value of the stream keyword argument.

encoding

Encoding to decode with when accessing r.text.

expires
property from_cache
Return type

bool

classmethod from_response(original_response, expires=None, **kwargs)[source]

Create a CachedResponse based on an original Response or another CachedResponse object

Parameters
headers

Case-insensitive Dictionary of Response Headers. For example, headers['content-encoding'] will return the value of a 'Content-Encoding' response header.

history

A list of Response objects from the history of the Request. Any redirect responses will end up here. The list is sorted from the oldest to the most recent request.

property is_expired

Determine if this cached response is expired

Return type

bool

property is_permanent_redirect

True if this Response one of the permanent versions of redirect.

property is_redirect

True if this Response is a well-formed HTTP redirect that could have been processed automatically (by Session.resolve_redirects()).

iter_content(chunk_size=1, decode_unicode=False)

Iterates over the response data. When stream=True is set on the request, this avoids reading the content at once into memory for large responses. The chunk size is the number of bytes it should read into memory. This is not necessarily the length of each item returned as decoding can take place.

chunk_size must be of type int or None. A value of None will function differently depending on the value of stream. stream=True will read data as it arrives in whatever size the chunks are received. If stream=False, data is returned as a single chunk.

If decode_unicode is True, content will be decoded using the best available encoding based on the response.

iter_lines(chunk_size=512, decode_unicode=False, delimiter=None)

Iterates over the response data, one line at a time. When stream=True is set on the request, this avoids reading the content at once into memory for large responses.

Note

This method is not reentrant safe.

json(**kwargs)

Returns the json-encoded content of a response, if any.

Parameters

**kwargs – Optional arguments that json.loads takes.

Raises
  • simplejson.JSONDecodeError – If the response body does not contain valid json and simplejson is installed.

  • json.JSONDecodeError – If the response body does not contain valid json and simplejson is not installed on Python 3.

  • ValueError – If the response body does not contain valid json and simplejson is not installed on Python 2.

Returns the parsed header links of the response, if any.

property next

Returns a PreparedRequest for the next request in a redirect chain, if there is one.

Return type

Optional[PreparedRequest]

property ok

Returns True if status_code is less than 400, False if not.

This attribute checks if the status code of the response is between 400 and 600 to see if there was a client error or a server error. If the status code is between 200 and 400, this will return True. This is not a check to see if the response code is 200 OK.

raise_for_status()

Raises HTTPError, if one occurred.

raw

File-like object representation of response (for advanced usage). Use of raw requires that stream=True be set on the request. This requirement does not apply for use internally to Requests.

reason

Textual reason of responded HTTP Status, e.g. “Not Found” or “OK”.

request

The PreparedRequest object to which this is a response.

revalidate(expire_after)[source]

Set a new expiration for this response, and determine if it is now expired

Parameters

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

Return type

bool

property size

Get the size of the response body in bytes

Return type

int

status_code

Integer Code of responded HTTP Status, e.g. 404 or 200.

property text

Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed using charset_normalizer or chardet.

The encoding of the response content is determined based solely on HTTP headers, following RFC 2616 to the letter. If you can take advantage of non-HTTP knowledge to make a better guess at the encoding, you should set r.encoding appropriately before accessing this property.

property ttl

Get time to expiration in seconds

Return type

Optional[int]

url

Final URL location of Response.

requests_cache.models.response.format_datetime(value)[source]

Get a formatted datetime string in the local time zone

Parameters

value (Optional[datetime]) –

Return type

str

requests_cache.models.response.format_file_size(n_bytes)[source]

Convert a file size in bytes into a human-readable format

Parameters

n_bytes (int) –

Return type

str

requests_cache.models.response.set_response_defaults(response, cache_key=None)[source]

Set some default CachedResponse values on a requests.Response object, so they can be expected to always be present

Parameters
Return type

Union[Response, CachedResponse]