models.py 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966
  1. # -*- coding: utf-8 -*-
  2. """
  3. requests.models
  4. ~~~~~~~~~~~~~~~
  5. This module contains the primary objects that power Requests.
  6. """
  7. import datetime
  8. import sys
  9. # Import encoding now, to avoid implicit import later.
  10. # Implicit import within threads may cause LookupError when standard library is in a ZIP,
  11. # such as in Embedded Python. See https://github.com/psf/requests/issues/3578.
  12. import encodings.idna
  13. from pip._vendor.urllib3.fields import RequestField
  14. from pip._vendor.urllib3.filepost import encode_multipart_formdata
  15. from pip._vendor.urllib3.util import parse_url
  16. from pip._vendor.urllib3.exceptions import (
  17. DecodeError, ReadTimeoutError, ProtocolError, LocationParseError)
  18. from io import UnsupportedOperation
  19. from .hooks import default_hooks
  20. from .structures import CaseInsensitiveDict
  21. from .auth import HTTPBasicAuth
  22. from .cookies import cookiejar_from_dict, get_cookie_header, _copy_cookie_jar
  23. from .exceptions import (
  24. HTTPError, MissingSchema, InvalidURL, ChunkedEncodingError,
  25. ContentDecodingError, ConnectionError, StreamConsumedError, InvalidJSONError)
  26. from ._internal_utils import to_native_string, unicode_is_ascii
  27. from .utils import (
  28. guess_filename, get_auth_from_url, requote_uri,
  29. stream_decode_response_unicode, to_key_val_list, parse_header_links,
  30. iter_slices, guess_json_utf, super_len, check_header_validity)
  31. from .compat import (
  32. Callable, Mapping,
  33. cookielib, urlunparse, urlsplit, urlencode, str, bytes,
  34. is_py2, chardet, builtin_str, basestring)
  35. from .compat import json as complexjson
  36. from .status_codes import codes
  37. #: The set of HTTP status codes that indicate an automatically
  38. #: processable redirect.
  39. REDIRECT_STATI = (
  40. codes.moved, # 301
  41. codes.found, # 302
  42. codes.other, # 303
  43. codes.temporary_redirect, # 307
  44. codes.permanent_redirect, # 308
  45. )
  46. DEFAULT_REDIRECT_LIMIT = 30
  47. CONTENT_CHUNK_SIZE = 10 * 1024
  48. ITER_CHUNK_SIZE = 512
  49. class RequestEncodingMixin(object):
  50. @property
  51. def path_url(self):
  52. """Build the path URL to use."""
  53. url = []
  54. p = urlsplit(self.url)
  55. path = p.path
  56. if not path:
  57. path = '/'
  58. url.append(path)
  59. query = p.query
  60. if query:
  61. url.append('?')
  62. url.append(query)
  63. return ''.join(url)
  64. @staticmethod
  65. def _encode_params(data):
  66. """Encode parameters in a piece of data.
  67. Will successfully encode parameters when passed as a dict or a list of
  68. 2-tuples. Order is retained if data is a list of 2-tuples but arbitrary
  69. if parameters are supplied as a dict.
  70. """
  71. if isinstance(data, (str, bytes)):
  72. return data
  73. elif hasattr(data, 'read'):
  74. return data
  75. elif hasattr(data, '__iter__'):
  76. result = []
  77. for k, vs in to_key_val_list(data):
  78. if isinstance(vs, basestring) or not hasattr(vs, '__iter__'):
  79. vs = [vs]
  80. for v in vs:
  81. if v is not None:
  82. result.append(
  83. (k.encode('utf-8') if isinstance(k, str) else k,
  84. v.encode('utf-8') if isinstance(v, str) else v))
  85. return urlencode(result, doseq=True)
  86. else:
  87. return data
  88. @staticmethod
  89. def _encode_files(files, data):
  90. """Build the body for a multipart/form-data request.
  91. Will successfully encode files when passed as a dict or a list of
  92. tuples. Order is retained if data is a list of tuples but arbitrary
  93. if parameters are supplied as a dict.
  94. The tuples may be 2-tuples (filename, fileobj), 3-tuples (filename, fileobj, contentype)
  95. or 4-tuples (filename, fileobj, contentype, custom_headers).
  96. """
  97. if (not files):
  98. raise ValueError("Files must be provided.")
  99. elif isinstance(data, basestring):
  100. raise ValueError("Data must not be a string.")
  101. new_fields = []
  102. fields = to_key_val_list(data or {})
  103. files = to_key_val_list(files or {})
  104. for field, val in fields:
  105. if isinstance(val, basestring) or not hasattr(val, '__iter__'):
  106. val = [val]
  107. for v in val:
  108. if v is not None:
  109. # Don't call str() on bytestrings: in Py3 it all goes wrong.
  110. if not isinstance(v, bytes):
  111. v = str(v)
  112. new_fields.append(
  113. (field.decode('utf-8') if isinstance(field, bytes) else field,
  114. v.encode('utf-8') if isinstance(v, str) else v))
  115. for (k, v) in files:
  116. # support for explicit filename
  117. ft = None
  118. fh = None
  119. if isinstance(v, (tuple, list)):
  120. if len(v) == 2:
  121. fn, fp = v
  122. elif len(v) == 3:
  123. fn, fp, ft = v
  124. else:
  125. fn, fp, ft, fh = v
  126. else:
  127. fn = guess_filename(v) or k
  128. fp = v
  129. if isinstance(fp, (str, bytes, bytearray)):
  130. fdata = fp
  131. elif hasattr(fp, 'read'):
  132. fdata = fp.read()
  133. elif fp is None:
  134. continue
  135. else:
  136. fdata = fp
  137. rf = RequestField(name=k, data=fdata, filename=fn, headers=fh)
  138. rf.make_multipart(content_type=ft)
  139. new_fields.append(rf)
  140. body, content_type = encode_multipart_formdata(new_fields)
  141. return body, content_type
  142. class RequestHooksMixin(object):
  143. def register_hook(self, event, hook):
  144. """Properly register a hook."""
  145. if event not in self.hooks:
  146. raise ValueError('Unsupported event specified, with event name "%s"' % (event))
  147. if isinstance(hook, Callable):
  148. self.hooks[event].append(hook)
  149. elif hasattr(hook, '__iter__'):
  150. self.hooks[event].extend(h for h in hook if isinstance(h, Callable))
  151. def deregister_hook(self, event, hook):
  152. """Deregister a previously registered hook.
  153. Returns True if the hook existed, False if not.
  154. """
  155. try:
  156. self.hooks[event].remove(hook)
  157. return True
  158. except ValueError:
  159. return False
  160. class Request(RequestHooksMixin):
  161. """A user-created :class:`Request <Request>` object.
  162. Used to prepare a :class:`PreparedRequest <PreparedRequest>`, which is sent to the server.
  163. :param method: HTTP method to use.
  164. :param url: URL to send.
  165. :param headers: dictionary of headers to send.
  166. :param files: dictionary of {filename: fileobject} files to multipart upload.
  167. :param data: the body to attach to the request. If a dictionary or
  168. list of tuples ``[(key, value)]`` is provided, form-encoding will
  169. take place.
  170. :param json: json for the body to attach to the request (if files or data is not specified).
  171. :param params: URL parameters to append to the URL. If a dictionary or
  172. list of tuples ``[(key, value)]`` is provided, form-encoding will
  173. take place.
  174. :param auth: Auth handler or (user, pass) tuple.
  175. :param cookies: dictionary or CookieJar of cookies to attach to this request.
  176. :param hooks: dictionary of callback hooks, for internal usage.
  177. Usage::
  178. >>> import requests
  179. >>> req = requests.Request('GET', 'https://httpbin.org/get')
  180. >>> req.prepare()
  181. <PreparedRequest [GET]>
  182. """
  183. def __init__(self,
  184. method=None, url=None, headers=None, files=None, data=None,
  185. params=None, auth=None, cookies=None, hooks=None, json=None):
  186. # Default empty dicts for dict params.
  187. data = [] if data is None else data
  188. files = [] if files is None else files
  189. headers = {} if headers is None else headers
  190. params = {} if params is None else params
  191. hooks = {} if hooks is None else hooks
  192. self.hooks = default_hooks()
  193. for (k, v) in list(hooks.items()):
  194. self.register_hook(event=k, hook=v)
  195. self.method = method
  196. self.url = url
  197. self.headers = headers
  198. self.files = files
  199. self.data = data
  200. self.json = json
  201. self.params = params
  202. self.auth = auth
  203. self.cookies = cookies
  204. def __repr__(self):
  205. return '<Request [%s]>' % (self.method)
  206. def prepare(self):
  207. """Constructs a :class:`PreparedRequest <PreparedRequest>` for transmission and returns it."""
  208. p = PreparedRequest()
  209. p.prepare(
  210. method=self.method,
  211. url=self.url,
  212. headers=self.headers,
  213. files=self.files,
  214. data=self.data,
  215. json=self.json,
  216. params=self.params,
  217. auth=self.auth,
  218. cookies=self.cookies,
  219. hooks=self.hooks,
  220. )
  221. return p
  222. class PreparedRequest(RequestEncodingMixin, RequestHooksMixin):
  223. """The fully mutable :class:`PreparedRequest <PreparedRequest>` object,
  224. containing the exact bytes that will be sent to the server.
  225. Instances are generated from a :class:`Request <Request>` object, and
  226. should not be instantiated manually; doing so may produce undesirable
  227. effects.
  228. Usage::
  229. >>> import requests
  230. >>> req = requests.Request('GET', 'https://httpbin.org/get')
  231. >>> r = req.prepare()
  232. >>> r
  233. <PreparedRequest [GET]>
  234. >>> s = requests.Session()
  235. >>> s.send(r)
  236. <Response [200]>
  237. """
  238. def __init__(self):
  239. #: HTTP verb to send to the server.
  240. self.method = None
  241. #: HTTP URL to send the request to.
  242. self.url = None
  243. #: dictionary of HTTP headers.
  244. self.headers = None
  245. # The `CookieJar` used to create the Cookie header will be stored here
  246. # after prepare_cookies is called
  247. self._cookies = None
  248. #: request body to send to the server.
  249. self.body = None
  250. #: dictionary of callback hooks, for internal usage.
  251. self.hooks = default_hooks()
  252. #: integer denoting starting position of a readable file-like body.
  253. self._body_position = None
  254. def prepare(self,
  255. method=None, url=None, headers=None, files=None, data=None,
  256. params=None, auth=None, cookies=None, hooks=None, json=None):
  257. """Prepares the entire request with the given parameters."""
  258. self.prepare_method(method)
  259. self.prepare_url(url, params)
  260. self.prepare_headers(headers)
  261. self.prepare_cookies(cookies)
  262. self.prepare_body(data, files, json)
  263. self.prepare_auth(auth, url)
  264. # Note that prepare_auth must be last to enable authentication schemes
  265. # such as OAuth to work on a fully prepared request.
  266. # This MUST go after prepare_auth. Authenticators could add a hook
  267. self.prepare_hooks(hooks)
  268. def __repr__(self):
  269. return '<PreparedRequest [%s]>' % (self.method)
  270. def copy(self):
  271. p = PreparedRequest()
  272. p.method = self.method
  273. p.url = self.url
  274. p.headers = self.headers.copy() if self.headers is not None else None
  275. p._cookies = _copy_cookie_jar(self._cookies)
  276. p.body = self.body
  277. p.hooks = self.hooks
  278. p._body_position = self._body_position
  279. return p
  280. def prepare_method(self, method):
  281. """Prepares the given HTTP method."""
  282. self.method = method
  283. if self.method is not None:
  284. self.method = to_native_string(self.method.upper())
  285. @staticmethod
  286. def _get_idna_encoded_host(host):
  287. from pip._vendor import idna
  288. try:
  289. host = idna.encode(host, uts46=True).decode('utf-8')
  290. except idna.IDNAError:
  291. raise UnicodeError
  292. return host
  293. def prepare_url(self, url, params):
  294. """Prepares the given HTTP URL."""
  295. #: Accept objects that have string representations.
  296. #: We're unable to blindly call unicode/str functions
  297. #: as this will include the bytestring indicator (b'')
  298. #: on python 3.x.
  299. #: https://github.com/psf/requests/pull/2238
  300. if isinstance(url, bytes):
  301. url = url.decode('utf8')
  302. else:
  303. url = unicode(url) if is_py2 else str(url)
  304. # Remove leading whitespaces from url
  305. url = url.lstrip()
  306. # Don't do any URL preparation for non-HTTP schemes like `mailto`,
  307. # `data` etc to work around exceptions from `url_parse`, which
  308. # handles RFC 3986 only.
  309. if ':' in url and not url.lower().startswith('http'):
  310. self.url = url
  311. return
  312. # Support for unicode domain names and paths.
  313. try:
  314. scheme, auth, host, port, path, query, fragment = parse_url(url)
  315. except LocationParseError as e:
  316. raise InvalidURL(*e.args)
  317. if not scheme:
  318. error = ("Invalid URL {0!r}: No schema supplied. Perhaps you meant http://{0}?")
  319. error = error.format(to_native_string(url, 'utf8'))
  320. raise MissingSchema(error)
  321. if not host:
  322. raise InvalidURL("Invalid URL %r: No host supplied" % url)
  323. # In general, we want to try IDNA encoding the hostname if the string contains
  324. # non-ASCII characters. This allows users to automatically get the correct IDNA
  325. # behaviour. For strings containing only ASCII characters, we need to also verify
  326. # it doesn't start with a wildcard (*), before allowing the unencoded hostname.
  327. if not unicode_is_ascii(host):
  328. try:
  329. host = self._get_idna_encoded_host(host)
  330. except UnicodeError:
  331. raise InvalidURL('URL has an invalid label.')
  332. elif host.startswith(u'*'):
  333. raise InvalidURL('URL has an invalid label.')
  334. # Carefully reconstruct the network location
  335. netloc = auth or ''
  336. if netloc:
  337. netloc += '@'
  338. netloc += host
  339. if port:
  340. netloc += ':' + str(port)
  341. # Bare domains aren't valid URLs.
  342. if not path:
  343. path = '/'
  344. if is_py2:
  345. if isinstance(scheme, str):
  346. scheme = scheme.encode('utf-8')
  347. if isinstance(netloc, str):
  348. netloc = netloc.encode('utf-8')
  349. if isinstance(path, str):
  350. path = path.encode('utf-8')
  351. if isinstance(query, str):
  352. query = query.encode('utf-8')
  353. if isinstance(fragment, str):
  354. fragment = fragment.encode('utf-8')
  355. if isinstance(params, (str, bytes)):
  356. params = to_native_string(params)
  357. enc_params = self._encode_params(params)
  358. if enc_params:
  359. if query:
  360. query = '%s&%s' % (query, enc_params)
  361. else:
  362. query = enc_params
  363. url = requote_uri(urlunparse([scheme, netloc, path, None, query, fragment]))
  364. self.url = url
  365. def prepare_headers(self, headers):
  366. """Prepares the given HTTP headers."""
  367. self.headers = CaseInsensitiveDict()
  368. if headers:
  369. for header in headers.items():
  370. # Raise exception on invalid header value.
  371. check_header_validity(header)
  372. name, value = header
  373. self.headers[to_native_string(name)] = value
  374. def prepare_body(self, data, files, json=None):
  375. """Prepares the given HTTP body data."""
  376. # Check if file, fo, generator, iterator.
  377. # If not, run through normal process.
  378. # Nottin' on you.
  379. body = None
  380. content_type = None
  381. if not data and json is not None:
  382. # urllib3 requires a bytes-like body. Python 2's json.dumps
  383. # provides this natively, but Python 3 gives a Unicode string.
  384. content_type = 'application/json'
  385. try:
  386. body = complexjson.dumps(json, allow_nan=False)
  387. except ValueError as ve:
  388. raise InvalidJSONError(ve, request=self)
  389. if not isinstance(body, bytes):
  390. body = body.encode('utf-8')
  391. is_stream = all([
  392. hasattr(data, '__iter__'),
  393. not isinstance(data, (basestring, list, tuple, Mapping))
  394. ])
  395. if is_stream:
  396. try:
  397. length = super_len(data)
  398. except (TypeError, AttributeError, UnsupportedOperation):
  399. length = None
  400. body = data
  401. if getattr(body, 'tell', None) is not None:
  402. # Record the current file position before reading.
  403. # This will allow us to rewind a file in the event
  404. # of a redirect.
  405. try:
  406. self._body_position = body.tell()
  407. except (IOError, OSError):
  408. # This differentiates from None, allowing us to catch
  409. # a failed `tell()` later when trying to rewind the body
  410. self._body_position = object()
  411. if files:
  412. raise NotImplementedError('Streamed bodies and files are mutually exclusive.')
  413. if length:
  414. self.headers['Content-Length'] = builtin_str(length)
  415. else:
  416. self.headers['Transfer-Encoding'] = 'chunked'
  417. else:
  418. # Multi-part file uploads.
  419. if files:
  420. (body, content_type) = self._encode_files(files, data)
  421. else:
  422. if data:
  423. body = self._encode_params(data)
  424. if isinstance(data, basestring) or hasattr(data, 'read'):
  425. content_type = None
  426. else:
  427. content_type = 'application/x-www-form-urlencoded'
  428. self.prepare_content_length(body)
  429. # Add content-type if it wasn't explicitly provided.
  430. if content_type and ('content-type' not in self.headers):
  431. self.headers['Content-Type'] = content_type
  432. self.body = body
  433. def prepare_content_length(self, body):
  434. """Prepare Content-Length header based on request method and body"""
  435. if body is not None:
  436. length = super_len(body)
  437. if length:
  438. # If length exists, set it. Otherwise, we fallback
  439. # to Transfer-Encoding: chunked.
  440. self.headers['Content-Length'] = builtin_str(length)
  441. elif self.method not in ('GET', 'HEAD') and self.headers.get('Content-Length') is None:
  442. # Set Content-Length to 0 for methods that can have a body
  443. # but don't provide one. (i.e. not GET or HEAD)
  444. self.headers['Content-Length'] = '0'
  445. def prepare_auth(self, auth, url=''):
  446. """Prepares the given HTTP auth data."""
  447. # If no Auth is explicitly provided, extract it from the URL first.
  448. if auth is None:
  449. url_auth = get_auth_from_url(self.url)
  450. auth = url_auth if any(url_auth) else None
  451. if auth:
  452. if isinstance(auth, tuple) and len(auth) == 2:
  453. # special-case basic HTTP auth
  454. auth = HTTPBasicAuth(*auth)
  455. # Allow auth to make its changes.
  456. r = auth(self)
  457. # Update self to reflect the auth changes.
  458. self.__dict__.update(r.__dict__)
  459. # Recompute Content-Length
  460. self.prepare_content_length(self.body)
  461. def prepare_cookies(self, cookies):
  462. """Prepares the given HTTP cookie data.
  463. This function eventually generates a ``Cookie`` header from the
  464. given cookies using cookielib. Due to cookielib's design, the header
  465. will not be regenerated if it already exists, meaning this function
  466. can only be called once for the life of the
  467. :class:`PreparedRequest <PreparedRequest>` object. Any subsequent calls
  468. to ``prepare_cookies`` will have no actual effect, unless the "Cookie"
  469. header is removed beforehand.
  470. """
  471. if isinstance(cookies, cookielib.CookieJar):
  472. self._cookies = cookies
  473. else:
  474. self._cookies = cookiejar_from_dict(cookies)
  475. cookie_header = get_cookie_header(self._cookies, self)
  476. if cookie_header is not None:
  477. self.headers['Cookie'] = cookie_header
  478. def prepare_hooks(self, hooks):
  479. """Prepares the given hooks."""
  480. # hooks can be passed as None to the prepare method and to this
  481. # method. To prevent iterating over None, simply use an empty list
  482. # if hooks is False-y
  483. hooks = hooks or []
  484. for event in hooks:
  485. self.register_hook(event, hooks[event])
  486. class Response(object):
  487. """The :class:`Response <Response>` object, which contains a
  488. server's response to an HTTP request.
  489. """
  490. __attrs__ = [
  491. '_content', 'status_code', 'headers', 'url', 'history',
  492. 'encoding', 'reason', 'cookies', 'elapsed', 'request'
  493. ]
  494. def __init__(self):
  495. self._content = False
  496. self._content_consumed = False
  497. self._next = None
  498. #: Integer Code of responded HTTP Status, e.g. 404 or 200.
  499. self.status_code = None
  500. #: Case-insensitive Dictionary of Response Headers.
  501. #: For example, ``headers['content-encoding']`` will return the
  502. #: value of a ``'Content-Encoding'`` response header.
  503. self.headers = CaseInsensitiveDict()
  504. #: File-like object representation of response (for advanced usage).
  505. #: Use of ``raw`` requires that ``stream=True`` be set on the request.
  506. #: This requirement does not apply for use internally to Requests.
  507. self.raw = None
  508. #: Final URL location of Response.
  509. self.url = None
  510. #: Encoding to decode with when accessing r.text.
  511. self.encoding = None
  512. #: A list of :class:`Response <Response>` objects from
  513. #: the history of the Request. Any redirect responses will end
  514. #: up here. The list is sorted from the oldest to the most recent request.
  515. self.history = []
  516. #: Textual reason of responded HTTP Status, e.g. "Not Found" or "OK".
  517. self.reason = None
  518. #: A CookieJar of Cookies the server sent back.
  519. self.cookies = cookiejar_from_dict({})
  520. #: The amount of time elapsed between sending the request
  521. #: and the arrival of the response (as a timedelta).
  522. #: This property specifically measures the time taken between sending
  523. #: the first byte of the request and finishing parsing the headers. It
  524. #: is therefore unaffected by consuming the response content or the
  525. #: value of the ``stream`` keyword argument.
  526. self.elapsed = datetime.timedelta(0)
  527. #: The :class:`PreparedRequest <PreparedRequest>` object to which this
  528. #: is a response.
  529. self.request = None
  530. def __enter__(self):
  531. return self
  532. def __exit__(self, *args):
  533. self.close()
  534. def __getstate__(self):
  535. # Consume everything; accessing the content attribute makes
  536. # sure the content has been fully read.
  537. if not self._content_consumed:
  538. self.content
  539. return {attr: getattr(self, attr, None) for attr in self.__attrs__}
  540. def __setstate__(self, state):
  541. for name, value in state.items():
  542. setattr(self, name, value)
  543. # pickled objects do not have .raw
  544. setattr(self, '_content_consumed', True)
  545. setattr(self, 'raw', None)
  546. def __repr__(self):
  547. return '<Response [%s]>' % (self.status_code)
  548. def __bool__(self):
  549. """Returns True if :attr:`status_code` is less than 400.
  550. This attribute checks if the status code of the response is between
  551. 400 and 600 to see if there was a client error or a server error. If
  552. the status code, is between 200 and 400, this will return True. This
  553. is **not** a check to see if the response code is ``200 OK``.
  554. """
  555. return self.ok
  556. def __nonzero__(self):
  557. """Returns True if :attr:`status_code` is less than 400.
  558. This attribute checks if the status code of the response is between
  559. 400 and 600 to see if there was a client error or a server error. If
  560. the status code, is between 200 and 400, this will return True. This
  561. is **not** a check to see if the response code is ``200 OK``.
  562. """
  563. return self.ok
  564. def __iter__(self):
  565. """Allows you to use a response as an iterator."""
  566. return self.iter_content(128)
  567. @property
  568. def ok(self):
  569. """Returns True if :attr:`status_code` is less than 400, False if not.
  570. This attribute checks if the status code of the response is between
  571. 400 and 600 to see if there was a client error or a server error. If
  572. the status code is between 200 and 400, this will return True. This
  573. is **not** a check to see if the response code is ``200 OK``.
  574. """
  575. try:
  576. self.raise_for_status()
  577. except HTTPError:
  578. return False
  579. return True
  580. @property
  581. def is_redirect(self):
  582. """True if this Response is a well-formed HTTP redirect that could have
  583. been processed automatically (by :meth:`Session.resolve_redirects`).
  584. """
  585. return ('location' in self.headers and self.status_code in REDIRECT_STATI)
  586. @property
  587. def is_permanent_redirect(self):
  588. """True if this Response one of the permanent versions of redirect."""
  589. return ('location' in self.headers and self.status_code in (codes.moved_permanently, codes.permanent_redirect))
  590. @property
  591. def next(self):
  592. """Returns a PreparedRequest for the next request in a redirect chain, if there is one."""
  593. return self._next
  594. @property
  595. def apparent_encoding(self):
  596. """The apparent encoding, provided by the charset_normalizer or chardet libraries."""
  597. return chardet.detect(self.content)['encoding']
  598. def iter_content(self, chunk_size=1, decode_unicode=False):
  599. """Iterates over the response data. When stream=True is set on the
  600. request, this avoids reading the content at once into memory for
  601. large responses. The chunk size is the number of bytes it should
  602. read into memory. This is not necessarily the length of each item
  603. returned as decoding can take place.
  604. chunk_size must be of type int or None. A value of None will
  605. function differently depending on the value of `stream`.
  606. stream=True will read data as it arrives in whatever size the
  607. chunks are received. If stream=False, data is returned as
  608. a single chunk.
  609. If decode_unicode is True, content will be decoded using the best
  610. available encoding based on the response.
  611. """
  612. def generate():
  613. # Special case for urllib3.
  614. if hasattr(self.raw, 'stream'):
  615. try:
  616. for chunk in self.raw.stream(chunk_size, decode_content=True):
  617. yield chunk
  618. except ProtocolError as e:
  619. raise ChunkedEncodingError(e)
  620. except DecodeError as e:
  621. raise ContentDecodingError(e)
  622. except ReadTimeoutError as e:
  623. raise ConnectionError(e)
  624. else:
  625. # Standard file-like object.
  626. while True:
  627. chunk = self.raw.read(chunk_size)
  628. if not chunk:
  629. break
  630. yield chunk
  631. self._content_consumed = True
  632. if self._content_consumed and isinstance(self._content, bool):
  633. raise StreamConsumedError()
  634. elif chunk_size is not None and not isinstance(chunk_size, int):
  635. raise TypeError("chunk_size must be an int, it is instead a %s." % type(chunk_size))
  636. # simulate reading small chunks of the content
  637. reused_chunks = iter_slices(self._content, chunk_size)
  638. stream_chunks = generate()
  639. chunks = reused_chunks if self._content_consumed else stream_chunks
  640. if decode_unicode:
  641. chunks = stream_decode_response_unicode(chunks, self)
  642. return chunks
  643. def iter_lines(self, chunk_size=ITER_CHUNK_SIZE, decode_unicode=False, delimiter=None):
  644. """Iterates over the response data, one line at a time. When
  645. stream=True is set on the request, this avoids reading the
  646. content at once into memory for large responses.
  647. .. note:: This method is not reentrant safe.
  648. """
  649. pending = None
  650. for chunk in self.iter_content(chunk_size=chunk_size, decode_unicode=decode_unicode):
  651. if pending is not None:
  652. chunk = pending + chunk
  653. if delimiter:
  654. lines = chunk.split(delimiter)
  655. else:
  656. lines = chunk.splitlines()
  657. if lines and lines[-1] and chunk and lines[-1][-1] == chunk[-1]:
  658. pending = lines.pop()
  659. else:
  660. pending = None
  661. for line in lines:
  662. yield line
  663. if pending is not None:
  664. yield pending
  665. @property
  666. def content(self):
  667. """Content of the response, in bytes."""
  668. if self._content is False:
  669. # Read the contents.
  670. if self._content_consumed:
  671. raise RuntimeError(
  672. 'The content for this response was already consumed')
  673. if self.status_code == 0 or self.raw is None:
  674. self._content = None
  675. else:
  676. self._content = b''.join(self.iter_content(CONTENT_CHUNK_SIZE)) or b''
  677. self._content_consumed = True
  678. # don't need to release the connection; that's been handled by urllib3
  679. # since we exhausted the data.
  680. return self._content
  681. @property
  682. def text(self):
  683. """Content of the response, in unicode.
  684. If Response.encoding is None, encoding will be guessed using
  685. ``charset_normalizer`` or ``chardet``.
  686. The encoding of the response content is determined based solely on HTTP
  687. headers, following RFC 2616 to the letter. If you can take advantage of
  688. non-HTTP knowledge to make a better guess at the encoding, you should
  689. set ``r.encoding`` appropriately before accessing this property.
  690. """
  691. # Try charset from content-type
  692. content = None
  693. encoding = self.encoding
  694. if not self.content:
  695. return str('')
  696. # Fallback to auto-detected encoding.
  697. if self.encoding is None:
  698. encoding = self.apparent_encoding
  699. # Decode unicode from given encoding.
  700. try:
  701. content = str(self.content, encoding, errors='replace')
  702. except (LookupError, TypeError):
  703. # A LookupError is raised if the encoding was not found which could
  704. # indicate a misspelling or similar mistake.
  705. #
  706. # A TypeError can be raised if encoding is None
  707. #
  708. # So we try blindly encoding.
  709. content = str(self.content, errors='replace')
  710. return content
  711. def json(self, **kwargs):
  712. r"""Returns the json-encoded content of a response, if any.
  713. :param \*\*kwargs: Optional arguments that ``json.loads`` takes.
  714. :raises simplejson.JSONDecodeError: If the response body does not
  715. contain valid json and simplejson is installed.
  716. :raises json.JSONDecodeError: If the response body does not contain
  717. valid json and simplejson is not installed on Python 3.
  718. :raises ValueError: If the response body does not contain valid
  719. json and simplejson is not installed on Python 2.
  720. """
  721. if not self.encoding and self.content and len(self.content) > 3:
  722. # No encoding set. JSON RFC 4627 section 3 states we should expect
  723. # UTF-8, -16 or -32. Detect which one to use; If the detection or
  724. # decoding fails, fall back to `self.text` (using charset_normalizer to make
  725. # a best guess).
  726. encoding = guess_json_utf(self.content)
  727. if encoding is not None:
  728. try:
  729. return complexjson.loads(
  730. self.content.decode(encoding), **kwargs
  731. )
  732. except UnicodeDecodeError:
  733. # Wrong UTF codec detected; usually because it's not UTF-8
  734. # but some other 8-bit codec. This is an RFC violation,
  735. # and the server didn't bother to tell us what codec *was*
  736. # used.
  737. pass
  738. return complexjson.loads(self.text, **kwargs)
  739. @property
  740. def links(self):
  741. """Returns the parsed header links of the response, if any."""
  742. header = self.headers.get('link')
  743. # l = MultiDict()
  744. l = {}
  745. if header:
  746. links = parse_header_links(header)
  747. for link in links:
  748. key = link.get('rel') or link.get('url')
  749. l[key] = link
  750. return l
  751. def raise_for_status(self):
  752. """Raises :class:`HTTPError`, if one occurred."""
  753. http_error_msg = ''
  754. if isinstance(self.reason, bytes):
  755. # We attempt to decode utf-8 first because some servers
  756. # choose to localize their reason strings. If the string
  757. # isn't utf-8, we fall back to iso-8859-1 for all other
  758. # encodings. (See PR #3538)
  759. try:
  760. reason = self.reason.decode('utf-8')
  761. except UnicodeDecodeError:
  762. reason = self.reason.decode('iso-8859-1')
  763. else:
  764. reason = self.reason
  765. if 400 <= self.status_code < 500:
  766. http_error_msg = u'%s Client Error: %s for url: %s' % (self.status_code, reason, self.url)
  767. elif 500 <= self.status_code < 600:
  768. http_error_msg = u'%s Server Error: %s for url: %s' % (self.status_code, reason, self.url)
  769. if http_error_msg:
  770. raise HTTPError(http_error_msg, response=self)
  771. def close(self):
  772. """Releases the connection back to the pool. Once this method has been
  773. called the underlying ``raw`` object must not be accessed again.
  774. *Note: Should not normally need to be called explicitly.*
  775. """
  776. if not self._content_consumed:
  777. self.raw.close()
  778. release_conn = getattr(self.raw, 'release_conn', None)
  779. if release_conn is not None:
  780. release_conn()