Developer Interface

This part of the documentation covers all the interfaces of Requests. For parts where Requests depends on external libraries, we document the most important right here and provide links to the canonical documentation.

Main Interface

All of Requests’ functionality can be accessed by these 7 methods. They all return an instance of the Response object.

requests.``request(method, url, \*kwargs*)[source]

Constructs and sends a Request.

Usage:

>>> import requests
>>> req = requests.request('GET', 'http://httpbin.org/get')
<Response [200]>

requests.``head(url, \*kwargs*)[source]

Sends a HEAD request.

requests.``get(url, params=None, \*kwargs*)[source]

Sends a GET request.

requests.``post(url, data=None, json=None, \*kwargs*)[source]

Sends a POST request.

requests.``put(url, data=None, \*kwargs*)[source]

Sends a PUT request.

requests.``patch(url, data=None, \*kwargs*)[source]

Sends a PATCH request.

requests.``delete(url, \*kwargs*)[source]

Sends a DELETE request.

Exceptions

exception requests.``RequestException(\args, **kwargs*)[source]

There was an ambiguous exception that occurred while handling your request.

exception requests.``ConnectionError(\args, **kwargs*)[source]

A Connection error occurred.

exception requests.``HTTPError(\args, **kwargs*)[source]

An HTTP error occurred.

exception requests.``URLRequired(\args, **kwargs*)[source]

A valid URL is required to make a request.

exception requests.``TooManyRedirects(\args, **kwargs*)[source]

Too many redirects.

exception requests.``ConnectTimeout(\args, **kwargs*)[source]

The request timed out while trying to connect to the remote server.

Requests that produced this error are safe to retry.

exception requests.``ReadTimeout(\args, **kwargs*)[source]

The server did not send any data in the allotted amount of time.

exception requests.``Timeout(\args, **kwargs*)[source]

The request timed out.

Catching this error will catch both ConnectTimeout and ReadTimeout errors.

Request Sessions

class requests.``Session[source]

A Requests session.

Provides cookie persistence, connection-pooling, and configuration.

Basic Usage:

>>> import requests
>>> s = requests.Session()
>>> s.get('http://httpbin.org/get')
<Response [200]>

Or as a context manager:

>>> with requests.Session() as s:
>>>     s.get('http://httpbin.org/get')
<Response [200]>

• auth = None

  Default Authentication tuple or object to attach to Request.

• cert = None

  SSL certificate default.

• close()[source]

  Closes all adapters and as such the session

• cookies = None

  A CookieJar containing all currently outstanding cookies set on this session. By default it is a RequestsCookieJar, but may be any other cookielib.CookieJar compatible object.

• delete(url, \*kwargs*)[source]

  Sends a DELETE request. Returns Response object.

  Parameters:	url — URL for the new Request object. **kwargs — Optional arguments that request takes.

• get(url, \*kwargs*)[source]

  Sends a GET request. Returns Response object.

  Parameters:	url — URL for the new Request object. **kwargs — Optional arguments that request takes.

• get_adapter(url)[source]

  Returns the appropriate connection adapter for the given URL.

• head(url, \*kwargs*)[source]

  Sends a HEAD request. Returns Response object.

  Parameters:	url — URL for the new Request object. **kwargs — Optional arguments that request takes.

• headers = None

  A case-insensitive dictionary of headers to be sent on each Request sent from this Session.

• hooks = None

  Event-handling hooks.

• max_redirects = None

  Maximum number of redirects allowed. If the request exceeds this limit, a TooManyRedirects exception is raised. This defaults to requests.models.DEFAULT_REDIRECT_LIMIT, which is 30.

• merge_environment_settings(url, proxies, stream, verify, cert)[source]

  Check the environment and merge it with some settings.

• mount(prefix, adapter)[source]

  Registers a connection adapter to a prefix.

  Adapters are sorted in descending order by key length.

• options(url, \*kwargs*)[source]

  Sends a OPTIONS request. Returns Response object.

  Parameters:	url — URL for the new Request object. **kwargs — Optional arguments that request takes.

• params = None

  Dictionary of querystring data to attach to each Request. The dictionary values may be lists for representing multivalued query parameters.

• patch(url, data=None, \*kwargs*)[source]

  Sends a PATCH request. Returns Response object.

  Parameters:	url — URL for the new Request object. data — (optional) Dictionary, bytes, or file-like object to send in the body of the Request. **kwargs — Optional arguments that request takes.

• post(url, data=None, json=None, \*kwargs*)[source]

  Sends a POST request. Returns Response object.

  Parameters:	url — URL for the new Request object. data — (optional) Dictionary, bytes, or file-like object to send in the body of the Request. json — (optional) json to send in the body of the Request. **kwargs — Optional arguments that request takes.

• prepare_request(request)[source]

  Constructs a PreparedRequest for transmission and returns it. The PreparedRequest has settings merged from the Request instance and those of the Session.

  Parameters:	request — Request instance to prepare with this session’s settings.

• proxies = None

  Dictionary mapping protocol or protocol and host to the URL of the proxy (e.g. {‘http’: ‘foo.bar:3128’, ‘http://host.name‘: ‘foo.bar:4012’}) to be used on each Request.

• put(url, data=None, \*kwargs*)[source]

  Sends a PUT request. Returns Response object.

  Parameters:	url — URL for the new Request object. data — (optional) Dictionary, bytes, or file-like object to send in the body of the Request. **kwargs — Optional arguments that request takes.

• rebuild_auth(prepared_request, response)

  When being redirected we may want to strip authentication from the request to avoid leaking credentials. This method intelligently removes and reapplies authentication where possible to avoid credential loss.

• rebuild_method(prepared_request, response)

  When being redirected we may want to change the method of the request based on certain specs or browser behavior.

• rebuild_proxies(prepared_request, proxies)

  This method re-evaluates the proxy configuration by considering the environment variables. If we are redirected to a URL covered by NO_PROXY, we strip the proxy configuration. Otherwise, we set missing proxy keys for this URL (in case they were stripped by a previous redirect).

  This method also replaces the Proxy-Authorization header where necessary.

• request(method, url, params=None, data=None, headers=None, cookies=None, files=None, auth=None, timeout=None, allow_redirects=True, proxies=None, hooks=None, stream=None, verify=None, cert=None, json=None)[source]

  Constructs a Request, prepares it and sends it. Returns Response object.

  Parameters:

  method — method for the new Request object. url — URL for the new Request object. params — (optional) Dictionary or bytes to be sent in the query string for the Request. data — (optional) Dictionary, bytes, or file-like object to send in the body of the Request. json — (optional) json to send in the body of the Request. headers — (optional) Dictionary of HTTP Headers to send with the Request. cookies — (optional) Dict or CookieJar object to send with the Request. files — (optional) Dictionary of ‘filename’: file-like-objects for multipart encoding upload. auth — (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth. timeout (float or tuple) — (optional) How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple. allow_redirects (bool) — (optional) Set to True by default. proxies — (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy. stream — (optional) whether to immediately download the response content. Defaults to False. verify — (optional) whether the SSL cert will be verified. A CA_BUNDLE path can also be provided. Defaults to True. cert — (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

  Return type:

  requests.Response

• resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None, \*adapter_kwargs*)

  Receives a Response. Returns a generator of Responses.

• send(request, \*kwargs*)[source]

  Send a given PreparedRequest.

• stream = None

  Stream response content default.

• trust_env = None

  Trust environment settings for proxy configuration, default authentication and similar.

• verify = None

  SSL Verification default.

Lower-Level Classes

class requests.``Request(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[source]

A user-created Request object.

Used to prepare a PreparedRequest, which is sent to the server.

Usage:

>>> import requests
>>> req = requests.Request('GET', 'http://httpbin.org/get')
>>> req.prepare()
<PreparedRequest [GET]>

• deregister_hook(event, hook)

  Deregister a previously registered hook. Returns True if the hook existed, False if not.

• prepare()[source]

  Constructs a PreparedRequest for transmission and returns it.

• register_hook(event, hook)

  Properly register a hook.

class requests.``Response[source]

The Response object, which contains a server’s response to an HTTP request.

• apparent_encoding

  The apparent encoding, provided by the chardet library

• close()[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.

• content

  Content of the response, in bytes.

• cookies = None

  A CookieJar of Cookies the server sent back.

• elapsed = None

  The amount of time elapsed between sending the request and the arrival of the response (as a timedelta). This property specifically measures the time taken between sending the first byte of the request and finishing parsing the headers. It is therefore unaffected by consuming the response content or the value of the stream keyword argument.

• encoding = None

  Encoding to decode with when accessing r.text.

• headers = None

  Case-insensitive Dictionary of Response Headers. For example, headers['content-encoding'] will return the value of a 'Content-Encoding' response header.

• history = None

  A list of Response objects from the history of the Request. Any redirect responses will end up here. The list is sorted from the oldest to the most recent request.

• is_permanent_redirect

  True if this Response one of the permanent versions of redirect

• is_redirect

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

• iter_content(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.

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

• iter_lines(chunk_size=512, decode_unicode=None, 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.

• json(\*kwargs*)[source]

  Returns the json-encoded content of a response, if any.

  Parameters:	**kwargs — Optional arguments that json.loads takes.

• links

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

• raise_for_status()[source]

  Raises stored HTTPError, if one occurred.

• raw = None

  File-like object representation of response (for advanced usage). Use of raw requires that stream=True be set on the request.

• reason = None

  Textual reason of responded HTTP Status, e.g. “Not Found” or “OK”.

• request = None

  The PreparedRequest object to which this is a response.

• status_code = None

  Integer Code of responded HTTP Status, e.g. 404 or 200.

• text

  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.

• url = None

  Final URL location of Response.

Lower-Lower-Level Classes

class requests.``PreparedRequest[source]

The fully mutable PreparedRequest object, containing the exact bytes that will be sent to the server.

Generated from either a Request object or manually.

Usage:

>>> import requests
>>> req = requests.Request('GET', 'http://httpbin.org/get')
>>> r = req.prepare()
<PreparedRequest [GET]>
>>> s = requests.Session()
>>> s.send(r)
<Response [200]>

• body = None

  request body to send to the server.

• deregister_hook(event, hook)

  Deregister a previously registered hook. Returns True if the hook existed, False if not.

• headers = None

  dictionary of HTTP headers.

• hooks = None

  dictionary of callback hooks, for internal usage.

• method = None

  HTTP verb to send to the server.

• path_url

  Build the path URL to use.

• prepare(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[source]

  Prepares the entire request with the given parameters.

• prepare_auth(auth, url=’’)[source]

  Prepares the given HTTP auth data.

• prepare_body(data, files, json=None)[source]

  Prepares the given HTTP body data.

• prepare_cookies(cookies)[source]

  Prepares the given HTTP cookie data.

  This function eventually generates a Cookie header from the given cookies using cookielib. Due to cookielib’s design, the header will not be regenerated if it already exists, meaning this function can only be called once for the life of the PreparedRequest object. Any subsequent calls to prepare_cookies will have no actual effect, unless the “Cookie” header is removed beforehand.

• prepare_headers(headers)[source]

  Prepares the given HTTP headers.

• prepare_hooks(hooks)[source]

  Prepares the given hooks.

• prepare_method(method)[source]

  Prepares the given HTTP method.

• prepare_url(url, params)[source]

  Prepares the given HTTP URL.

• register_hook(event, hook)

  Properly register a hook.

• url = None

  HTTP URL to send the request to.

class requests.adapters.``HTTPAdapter(pool_connections=10, pool_maxsize=10, max_retries=0, pool_block=False)[source]

The built-in HTTP Adapter for urllib3.

Provides a general-case interface for Requests sessions to contact HTTP and HTTPS urls by implementing the Transport Adapter interface. This class will usually be created by the Session class under the covers.

Usage:

>>> import requests
>>> s = requests.Session()
>>> a = requests.adapters.HTTPAdapter(max_retries=3)
>>> s.mount('http://', a)

• add_headers(request, \*kwargs*)[source]

  Add any headers needed by the connection. As of v2.0 this does nothing by default, but is left for overriding by users that subclass the HTTPAdapter.

  This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

  Parameters:	request — The PreparedRequest to add headers to. kwargs — The keyword arguments from the call to send().

• build_response(req, resp)[source]

  Builds a Response object from a urllib3 response. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter

  Parameters:	req — The PreparedRequest used to generate the response. resp — The urllib3 response object.

• cert_verify(conn, url, verify, cert)[source]

  Verify a SSL certificate. This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

  Parameters:	conn — The urllib3 connection object associated with the cert. url — The requested URL. verify — Whether we should actually verify the certificate. cert — The SSL certificate to verify.

• close()[source]

  Disposes of any internal state.

  Currently, this closes the PoolManager and any active ProxyManager, which closes any pooled connections.

• get_connection(url, proxies=None)[source]

  Returns a urllib3 connection for the given URL. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

  Parameters:	url — The URL to connect to. proxies — (optional) A Requests-style dictionary of proxies used on this request.

• init_poolmanager(connections, maxsize, block=False, \*pool_kwargs*)[source]

  Initializes a urllib3 PoolManager.

  This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

  Parameters:	connections — The number of urllib3 connection pools to cache. maxsize — The maximum number of connections to save in the pool. block — Block when no free connections are available. pool_kwargs — Extra keyword arguments used to initialize the Pool Manager.

• proxy_headers(proxy)[source]

  Returns a dictionary of the headers to add to any request sent through a proxy. This works with urllib3 magic to ensure that they are correctly sent to the proxy, rather than in a tunnelled request if CONNECT is being used.

  This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

  Parameters:	proxies — The url of the proxy being used for this request.

• proxy_manager_for(proxy, \*proxy_kwargs*)[source]

  Return urllib3 ProxyManager for the given proxy.

  This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

  Parameters:	proxy — The proxy to return a urllib3 ProxyManager for. proxy_kwargs — Extra keyword arguments used to configure the Proxy Manager.
  Returns:	ProxyManager

• request_url(request, proxies)[source]

  Obtain the url to use when making the final request.

  If the message is being sent through a HTTP proxy, the full URL has to be used. Otherwise, we should only use the path portion of the URL.

  This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

  Parameters:	request — The PreparedRequest being sent. proxies — A dictionary of schemes or schemes and hosts to proxy URLs.

• send(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)[source]

  Sends PreparedRequest object. Returns Response object.

  Parameters:

  request — The PreparedRequest being sent. stream — (optional) Whether to stream the request content. timeout (float or tuple) — (optional) How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple. verify — (optional) Whether to verify SSL certificates. cert — (optional) Any user-provided SSL certificate to be trusted. proxies — (optional) The proxies dictionary to apply to the request.

Authentication

class requests.auth.``AuthBase[source]

Base class that all auth implementations derive from

class requests.auth.``HTTPBasicAuth(username, password)[source]

Attaches HTTP Basic Authentication to the given Request object.

class requests.auth.``HTTPProxyAuth(username, password)[source]

Attaches HTTP Proxy Authentication to a given Request object.

class requests.auth.``HTTPDigestAuth(username, password)[source]

Attaches HTTP Digest Authentication to the given Request object.

Encodings

requests.utils.``get_encodings_from_content(content)[source]

Returns encodings from given content string.

requests.utils.``get_encoding_from_headers(headers)[source]

Returns encodings from given HTTP Header Dict.

requests.utils.``get_unicode_from_response(r)[source]

Returns the requested content back in unicode.

Tried:

1. charset from content-type
2. fall back and replace all unicode characters

Cookies

requests.utils.``dict_from_cookiejar(cj)[source]

Returns a key/value dictionary from a CookieJar.

requests.utils.``cookiejar_from_dict(cookie_dict, cookiejar=None, overwrite=True)[source]

Returns a CookieJar from a key/value dictionary.

requests.utils.``add_dict_to_cookiejar(cj, cookie_dict)[source]

Returns a CookieJar from a key/value dictionary.

class requests.cookies.``RequestsCookieJar(policy=None)[source]

Compatibility class; is a cookielib.CookieJar, but exposes a dict interface.

This is the CookieJar we create by default for requests and sessions that don’t specify one, since some clients may expect response.cookies and session.cookies to support dict operations.

Requests does not use the dict interface internally; it’s just for compatibility with external client code. All requests code should work out of the box with externally provided instances of CookieJar, e.g. LWPCookieJar and FileCookieJar.

Unlike a regular CookieJar, this class is pickleable.

Warning

dictionary operations that are normally O(1) may be O(n).

• add_cookie_header(request)

  Add correct Cookie: header to request (urllib2.Request object).

  The Cookie2 header is also added unless policy.hide_cookie2 is true.

• clear(domain=None, path=None, name=None)

  Clear some cookies.

  Invoking this method without arguments will clear all cookies. If given a single argument, only cookies belonging to that domain will be removed. If given two arguments, cookies belonging to the specified path within that domain are removed. If given three arguments, then the cookie with the specified name, path and domain is removed.

  Raises KeyError if no matching cookie exists.

• clear_expired_cookies()

  Discard all expired cookies.

  You probably don’t need to call this method: expired cookies are never sent back to the server (provided you’re using DefaultCookiePolicy), this method is called by CookieJar itself every so often, and the .save() method won’t save expired cookies anyway (unless you ask otherwise by passing a true ignore_expires argument).

• clear_session_cookies()

  Discard all session cookies.

  Note that the .save() method won’t save session cookies anyway, unless you ask otherwise by passing a true ignore_discard argument.

• copy()[source]

  Return a copy of this RequestsCookieJar.

• extract_cookies(response, request)

  Extract cookies from response, where allowable given the request.

• get(name, default=None, domain=None, path=None)[source]

  Dict-like get() that also supports optional domain and path args in order to resolve naming collisions from using one cookie jar over multiple domains.

  Warning

  operation is O(n), not O(1).

• get_dict(domain=None, path=None)[source]

  Takes as an argument an optional domain and path and returns a plain old Python dict of name-value pairs of cookies that meet the requirements.

• items()[source]

  Dict-like items() that returns a list of name-value tuples from the jar. See keys() and values(). Allows client-code to call dict(RequestsCookieJar) and get a vanilla python dict of key value pairs.

• iteritems()[source]

  Dict-like iteritems() that returns an iterator of name-value tuples from the jar. See iterkeys() and itervalues().

• iterkeys()[source]

  Dict-like iterkeys() that returns an iterator of names of cookies from the jar. See itervalues() and iteritems().

• itervalues()[source]

  Dict-like itervalues() that returns an iterator of values of cookies from the jar. See iterkeys() and iteritems().

• keys()[source]

  Dict-like keys() that returns a list of names of cookies from the jar. See values() and items().

• list_domains()[source]

  Utility method to list all the domains in the jar.

• list_paths()[source]

  Utility method to list all the paths in the jar.

• make_cookies(response, request)

  Return sequence of Cookie objects extracted from response object.

• multiple_domains()[source]

  Returns True if there are multiple domains in the jar. Returns False otherwise.

• pop(k[, d]) → v, remove specified key and return the corresponding value.

  If key is not found, d is returned if given, otherwise KeyError is raised.

• popitem() → (k, v), remove and return some (key, value) pair

  as a 2-tuple; but raise KeyError if D is empty.

• set(name, value, \*kwargs*)[source]

  Dict-like set() that also supports optional domain and path args in order to resolve naming collisions from using one cookie jar over multiple domains.

• set_cookie_if_ok(cookie, request)

  Set a cookie if policy says it’s OK to do so.

• setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

• update(other)[source]

  Updates this jar with cookies from another CookieJar or dict-like

• values()[source]

  Dict-like values() that returns a list of values of cookies from the jar. See keys() and items().

class requests.cookies.``CookieConflictError[source]

There are two cookies that meet the criteria specified in the cookie jar. Use .get and .set and include domain and path args in order to be more specific.

Status Code Lookup

requests.``codes

>>> requests.codes['temporary_redirect']
307
>>> requests.codes.teapot
418
>>> requests.codes['\o/']
200

Migrating to 1.x

This section details the main differences between 0.x and 1.x and is meant to ease the pain of upgrading.

API Changes

• Response.json is now a callable and not a property of a response.

  import requests
  r = requests.get('https://github.com/timeline.json')
  r.json()   # This *call* raises an exception if JSON decoding fails

• The Session API has changed. Sessions objects no longer take parameters. Session is also now capitalized, but it can still be instantiated with a lowercase session for backwards compatibility.

  s = requests.Session()    # formerly, session took parameters
  s.auth = auth
  s.headers.update(headers)
  r = s.get('http://httpbin.org/headers')

• All request hooks have been removed except ‘response’.

• Authentication helpers have been broken out into separate modules. See requests-oauthlib and requests-kerberos.

• The parameter for streaming requests was changed from prefetch to stream and the logic was inverted. In addition, stream is now required for raw response reading.

  # in 0.x, passing prefetch=False would accomplish the same thing
  r = requests.get('https://github.com/timeline.json', stream=True)
  for chunk in r.iter_content(8192):
      ...

• The config parameter to the requests method has been removed. Some of these options are now configured on a Session such as keep-alive and maximum number of redirects. The verbosity option should be handled by configuring logging.

  import requests
  import logging
  # Enabling debugging at http.client level (requests->urllib3->http.client)
  # you will see the REQUEST, including HEADERS and DATA, and RESPONSE with HEADERS but without DATA.
  # the only thing missing will be the response.body which is not logged.
  try: # for Python 3
      from http.client import HTTPConnection
  except ImportError:
      from httplib import HTTPConnection
  HTTPConnection.debuglevel = 1
  logging.basicConfig() # you need to initialize logging, otherwise you will not see anything from requests
  logging.getLogger().setLevel(logging.DEBUG)
  requests_log = logging.getLogger("requests.packages.urllib3")
  requests_log.setLevel(logging.DEBUG)
  requests_log.propagate = True
  requests.get('http://httpbin.org/headers')

Licensing

One key difference that has nothing to do with the API is a change in the license from the ISC license to the Apache 2.0 license. The Apache 2.0 license ensures that contributions to Requests are also covered by the Apache 2.0 license.

Migrating to 2.x

Compared with the 1.0 release, there were relatively few backwards incompatible changes, but there are still a few issues to be aware of with this major release.

For more details on the changes in this release including new APIs, links to the relevant GitHub issues and some of the bug fixes, read Cory’s blog on the subject.

API Changes

• There were a couple changes to how Requests handles exceptions. RequestException is now a subclass of IOError rather than RuntimeError as that more accurately categorizes the type of error. In addition, an invalid URL escape sequence now raises a subclass of RequestException rather than a ValueError.

  requests.get('http://%zz/')   # raises requests.exceptions.InvalidURL

  Lastly, httplib.IncompleteRead exceptions caused by incorrect chunked encoding will now raise a Requests ChunkedEncodingError instead.

• The proxy API has changed slightly. The scheme for a proxy URL is now required.

  proxies = {
    "http": "10.10.1.10:3128",    # use http://10.10.1.10:3128 instead
  }
  # In requests 1.x, this was legal, in requests 2.x,
  #  this raises requests.exceptions.MissingSchema
  requests.get("http://example.org", proxies=proxies)

Behavioural Changes

• Keys in the headers dictionary are now native strings on all Python versions, i.e. bytestrings on Python 2 and unicode on Python 3. If the keys are not native strings (unicode on Python2 or bytestrings on Python 3) they will be converted to the native string type assuming UTF-8 encoding.