requests.models.Response

class documentation

class Response: (source)

View In Hierarchy

The :class:`Response <Response>` object, which contains a server's response to an HTTP request.

Method __bool__ Returns True if :attr:`status_code` is less than 400.
Method __enter__ Undocumented
Method __exit__ Undocumented
Method __getstate__ Undocumented
Method __init__ Undocumented
Method __iter__ Allows you to use a response as an iterator.
Method __nonzero__ Returns True if :attr:`status_code` is less than 400.
Method __repr__ Undocumented
Method __setstate__ Undocumented
Method close Releases the connection back to the pool. Once this method has been called the underlying ``raw`` object must not be accessed again.
Method iter_content 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...
Method iter_lines 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.
Method json Returns the json-encoded content of a response, if any.
Method raise_for_status Raises :class:`HTTPError`, if one occurred.
Class Variable __attrs__ Undocumented
Instance Variable cookies Undocumented
Instance Variable elapsed Undocumented
Instance Variable encoding Undocumented
Instance Variable headers Undocumented
Instance Variable history Undocumented
Instance Variable raw Undocumented
Instance Variable reason Undocumented
Instance Variable request Undocumented
Instance Variable status_code Undocumented
Instance Variable url Undocumented
Property apparent_encoding The apparent encoding, provided by the charset_normalizer or chardet libraries.
Property content Content of the response, in bytes.
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 :meth:`Session.resolve_redirects`).
Property links 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.
Property ok Returns True if :attr:`status_code` is less than 400, False if not.
Property text Content of the response, in unicode.
Instance Variable _content Undocumented
Instance Variable _content_consumed Undocumented
Instance Variable _next Undocumented
def __bool__(self): (source)

Returns True if :attr:`status_code` is less than 400. 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``.

def __enter__(self): (source)

Undocumented

def __exit__(self, *args): (source)

Undocumented

def __getstate__(self): (source)

Undocumented

def __init__(self): (source)

Undocumented

def __iter__(self): (source)

Allows you to use a response as an iterator.

def __nonzero__(self): (source)

Returns True if :attr:`status_code` is less than 400. 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``.

def __repr__(self): (source)

Undocumented

def __setstate__(self, state): (source)

Undocumented

def close(self): (source)

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.*

def iter_content(self, chunk_size=1, decode_unicode=False): (source)

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.

def iter_lines(self, chunk_size=ITER_CHUNK_SIZE, decode_unicode=False, delimiter=None): (source)

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.

def json(self, **kwargs): (source)

Returns the json-encoded content of a response, if any. :param \*\*kwargs: Optional arguments that ``json.loads`` takes. :raises requests.exceptions.JSONDecodeError: If the response body does not contain valid json.

def raise_for_status(self): (source)

Raises :class:`HTTPError`, if one occurred.

__attrs__: list[str] = (source)

Undocumented

cookies = (source)

Undocumented

elapsed = (source)

Undocumented

encoding = (source)

Undocumented

headers = (source)

Undocumented

history: list = (source)

Undocumented

raw = (source)

Undocumented

reason = (source)

Undocumented

request = (source)

Undocumented

status_code = (source)

Undocumented

url = (source)

Undocumented

@property
apparent_encoding = (source)

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

@property
content = (source)

Content of the response, in bytes.

@property
is_permanent_redirect = (source)

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

@property
is_redirect = (source)

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

@property
links = (source)

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

@property
next = (source)

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

@property
ok = (source)

Returns True if :attr:`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``.

@property
text = (source)

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.

_content: bool = (source)

Undocumented

_content_consumed: bool = (source)

Undocumented

_next = (source)

Undocumented