2
# Copyright 2008-2013 Andrey Petrov and contributors (see CONTRIBUTORS.txt)
4
# This module is part of urllib3 and is released under
5
# the MIT License: http://www.opensource.org/licenses/mit-license.php
12
from ._collections import HTTPHeaderDict
13
from .exceptions import DecodeError
14
from .packages.six import string_types as basestring, binary_type
15
from .util import is_fp_closed
18
log = logging.getLogger(__name__)
21
class DeflateDecoder(object):
24
self._first_try = True
25
self._data = binary_type()
26
self._obj = zlib.decompressobj()
28
def __getattr__(self, name):
29
return getattr(self._obj, name)
31
def decompress(self, data):
32
if not self._first_try:
33
return self._obj.decompress(data)
37
return self._obj.decompress(data)
39
self._first_try = False
40
self._obj = zlib.decompressobj(-zlib.MAX_WBITS)
42
return self.decompress(self._data)
47
def _get_decoder(mode):
49
return zlib.decompressobj(16 + zlib.MAX_WBITS)
51
return DeflateDecoder()
54
class HTTPResponse(io.IOBase):
56
HTTP Response container.
58
Backwards-compatible to httplib's HTTPResponse but the response ``body`` is
59
loaded and decoded on-demand when the ``data`` property is accessed.
61
Extra parameters for behaviour not present in httplib.HTTPResponse:
63
:param preload_content:
64
If True, the response's body will be preloaded during construction.
66
:param decode_content:
67
If True, attempts to decode specific content-encoding's based on headers
68
(like 'gzip' and 'deflate') will be skipped and raw data will be used
71
:param original_response:
72
When this HTTPResponse wrapper is generated from an httplib.HTTPResponse
73
object, it's convenient to include the original for debug purposes. It's
77
CONTENT_DECODERS = ['gzip', 'deflate']
78
REDIRECT_STATUSES = [301, 302, 303, 307, 308]
80
def __init__(self, body='', headers=None, status=0, version=0, reason=None,
81
strict=0, preload_content=True, decode_content=True,
82
original_response=None, pool=None, connection=None):
84
self.headers = HTTPHeaderDict()
86
self.headers.update(headers)
88
self.version = version
91
self.decode_content = decode_content
94
self._body = body if body and isinstance(body, basestring) else None
96
self._original_response = original_response
97
self._fp_bytes_read = 0
100
self._connection = connection
102
if hasattr(body, 'read'):
105
if preload_content and not self._body:
106
self._body = self.read(decode_content=decode_content)
108
def get_redirect_location(self):
110
Should we redirect and where to?
112
:returns: Truthy redirect location string if we got a redirect status
113
code and valid location. ``None`` if redirect status and no
114
location. ``False`` if not a redirect status code.
116
if self.status in self.REDIRECT_STATUSES:
117
return self.headers.get('location')
121
def release_conn(self):
122
if not self._pool or not self._connection:
125
self._pool._put_conn(self._connection)
126
self._connection = None
130
# For backwords-compat with earlier urllib3 0.4 and earlier.
135
return self.read(cache_content=True)
139
Obtain the number of bytes pulled over the wire so far. May differ from
140
the amount of content returned by :meth:``HTTPResponse.read`` if bytes
141
are encoded on the wire (e.g, compressed).
143
return self._fp_bytes_read
145
def read(self, amt=None, decode_content=None, cache_content=False):
147
Similar to :meth:`httplib.HTTPResponse.read`, but with two additional
148
parameters: ``decode_content`` and ``cache_content``.
151
How much of the content to read. If specified, caching is skipped
152
because it doesn't make sense to cache partial content as the full
155
:param decode_content:
156
If True, will attempt to decode the body based on the
157
'content-encoding' header.
159
:param cache_content:
160
If True, will save the returned data such that the same result is
161
returned despite of the state of the underlying file object. This
162
is useful if you want the ``.data`` property to continue working
163
after having ``.read()`` the file object. (Overridden if ``amt`` is
166
# Note: content-encoding value should be case-insensitive, per RFC 2616
168
content_encoding = self.headers.get('content-encoding', '').lower()
169
if self._decoder is None:
170
if content_encoding in self.CONTENT_DECODERS:
171
self._decoder = _get_decoder(content_encoding)
172
if decode_content is None:
173
decode_content = self.decode_content
178
flush_decoder = False
182
# cStringIO doesn't like amt=None
183
data = self._fp.read()
186
cache_content = False
187
data = self._fp.read(amt)
188
if amt != 0 and not data: # Platform-specific: Buggy versions of Python.
189
# Close the connection when no data is returned
191
# This is redundant to what httplib/http.client _should_
192
# already do. However, versions of python released before
193
# December 15, 2012 (http://bugs.python.org/issue16298) do not
194
# properly close the connection in all cases. There is no harm
195
# in redundantly calling close.
199
self._fp_bytes_read += len(data)
202
if decode_content and self._decoder:
203
data = self._decoder.decompress(data)
204
except (IOError, zlib.error) as e:
206
"Received response with content-encoding: %s, but "
207
"failed to decode it." % content_encoding,
210
if flush_decoder and decode_content and self._decoder:
211
buf = self._decoder.decompress(binary_type())
212
data += buf + self._decoder.flush()
220
if self._original_response and self._original_response.isclosed():
223
def stream(self, amt=2**16, decode_content=None):
225
A generator wrapper for the read() method. A call will block until
226
``amt`` bytes have been read from the connection or until the
227
connection is closed.
230
How much of the content to read. The generator will return up to
231
much data per iteration, but may return less. This is particularly
232
likely when using compressed data. However, the empty string will
235
:param decode_content:
236
If True, will attempt to decode the body based on the
237
'content-encoding' header.
239
while not is_fp_closed(self._fp):
240
data = self.read(amt=amt, decode_content=decode_content)
247
def from_httplib(ResponseCls, r, **response_kw):
249
Given an :class:`httplib.HTTPResponse` instance ``r``, return a
250
corresponding :class:`urllib3.response.HTTPResponse` object.
252
Remaining parameters are passed to the HTTPResponse constructor, along
253
with ``original_response=r``.
256
headers = HTTPHeaderDict()
257
for k, v in r.getheaders():
260
# HTTPResponse objects in Python 3 don't have a .strict attribute
261
strict = getattr(r, 'strict', 0)
262
return ResponseCls(body=r,
271
# Backwards-compatibility methods for httplib.HTTPResponse
272
def getheaders(self):
275
def getheader(self, name, default=None):
276
return self.headers.get(name, default)
278
# Overrides from io.IOBase
287
elif hasattr(self._fp, 'closed'):
288
return self._fp.closed
289
elif hasattr(self._fp, 'isclosed'): # Python 2
290
return self._fp.isclosed()
296
raise IOError("HTTPResponse has no file to get a fileno from")
297
elif hasattr(self._fp, "fileno"):
298
return self._fp.fileno()
300
raise IOError("The file-like object this HTTPResponse is wrapped "
301
"around has no file descriptor")
304
if self._fp is not None and hasattr(self._fp, 'flush'):
305
return self._fp.flush()
added
removed
pylib/requests/packages/urllib3/response.py
