pip._vendor.requests.models.Response Class Reference

Inheritance diagram for pip._vendor.requests.models.Response:

Public Member Functions
def	__init__
def	__getstate__
def	__setstate__
def	__repr__
def	__bool__
def	__nonzero__
def	__iter__
def	ok
def	is_redirect
def	apparent_encoding
def	iter_content
def	iter_lines
def	content
def	text
def	json
def	links
def	raise_for_status
def	close

Public Attributes
	status_code
	headers
	raw
	url
	encoding
	history
	reason
	cookies
	elapsed

Private Attributes
	_content
	_content_consumed

Static Private Attributes
list	__attrs__

Detailed Description

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

Constructor & Destructor Documentation

def pip._vendor.requests.models.Response.__init__

(

self

)

Member Function Documentation

def pip._vendor.requests.models.Response.__bool__

(

self

)

Returns true if :attr:`status_code` is 'OK'.

def pip._vendor.requests.models.Response.__getstate__

(

self

)

def pip._vendor.requests.models.Response.__iter__

(

self

)

Allows you to use a response as an iterator.

def pip._vendor.requests.models.Response.__nonzero__

(

self

)

Returns true if :attr:`status_code` is 'OK'.

def pip._vendor.requests.models.Response.__repr__

(

self

)

def pip._vendor.requests.models.Response.__setstate__	(		self,
			state
	)

def pip._vendor.requests.models.Response.apparent_encoding

(

self

)

The apparent encoding, provided by the chardet library

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

def pip._vendor.requests.models.Response.content

(

self

)

Content of the response, in bytes.

def 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`).

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

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

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

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

def pip._vendor.requests.models.Response.links

(

self

)

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

def pip._vendor.requests.models.Response.ok

(

self

)

def pip._vendor.requests.models.Response.raise_for_status

(

self

)

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

def pip._vendor.requests.models.Response.text

(

self

)

Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed using
``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.

Member Data Documentation

list pip._vendor.requests.models.Response.__attrs__

staticprivate

Initial value:

= [
        '_content',
        'status_code',
        'headers',
        'url',
        'history',
        'encoding',
        'reason',
        'cookies',
        'elapsed',
        'request',
    ]

pip._vendor.requests.models.Response._content

private

pip._vendor.requests.models.Response._content_consumed

private

pip._vendor.requests.models.Response.cookies

pip._vendor.requests.models.Response.elapsed

pip._vendor.requests.models.Response.encoding

pip._vendor.requests.models.Response.headers

pip._vendor.requests.models.Response.history

pip._vendor.requests.models.Response.raw

pip._vendor.requests.models.Response.reason

pip._vendor.requests.models.Response.status_code

pip._vendor.requests.models.Response.url

---

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

• orbits/lib/python2.7/site-packages/pip/_vendor/requests/models.py