Qucs-S S-parameter Viewer & RF Synthesis Tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
pip._vendor.requests.models.Response Class Reference

Public Member Functions

 __init__ (self)
 
 __enter__ (self)
 
 __exit__ (self, *args)
 
 __getstate__ (self)
 
 __setstate__ (self, state)
 
 __repr__ (self)
 
 __bool__ (self)
 
 __nonzero__ (self)
 
 __iter__ (self)
 
 ok (self)
 
 is_redirect (self)
 
 is_permanent_redirect (self)
 
 next (self)
 
 apparent_encoding (self)
 
 iter_content (self, chunk_size=1, decode_unicode=False)
 
 iter_lines (self, chunk_size=ITER_CHUNK_SIZE, decode_unicode=False, delimiter=None)
 
 content (self)
 
 text (self)
 
 json (self, **kwargs)
 
 links (self)
 
 raise_for_status (self)
 
 close (self)
 

Public Attributes

 status_code
 
 headers
 
 raw
 
 url
 
 encoding
 
 history
 
 reason
 
 cookies
 
 elapsed
 
 request
 
 content
 
 text
 

Protected Attributes

 _content
 
 _content_consumed
 
 _next
 

Detailed Description

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

Member Function Documentation

◆ __bool__()

pip._vendor.requests.models.Response.__bool__ (   self)
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``.

◆ __iter__()

pip._vendor.requests.models.Response.__iter__ (   self)
Allows you to use a response as an iterator.

◆ __nonzero__()

pip._vendor.requests.models.Response.__nonzero__ (   self)
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``.

◆ apparent_encoding()

pip._vendor.requests.models.Response.apparent_encoding (   self)
The apparent encoding, provided by the charset_normalizer or chardet libraries.

◆ close()

pip._vendor.requests.models.Response.close (   self)
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.*

◆ content()

pip._vendor.requests.models.Response.content (   self)
Content of the response, in bytes.

◆ is_permanent_redirect()

pip._vendor.requests.models.Response.is_permanent_redirect (   self)
True if this Response one of the permanent versions of redirect.

◆ is_redirect()

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

◆ iter_content()

pip._vendor.requests.models.Response.iter_content (   self,
  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()

pip._vendor.requests.models.Response.iter_lines (   self,
  chunk_size = ITER_CHUNK_SIZE,
  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()

pip._vendor.requests.models.Response.json (   self,
**  kwargs 
)
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.

◆ links()

pip._vendor.requests.models.Response.links (   self)
Returns the parsed header links of the response, if any.

◆ next()

pip._vendor.requests.models.Response.next (   self)
Returns a PreparedRequest for the next request in a redirect chain, if there is one.

◆ ok()

pip._vendor.requests.models.Response.ok (   self)
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``.

◆ raise_for_status()

pip._vendor.requests.models.Response.raise_for_status (   self)
Raises :class:`HTTPError`, if one occurred.

◆ text()

pip._vendor.requests.models.Response.text (   self)
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.

The documentation for this class was generated from the following file: