1220 lines
35 KiB
ReStructuredText
1220 lines
35 KiB
ReStructuredText
Requests: HTTP for Humans
|
|
=========================
|
|
|
|
.. image:: https://img.shields.io/pypi/v/requests.svg
|
|
:target: https://pypi.python.org/pypi/requests
|
|
|
|
.. image:: https://img.shields.io/pypi/dm/requests.svg
|
|
:target: https://pypi.python.org/pypi/requests
|
|
|
|
|
|
|
|
|
|
Requests is an Apache2 Licensed HTTP library, written in Python, for human
|
|
beings.
|
|
|
|
Most existing Python modules for sending HTTP requests are extremely
|
|
verbose and cumbersome. Python's builtin urllib2 module provides most of
|
|
the HTTP capabilities you should need, but the api is thoroughly broken.
|
|
It requires an enormous amount of work (even method overrides) to
|
|
perform the simplest of tasks.
|
|
|
|
Things shouldn't be this way. Not in Python.
|
|
|
|
.. code-block:: python
|
|
|
|
>>> r = requests.get('https://api.github.com', auth=('user', 'pass'))
|
|
>>> r.status_code
|
|
204
|
|
>>> r.headers['content-type']
|
|
'application/json'
|
|
>>> r.text
|
|
...
|
|
|
|
See `the same code, without Requests <https://gist.github.com/973705>`_.
|
|
|
|
Requests allow you to send HTTP/1.1 requests. You can add headers, form data,
|
|
multipart files, and parameters with simple Python dictionaries, and access the
|
|
response data in the same way. It's powered by httplib and `urllib3
|
|
<https://github.com/shazow/urllib3>`_, but it does all the hard work and crazy
|
|
hacks for you.
|
|
|
|
|
|
Features
|
|
--------
|
|
|
|
- International Domains and URLs
|
|
- Keep-Alive & Connection Pooling
|
|
- Sessions with Cookie Persistence
|
|
- Browser-style SSL Verification
|
|
- Basic/Digest Authentication
|
|
- Elegant Key/Value Cookies
|
|
- Automatic Decompression
|
|
- Unicode Response Bodies
|
|
- Multipart File Uploads
|
|
- Connection Timeouts
|
|
- Thread-safety
|
|
- HTTP(S) proxy support
|
|
|
|
|
|
Installation
|
|
------------
|
|
|
|
To install Requests, simply:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install requests
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
Documentation is available at http://docs.python-requests.org/.
|
|
|
|
|
|
Contribute
|
|
----------
|
|
|
|
#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a `Contributor Friendly`_ tag for issues that should be ideal for people who are not very familiar with the codebase yet.
|
|
#. Fork `the repository`_ on GitHub to start making your changes to the **master** branch (or branch off of it).
|
|
#. Write a test which shows that the bug was fixed or that the feature works as expected.
|
|
#. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS_.
|
|
|
|
.. _`the repository`: http://github.com/kennethreitz/requests
|
|
.. _AUTHORS: https://github.com/kennethreitz/requests/blob/master/AUTHORS.rst
|
|
.. _Contributor Friendly: https://github.com/kennethreitz/requests/issues?direction=desc&labels=Contributor+Friendly&page=1&sort=updated&state=open
|
|
|
|
|
|
.. :changelog:
|
|
|
|
Release History
|
|
---------------
|
|
|
|
2.9.1 (2015-12-21)
|
|
++++++++++++++++++
|
|
|
|
**Bugfixes**
|
|
|
|
- Resolve regression introduced in 2.9.0 that made it impossible to send binary
|
|
strings as bodies in Python 3.
|
|
- Fixed errors when calculating cookie expiration dates in certain locales.
|
|
|
|
**Miscellaneous**
|
|
|
|
- Updated bundled urllib3 to 1.13.1.
|
|
|
|
2.9.0 (2015-12-15)
|
|
++++++++++++++++++
|
|
|
|
**Minor Improvements** (Backwards compatible)
|
|
|
|
- The ``verify`` keyword argument now supports being passed a path to a
|
|
directory of CA certificates, not just a single-file bundle.
|
|
- Warnings are now emitted when sending files opened in text mode.
|
|
- Added the 511 Network Authentication Required status code to the status code
|
|
registry.
|
|
|
|
**Bugfixes**
|
|
|
|
- For file-like objects that are not seeked to the very beginning, we now
|
|
send the content length for the number of bytes we will actually read, rather
|
|
than the total size of the file, allowing partial file uploads.
|
|
- When uploading file-like objects, if they are empty or have no obvious
|
|
content length we set ``Transfer-Encoding: chunked`` rather than
|
|
``Content-Length: 0``.
|
|
- We correctly receive the response in buffered mode when uploading chunked
|
|
bodies.
|
|
- We now handle being passed a query string as a bytestring on Python 3, by
|
|
decoding it as UTF-8.
|
|
- Sessions are now closed in all cases (exceptional and not) when using the
|
|
functional API rather than leaking and waiting for the garbage collector to
|
|
clean them up.
|
|
- Correctly handle digest auth headers with a malformed ``qop`` directive that
|
|
contains no token, by treating it the same as if no ``qop`` directive was
|
|
provided at all.
|
|
- Minor performance improvements when removing specific cookies by name.
|
|
|
|
**Miscellaneous**
|
|
|
|
- Updated urllib3 to 1.13.
|
|
|
|
2.8.1 (2015-10-13)
|
|
++++++++++++++++++
|
|
|
|
**Bugfixes**
|
|
|
|
- Update certificate bundle to match ``certifi`` 2015.9.6.2's weak certificate
|
|
bundle.
|
|
- Fix a bug in 2.8.0 where requests would raise ``ConnectTimeout`` instead of
|
|
``ConnectionError``
|
|
- When using the PreparedRequest flow, requests will now correctly respect the
|
|
``json`` parameter. Broken in 2.8.0.
|
|
- When using the PreparedRequest flow, requests will now correctly handle a
|
|
Unicode-string method name on Python 2. Broken in 2.8.0.
|
|
|
|
2.8.0 (2015-10-05)
|
|
++++++++++++++++++
|
|
|
|
**Minor Improvements** (Backwards Compatible)
|
|
|
|
- Requests now supports per-host proxies. This allows the ``proxies``
|
|
dictionary to have entries of the form
|
|
``{'<scheme>://<hostname>': '<proxy>'}``. Host-specific proxies will be used
|
|
in preference to the previously-supported scheme-specific ones, but the
|
|
previous syntax will continue to work.
|
|
- ``Response.raise_for_status`` now prints the URL that failed as part of the
|
|
exception message.
|
|
- ``requests.utils.get_netrc_auth`` now takes an ``raise_errors`` kwarg,
|
|
defaulting to ``False``. When ``True``, errors parsing ``.netrc`` files cause
|
|
exceptions to be thrown.
|
|
- Change to bundled projects import logic to make it easier to unbundle
|
|
requests downstream.
|
|
- Changed the default User-Agent string to avoid leaking data on Linux: now
|
|
contains only the requests version.
|
|
|
|
**Bugfixes**
|
|
|
|
- The ``json`` parameter to ``post()`` and friends will now only be used if
|
|
neither ``data`` nor ``files`` are present, consistent with the
|
|
documentation.
|
|
- We now ignore empty fields in the ``NO_PROXY`` environment variable.
|
|
- Fixed problem where ``httplib.BadStatusLine`` would get raised if combining
|
|
``stream=True`` with ``contextlib.closing``.
|
|
- Prevented bugs where we would attempt to return the same connection back to
|
|
the connection pool twice when sending a Chunked body.
|
|
- Miscellaneous minor internal changes.
|
|
- Digest Auth support is now thread safe.
|
|
|
|
**Updates**
|
|
|
|
- Updated urllib3 to 1.12.
|
|
|
|
2.7.0 (2015-05-03)
|
|
++++++++++++++++++
|
|
|
|
This is the first release that follows our new release process. For more, see
|
|
`our documentation
|
|
<http://docs.python-requests.org/en/latest/community/release-process/>`_.
|
|
|
|
**Bugfixes**
|
|
|
|
- Updated urllib3 to 1.10.4, resolving several bugs involving chunked transfer
|
|
encoding and response framing.
|
|
|
|
2.6.2 (2015-04-23)
|
|
++++++++++++++++++
|
|
|
|
**Bugfixes**
|
|
|
|
- Fix regression where compressed data that was sent as chunked data was not
|
|
properly decompressed. (#2561)
|
|
|
|
2.6.1 (2015-04-22)
|
|
++++++++++++++++++
|
|
|
|
**Bugfixes**
|
|
|
|
- Remove VendorAlias import machinery introduced in v2.5.2.
|
|
|
|
- Simplify the PreparedRequest.prepare API: We no longer require the user to
|
|
pass an empty list to the hooks keyword argument. (c.f. #2552)
|
|
|
|
- Resolve redirects now receives and forwards all of the original arguments to
|
|
the adapter. (#2503)
|
|
|
|
- Handle UnicodeDecodeErrors when trying to deal with a unicode URL that
|
|
cannot be encoded in ASCII. (#2540)
|
|
|
|
- Populate the parsed path of the URI field when performing Digest
|
|
Authentication. (#2426)
|
|
|
|
- Copy a PreparedRequest's CookieJar more reliably when it is not an instance
|
|
of RequestsCookieJar. (#2527)
|
|
|
|
2.6.0 (2015-03-14)
|
|
++++++++++++++++++
|
|
|
|
**Bugfixes**
|
|
|
|
- CVE-2015-2296: Fix handling of cookies on redirect. Previously a cookie
|
|
without a host value set would use the hostname for the redirected URL
|
|
exposing requests users to session fixation attacks and potentially cookie
|
|
stealing. This was disclosed privately by Matthew Daley of
|
|
`BugFuzz <https://bugfuzz.com>`_. This affects all versions of requests from
|
|
v2.1.0 to v2.5.3 (inclusive on both ends).
|
|
|
|
- Fix error when requests is an ``install_requires`` dependency and ``python
|
|
setup.py test`` is run. (#2462)
|
|
|
|
- Fix error when urllib3 is unbundled and requests continues to use the
|
|
vendored import location.
|
|
|
|
- Include fixes to ``urllib3``'s header handling.
|
|
|
|
- Requests' handling of unvendored dependencies is now more restrictive.
|
|
|
|
**Features and Improvements**
|
|
|
|
- Support bytearrays when passed as parameters in the ``files`` argument.
|
|
(#2468)
|
|
|
|
- Avoid data duplication when creating a request with ``str``, ``bytes``, or
|
|
``bytearray`` input to the ``files`` argument.
|
|
|
|
2.5.3 (2015-02-24)
|
|
++++++++++++++++++
|
|
|
|
**Bugfixes**
|
|
|
|
- Revert changes to our vendored certificate bundle. For more context see
|
|
(#2455, #2456, and http://bugs.python.org/issue23476)
|
|
|
|
2.5.2 (2015-02-23)
|
|
++++++++++++++++++
|
|
|
|
**Features and Improvements**
|
|
|
|
- Add sha256 fingerprint support. (`shazow/urllib3#540`_)
|
|
|
|
- Improve the performance of headers. (`shazow/urllib3#544`_)
|
|
|
|
**Bugfixes**
|
|
|
|
- Copy pip's import machinery. When downstream redistributors remove
|
|
requests.packages.urllib3 the import machinery will continue to let those
|
|
same symbols work. Example usage in requests' documentation and 3rd-party
|
|
libraries relying on the vendored copies of urllib3 will work without having
|
|
to fallback to the system urllib3.
|
|
|
|
- Attempt to quote parts of the URL on redirect if unquoting and then quoting
|
|
fails. (#2356)
|
|
|
|
- Fix filename type check for multipart form-data uploads. (#2411)
|
|
|
|
- Properly handle the case where a server issuing digest authentication
|
|
challenges provides both auth and auth-int qop-values. (#2408)
|
|
|
|
- Fix a socket leak. (`shazow/urllib3#549`_)
|
|
|
|
- Fix multiple ``Set-Cookie`` headers properly. (`shazow/urllib3#534`_)
|
|
|
|
- Disable the built-in hostname verification. (`shazow/urllib3#526`_)
|
|
|
|
- Fix the behaviour of decoding an exhausted stream. (`shazow/urllib3#535`_)
|
|
|
|
**Security**
|
|
|
|
- Pulled in an updated ``cacert.pem``.
|
|
|
|
- Drop RC4 from the default cipher list. (`shazow/urllib3#551`_)
|
|
|
|
.. _shazow/urllib3#551: https://github.com/shazow/urllib3/pull/551
|
|
.. _shazow/urllib3#549: https://github.com/shazow/urllib3/pull/549
|
|
.. _shazow/urllib3#544: https://github.com/shazow/urllib3/pull/544
|
|
.. _shazow/urllib3#540: https://github.com/shazow/urllib3/pull/540
|
|
.. _shazow/urllib3#535: https://github.com/shazow/urllib3/pull/535
|
|
.. _shazow/urllib3#534: https://github.com/shazow/urllib3/pull/534
|
|
.. _shazow/urllib3#526: https://github.com/shazow/urllib3/pull/526
|
|
|
|
2.5.1 (2014-12-23)
|
|
++++++++++++++++++
|
|
|
|
**Behavioural Changes**
|
|
|
|
- Only catch HTTPErrors in raise_for_status (#2382)
|
|
|
|
**Bugfixes**
|
|
|
|
- Handle LocationParseError from urllib3 (#2344)
|
|
- Handle file-like object filenames that are not strings (#2379)
|
|
- Unbreak HTTPDigestAuth handler. Allow new nonces to be negotiated (#2389)
|
|
|
|
2.5.0 (2014-12-01)
|
|
++++++++++++++++++
|
|
|
|
**Improvements**
|
|
|
|
- Allow usage of urllib3's Retry object with HTTPAdapters (#2216)
|
|
- The ``iter_lines`` method on a response now accepts a delimiter with which
|
|
to split the content (#2295)
|
|
|
|
**Behavioural Changes**
|
|
|
|
- Add deprecation warnings to functions in requests.utils that will be removed
|
|
in 3.0 (#2309)
|
|
- Sessions used by the functional API are always closed (#2326)
|
|
- Restrict requests to HTTP/1.1 and HTTP/1.0 (stop accepting HTTP/0.9) (#2323)
|
|
|
|
**Bugfixes**
|
|
|
|
- Only parse the URL once (#2353)
|
|
- Allow Content-Length header to always be overridden (#2332)
|
|
- Properly handle files in HTTPDigestAuth (#2333)
|
|
- Cap redirect_cache size to prevent memory abuse (#2299)
|
|
- Fix HTTPDigestAuth handling of redirects after authenticating successfully
|
|
(#2253)
|
|
- Fix crash with custom method parameter to Session.request (#2317)
|
|
- Fix how Link headers are parsed using the regular expression library (#2271)
|
|
|
|
**Documentation**
|
|
|
|
- Add more references for interlinking (#2348)
|
|
- Update CSS for theme (#2290)
|
|
- Update width of buttons and sidebar (#2289)
|
|
- Replace references of Gittip with Gratipay (#2282)
|
|
- Add link to changelog in sidebar (#2273)
|
|
|
|
2.4.3 (2014-10-06)
|
|
++++++++++++++++++
|
|
|
|
**Bugfixes**
|
|
|
|
- Unicode URL improvements for Python 2.
|
|
- Re-order JSON param for backwards compat.
|
|
- Automatically defrag authentication schemes from host/pass URIs. (`#2249 <https://github.com/kennethreitz/requests/issues/2249>`_)
|
|
|
|
|
|
2.4.2 (2014-10-05)
|
|
++++++++++++++++++
|
|
|
|
**Improvements**
|
|
|
|
- FINALLY! Add json parameter for uploads! (`#2258 <https://github.com/kennethreitz/requests/pull/2258>`_)
|
|
- Support for bytestring URLs on Python 3.x (`#2238 <https://github.com/kennethreitz/requests/pull/2238>`_)
|
|
|
|
**Bugfixes**
|
|
|
|
- Avoid getting stuck in a loop (`#2244 <https://github.com/kennethreitz/requests/pull/2244>`_)
|
|
- Multiple calls to iter* fail with unhelpful error. (`#2240 <https://github.com/kennethreitz/requests/issues/2240>`_, `#2241 <https://github.com/kennethreitz/requests/issues/2241>`_)
|
|
|
|
**Documentation**
|
|
|
|
- Correct redirection introduction (`#2245 <https://github.com/kennethreitz/requests/pull/2245/>`_)
|
|
- Added example of how to send multiple files in one request. (`#2227 <https://github.com/kennethreitz/requests/pull/2227/>`_)
|
|
- Clarify how to pass a custom set of CAs (`#2248 <https://github.com/kennethreitz/requests/pull/2248/>`_)
|
|
|
|
|
|
|
|
2.4.1 (2014-09-09)
|
|
++++++++++++++++++
|
|
|
|
- Now has a "security" package extras set, ``$ pip install requests[security]``
|
|
- Requests will now use Certifi if it is available.
|
|
- Capture and re-raise urllib3 ProtocolError
|
|
- Bugfix for responses that attempt to redirect to themselves forever (wtf?).
|
|
|
|
|
|
2.4.0 (2014-08-29)
|
|
++++++++++++++++++
|
|
|
|
**Behavioral Changes**
|
|
|
|
- ``Connection: keep-alive`` header is now sent automatically.
|
|
|
|
**Improvements**
|
|
|
|
- Support for connect timeouts! Timeout now accepts a tuple (connect, read) which is used to set individual connect and read timeouts.
|
|
- Allow copying of PreparedRequests without headers/cookies.
|
|
- Updated bundled urllib3 version.
|
|
- Refactored settings loading from environment -- new `Session.merge_environment_settings`.
|
|
- Handle socket errors in iter_content.
|
|
|
|
|
|
2.3.0 (2014-05-16)
|
|
++++++++++++++++++
|
|
|
|
**API Changes**
|
|
|
|
- New ``Response`` property ``is_redirect``, which is true when the
|
|
library could have processed this response as a redirection (whether
|
|
or not it actually did).
|
|
- The ``timeout`` parameter now affects requests with both ``stream=True`` and
|
|
``stream=False`` equally.
|
|
- The change in v2.0.0 to mandate explicit proxy schemes has been reverted.
|
|
Proxy schemes now default to ``http://``.
|
|
- The ``CaseInsensitiveDict`` used for HTTP headers now behaves like a normal
|
|
dictionary when references as string or viewed in the interpreter.
|
|
|
|
**Bugfixes**
|
|
|
|
- No longer expose Authorization or Proxy-Authorization headers on redirect.
|
|
Fix CVE-2014-1829 and CVE-2014-1830 respectively.
|
|
- Authorization is re-evaluated each redirect.
|
|
- On redirect, pass url as native strings.
|
|
- Fall-back to autodetected encoding for JSON when Unicode detection fails.
|
|
- Headers set to ``None`` on the ``Session`` are now correctly not sent.
|
|
- Correctly honor ``decode_unicode`` even if it wasn't used earlier in the same
|
|
response.
|
|
- Stop advertising ``compress`` as a supported Content-Encoding.
|
|
- The ``Response.history`` parameter is now always a list.
|
|
- Many, many ``urllib3`` bugfixes.
|
|
|
|
2.2.1 (2014-01-23)
|
|
++++++++++++++++++
|
|
|
|
**Bugfixes**
|
|
|
|
- Fixes incorrect parsing of proxy credentials that contain a literal or encoded '#' character.
|
|
- Assorted urllib3 fixes.
|
|
|
|
2.2.0 (2014-01-09)
|
|
++++++++++++++++++
|
|
|
|
**API Changes**
|
|
|
|
- New exception: ``ContentDecodingError``. Raised instead of ``urllib3``
|
|
``DecodeError`` exceptions.
|
|
|
|
**Bugfixes**
|
|
|
|
- Avoid many many exceptions from the buggy implementation of ``proxy_bypass`` on OS X in Python 2.6.
|
|
- Avoid crashing when attempting to get authentication credentials from ~/.netrc when running as a user without a home directory.
|
|
- Use the correct pool size for pools of connections to proxies.
|
|
- Fix iteration of ``CookieJar`` objects.
|
|
- Ensure that cookies are persisted over redirect.
|
|
- Switch back to using chardet, since it has merged with charade.
|
|
|
|
2.1.0 (2013-12-05)
|
|
++++++++++++++++++
|
|
|
|
- Updated CA Bundle, of course.
|
|
- Cookies set on individual Requests through a ``Session`` (e.g. via ``Session.get()``) are no longer persisted to the ``Session``.
|
|
- Clean up connections when we hit problems during chunked upload, rather than leaking them.
|
|
- Return connections to the pool when a chunked upload is successful, rather than leaking it.
|
|
- Match the HTTPbis recommendation for HTTP 301 redirects.
|
|
- Prevent hanging when using streaming uploads and Digest Auth when a 401 is received.
|
|
- Values of headers set by Requests are now always the native string type.
|
|
- Fix previously broken SNI support.
|
|
- Fix accessing HTTP proxies using proxy authentication.
|
|
- Unencode HTTP Basic usernames and passwords extracted from URLs.
|
|
- Support for IP address ranges for no_proxy environment variable
|
|
- Parse headers correctly when users override the default ``Host:`` header.
|
|
- Avoid munging the URL in case of case-sensitive servers.
|
|
- Looser URL handling for non-HTTP/HTTPS urls.
|
|
- Accept unicode methods in Python 2.6 and 2.7.
|
|
- More resilient cookie handling.
|
|
- Make ``Response`` objects pickleable.
|
|
- Actually added MD5-sess to Digest Auth instead of pretending to like last time.
|
|
- Updated internal urllib3.
|
|
- Fixed @Lukasa's lack of taste.
|
|
|
|
2.0.1 (2013-10-24)
|
|
++++++++++++++++++
|
|
|
|
- Updated included CA Bundle with new mistrusts and automated process for the future
|
|
- Added MD5-sess to Digest Auth
|
|
- Accept per-file headers in multipart file POST messages.
|
|
- Fixed: Don't send the full URL on CONNECT messages.
|
|
- Fixed: Correctly lowercase a redirect scheme.
|
|
- Fixed: Cookies not persisted when set via functional API.
|
|
- Fixed: Translate urllib3 ProxyError into a requests ProxyError derived from ConnectionError.
|
|
- Updated internal urllib3 and chardet.
|
|
|
|
2.0.0 (2013-09-24)
|
|
++++++++++++++++++
|
|
|
|
**API Changes:**
|
|
|
|
- Keys in the Headers dictionary are now native strings on all Python versions,
|
|
i.e. bytestrings on Python 2, unicode on Python 3.
|
|
- Proxy URLs now *must* have an explicit scheme. A ``MissingSchema`` exception
|
|
will be raised if they don't.
|
|
- Timeouts now apply to read time if ``Stream=False``.
|
|
- ``RequestException`` is now a subclass of ``IOError``, not ``RuntimeError``.
|
|
- Added new method to ``PreparedRequest`` objects: ``PreparedRequest.copy()``.
|
|
- Added new method to ``Session`` objects: ``Session.update_request()``. This
|
|
method updates a ``Request`` object with the data (e.g. cookies) stored on
|
|
the ``Session``.
|
|
- Added new method to ``Session`` objects: ``Session.prepare_request()``. This
|
|
method updates and prepares a ``Request`` object, and returns the
|
|
corresponding ``PreparedRequest`` object.
|
|
- Added new method to ``HTTPAdapter`` objects: ``HTTPAdapter.proxy_headers()``.
|
|
This should not be called directly, but improves the subclass interface.
|
|
- ``httplib.IncompleteRead`` exceptions caused by incorrect chunked encoding
|
|
will now raise a Requests ``ChunkedEncodingError`` instead.
|
|
- Invalid percent-escape sequences now cause a Requests ``InvalidURL``
|
|
exception to be raised.
|
|
- HTTP 208 no longer uses reason phrase ``"im_used"``. Correctly uses
|
|
``"already_reported"``.
|
|
- HTTP 226 reason added (``"im_used"``).
|
|
|
|
**Bugfixes:**
|
|
|
|
- Vastly improved proxy support, including the CONNECT verb. Special thanks to
|
|
the many contributors who worked towards this improvement.
|
|
- Cookies are now properly managed when 401 authentication responses are
|
|
received.
|
|
- Chunked encoding fixes.
|
|
- Support for mixed case schemes.
|
|
- Better handling of streaming downloads.
|
|
- Retrieve environment proxies from more locations.
|
|
- Minor cookies fixes.
|
|
- Improved redirect behaviour.
|
|
- Improved streaming behaviour, particularly for compressed data.
|
|
- Miscellaneous small Python 3 text encoding bugs.
|
|
- ``.netrc`` no longer overrides explicit auth.
|
|
- Cookies set by hooks are now correctly persisted on Sessions.
|
|
- Fix problem with cookies that specify port numbers in their host field.
|
|
- ``BytesIO`` can be used to perform streaming uploads.
|
|
- More generous parsing of the ``no_proxy`` environment variable.
|
|
- Non-string objects can be passed in data values alongside files.
|
|
|
|
1.2.3 (2013-05-25)
|
|
++++++++++++++++++
|
|
|
|
- Simple packaging fix
|
|
|
|
|
|
1.2.2 (2013-05-23)
|
|
++++++++++++++++++
|
|
|
|
- Simple packaging fix
|
|
|
|
|
|
1.2.1 (2013-05-20)
|
|
++++++++++++++++++
|
|
|
|
- 301 and 302 redirects now change the verb to GET for all verbs, not just
|
|
POST, improving browser compatibility.
|
|
- Python 3.3.2 compatibility
|
|
- Always percent-encode location headers
|
|
- Fix connection adapter matching to be most-specific first
|
|
- new argument to the default connection adapter for passing a block argument
|
|
- prevent a KeyError when there's no link headers
|
|
|
|
1.2.0 (2013-03-31)
|
|
++++++++++++++++++
|
|
|
|
- Fixed cookies on sessions and on requests
|
|
- Significantly change how hooks are dispatched - hooks now receive all the
|
|
arguments specified by the user when making a request so hooks can make a
|
|
secondary request with the same parameters. This is especially necessary for
|
|
authentication handler authors
|
|
- certifi support was removed
|
|
- Fixed bug where using OAuth 1 with body ``signature_type`` sent no data
|
|
- Major proxy work thanks to @Lukasa including parsing of proxy authentication
|
|
from the proxy url
|
|
- Fix DigestAuth handling too many 401s
|
|
- Update vendored urllib3 to include SSL bug fixes
|
|
- Allow keyword arguments to be passed to ``json.loads()`` via the
|
|
``Response.json()`` method
|
|
- Don't send ``Content-Length`` header by default on ``GET`` or ``HEAD``
|
|
requests
|
|
- Add ``elapsed`` attribute to ``Response`` objects to time how long a request
|
|
took.
|
|
- Fix ``RequestsCookieJar``
|
|
- Sessions and Adapters are now picklable, i.e., can be used with the
|
|
multiprocessing library
|
|
- Update charade to version 1.0.3
|
|
|
|
The change in how hooks are dispatched will likely cause a great deal of
|
|
issues.
|
|
|
|
1.1.0 (2013-01-10)
|
|
++++++++++++++++++
|
|
|
|
- CHUNKED REQUESTS
|
|
- Support for iterable response bodies
|
|
- Assume servers persist redirect params
|
|
- Allow explicit content types to be specified for file data
|
|
- Make merge_kwargs case-insensitive when looking up keys
|
|
|
|
1.0.3 (2012-12-18)
|
|
++++++++++++++++++
|
|
|
|
- Fix file upload encoding bug
|
|
- Fix cookie behavior
|
|
|
|
1.0.2 (2012-12-17)
|
|
++++++++++++++++++
|
|
|
|
- Proxy fix for HTTPAdapter.
|
|
|
|
1.0.1 (2012-12-17)
|
|
++++++++++++++++++
|
|
|
|
- Cert verification exception bug.
|
|
- Proxy fix for HTTPAdapter.
|
|
|
|
1.0.0 (2012-12-17)
|
|
++++++++++++++++++
|
|
|
|
- Massive Refactor and Simplification
|
|
- Switch to Apache 2.0 license
|
|
- Swappable Connection Adapters
|
|
- Mountable Connection Adapters
|
|
- Mutable ProcessedRequest chain
|
|
- /s/prefetch/stream
|
|
- Removal of all configuration
|
|
- Standard library logging
|
|
- Make Response.json() callable, not property.
|
|
- Usage of new charade project, which provides python 2 and 3 simultaneous chardet.
|
|
- Removal of all hooks except 'response'
|
|
- Removal of all authentication helpers (OAuth, Kerberos)
|
|
|
|
This is not a backwards compatible change.
|
|
|
|
0.14.2 (2012-10-27)
|
|
+++++++++++++++++++
|
|
|
|
- Improved mime-compatible JSON handling
|
|
- Proxy fixes
|
|
- Path hack fixes
|
|
- Case-Insensitive Content-Encoding headers
|
|
- Support for CJK parameters in form posts
|
|
|
|
|
|
0.14.1 (2012-10-01)
|
|
+++++++++++++++++++
|
|
|
|
- Python 3.3 Compatibility
|
|
- Simply default accept-encoding
|
|
- Bugfixes
|
|
|
|
|
|
0.14.0 (2012-09-02)
|
|
++++++++++++++++++++
|
|
|
|
- No more iter_content errors if already downloaded.
|
|
|
|
0.13.9 (2012-08-25)
|
|
+++++++++++++++++++
|
|
|
|
- Fix for OAuth + POSTs
|
|
- Remove exception eating from dispatch_hook
|
|
- General bugfixes
|
|
|
|
0.13.8 (2012-08-21)
|
|
+++++++++++++++++++
|
|
|
|
- Incredible Link header support :)
|
|
|
|
0.13.7 (2012-08-19)
|
|
+++++++++++++++++++
|
|
|
|
- Support for (key, value) lists everywhere.
|
|
- Digest Authentication improvements.
|
|
- Ensure proxy exclusions work properly.
|
|
- Clearer UnicodeError exceptions.
|
|
- Automatic casting of URLs to strings (fURL and such)
|
|
- Bugfixes.
|
|
|
|
0.13.6 (2012-08-06)
|
|
+++++++++++++++++++
|
|
|
|
- Long awaited fix for hanging connections!
|
|
|
|
0.13.5 (2012-07-27)
|
|
+++++++++++++++++++
|
|
|
|
- Packaging fix
|
|
|
|
0.13.4 (2012-07-27)
|
|
+++++++++++++++++++
|
|
|
|
- GSSAPI/Kerberos authentication!
|
|
- App Engine 2.7 Fixes!
|
|
- Fix leaking connections (from urllib3 update)
|
|
- OAuthlib path hack fix
|
|
- OAuthlib URL parameters fix.
|
|
|
|
0.13.3 (2012-07-12)
|
|
+++++++++++++++++++
|
|
|
|
- Use simplejson if available.
|
|
- Do not hide SSLErrors behind Timeouts.
|
|
- Fixed param handling with urls containing fragments.
|
|
- Significantly improved information in User Agent.
|
|
- client certificates are ignored when verify=False
|
|
|
|
0.13.2 (2012-06-28)
|
|
+++++++++++++++++++
|
|
|
|
- Zero dependencies (once again)!
|
|
- New: Response.reason
|
|
- Sign querystring parameters in OAuth 1.0
|
|
- Client certificates no longer ignored when verify=False
|
|
- Add openSUSE certificate support
|
|
|
|
0.13.1 (2012-06-07)
|
|
+++++++++++++++++++
|
|
|
|
- Allow passing a file or file-like object as data.
|
|
- Allow hooks to return responses that indicate errors.
|
|
- Fix Response.text and Response.json for body-less responses.
|
|
|
|
0.13.0 (2012-05-29)
|
|
+++++++++++++++++++
|
|
|
|
- Removal of Requests.async in favor of `grequests <https://github.com/kennethreitz/grequests>`_
|
|
- Allow disabling of cookie persistence.
|
|
- New implementation of safe_mode
|
|
- cookies.get now supports default argument
|
|
- Session cookies not saved when Session.request is called with return_response=False
|
|
- Env: no_proxy support.
|
|
- RequestsCookieJar improvements.
|
|
- Various bug fixes.
|
|
|
|
0.12.1 (2012-05-08)
|
|
+++++++++++++++++++
|
|
|
|
- New ``Response.json`` property.
|
|
- Ability to add string file uploads.
|
|
- Fix out-of-range issue with iter_lines.
|
|
- Fix iter_content default size.
|
|
- Fix POST redirects containing files.
|
|
|
|
0.12.0 (2012-05-02)
|
|
+++++++++++++++++++
|
|
|
|
- EXPERIMENTAL OAUTH SUPPORT!
|
|
- Proper CookieJar-backed cookies interface with awesome dict-like interface.
|
|
- Speed fix for non-iterated content chunks.
|
|
- Move ``pre_request`` to a more usable place.
|
|
- New ``pre_send`` hook.
|
|
- Lazily encode data, params, files.
|
|
- Load system Certificate Bundle if ``certify`` isn't available.
|
|
- Cleanups, fixes.
|
|
|
|
0.11.2 (2012-04-22)
|
|
+++++++++++++++++++
|
|
|
|
- Attempt to use the OS's certificate bundle if ``certifi`` isn't available.
|
|
- Infinite digest auth redirect fix.
|
|
- Multi-part file upload improvements.
|
|
- Fix decoding of invalid %encodings in URLs.
|
|
- If there is no content in a response don't throw an error the second time that content is attempted to be read.
|
|
- Upload data on redirects.
|
|
|
|
0.11.1 (2012-03-30)
|
|
+++++++++++++++++++
|
|
|
|
* POST redirects now break RFC to do what browsers do: Follow up with a GET.
|
|
* New ``strict_mode`` configuration to disable new redirect behavior.
|
|
|
|
|
|
0.11.0 (2012-03-14)
|
|
+++++++++++++++++++
|
|
|
|
* Private SSL Certificate support
|
|
* Remove select.poll from Gevent monkeypatching
|
|
* Remove redundant generator for chunked transfer encoding
|
|
* Fix: Response.ok raises Timeout Exception in safe_mode
|
|
|
|
0.10.8 (2012-03-09)
|
|
+++++++++++++++++++
|
|
|
|
* Generate chunked ValueError fix
|
|
* Proxy configuration by environment variables
|
|
* Simplification of iter_lines.
|
|
* New `trust_env` configuration for disabling system/environment hints.
|
|
* Suppress cookie errors.
|
|
|
|
0.10.7 (2012-03-07)
|
|
+++++++++++++++++++
|
|
|
|
* `encode_uri` = False
|
|
|
|
0.10.6 (2012-02-25)
|
|
+++++++++++++++++++
|
|
|
|
* Allow '=' in cookies.
|
|
|
|
0.10.5 (2012-02-25)
|
|
+++++++++++++++++++
|
|
|
|
* Response body with 0 content-length fix.
|
|
* New async.imap.
|
|
* Don't fail on netrc.
|
|
|
|
|
|
0.10.4 (2012-02-20)
|
|
+++++++++++++++++++
|
|
|
|
* Honor netrc.
|
|
|
|
0.10.3 (2012-02-20)
|
|
+++++++++++++++++++
|
|
|
|
* HEAD requests don't follow redirects anymore.
|
|
* raise_for_status() doesn't raise for 3xx anymore.
|
|
* Make Session objects picklable.
|
|
* ValueError for invalid schema URLs.
|
|
|
|
0.10.2 (2012-01-15)
|
|
+++++++++++++++++++
|
|
|
|
* Vastly improved URL quoting.
|
|
* Additional allowed cookie key values.
|
|
* Attempted fix for "Too many open files" Error
|
|
* Replace unicode errors on first pass, no need for second pass.
|
|
* Append '/' to bare-domain urls before query insertion.
|
|
* Exceptions now inherit from RuntimeError.
|
|
* Binary uploads + auth fix.
|
|
* Bugfixes.
|
|
|
|
|
|
0.10.1 (2012-01-23)
|
|
+++++++++++++++++++
|
|
|
|
* PYTHON 3 SUPPORT!
|
|
* Dropped 2.5 Support. (*Backwards Incompatible*)
|
|
|
|
0.10.0 (2012-01-21)
|
|
+++++++++++++++++++
|
|
|
|
* ``Response.content`` is now bytes-only. (*Backwards Incompatible*)
|
|
* New ``Response.text`` is unicode-only.
|
|
* If no ``Response.encoding`` is specified and ``chardet`` is available, ``Response.text`` will guess an encoding.
|
|
* Default to ISO-8859-1 (Western) encoding for "text" subtypes.
|
|
* Removal of `decode_unicode`. (*Backwards Incompatible*)
|
|
* New multiple-hooks system.
|
|
* New ``Response.register_hook`` for registering hooks within the pipeline.
|
|
* ``Response.url`` is now Unicode.
|
|
|
|
0.9.3 (2012-01-18)
|
|
++++++++++++++++++
|
|
|
|
* SSL verify=False bugfix (apparent on windows machines).
|
|
|
|
0.9.2 (2012-01-18)
|
|
++++++++++++++++++
|
|
|
|
* Asynchronous async.send method.
|
|
* Support for proper chunk streams with boundaries.
|
|
* session argument for Session classes.
|
|
* Print entire hook tracebacks, not just exception instance.
|
|
* Fix response.iter_lines from pending next line.
|
|
* Fix but in HTTP-digest auth w/ URI having query strings.
|
|
* Fix in Event Hooks section.
|
|
* Urllib3 update.
|
|
|
|
|
|
0.9.1 (2012-01-06)
|
|
++++++++++++++++++
|
|
|
|
* danger_mode for automatic Response.raise_for_status()
|
|
* Response.iter_lines refactor
|
|
|
|
0.9.0 (2011-12-28)
|
|
++++++++++++++++++
|
|
|
|
* verify ssl is default.
|
|
|
|
|
|
0.8.9 (2011-12-28)
|
|
++++++++++++++++++
|
|
|
|
* Packaging fix.
|
|
|
|
|
|
0.8.8 (2011-12-28)
|
|
++++++++++++++++++
|
|
|
|
* SSL CERT VERIFICATION!
|
|
* Release of Cerifi: Mozilla's cert list.
|
|
* New 'verify' argument for SSL requests.
|
|
* Urllib3 update.
|
|
|
|
0.8.7 (2011-12-24)
|
|
++++++++++++++++++
|
|
|
|
* iter_lines last-line truncation fix
|
|
* Force safe_mode for async requests
|
|
* Handle safe_mode exceptions more consistently
|
|
* Fix iteration on null responses in safe_mode
|
|
|
|
0.8.6 (2011-12-18)
|
|
++++++++++++++++++
|
|
|
|
* Socket timeout fixes.
|
|
* Proxy Authorization support.
|
|
|
|
0.8.5 (2011-12-14)
|
|
++++++++++++++++++
|
|
|
|
* Response.iter_lines!
|
|
|
|
0.8.4 (2011-12-11)
|
|
++++++++++++++++++
|
|
|
|
* Prefetch bugfix.
|
|
* Added license to installed version.
|
|
|
|
0.8.3 (2011-11-27)
|
|
++++++++++++++++++
|
|
|
|
* Converted auth system to use simpler callable objects.
|
|
* New session parameter to API methods.
|
|
* Display full URL while logging.
|
|
|
|
0.8.2 (2011-11-19)
|
|
++++++++++++++++++
|
|
|
|
* New Unicode decoding system, based on over-ridable `Response.encoding`.
|
|
* Proper URL slash-quote handling.
|
|
* Cookies with ``[``, ``]``, and ``_`` allowed.
|
|
|
|
0.8.1 (2011-11-15)
|
|
++++++++++++++++++
|
|
|
|
* URL Request path fix
|
|
* Proxy fix.
|
|
* Timeouts fix.
|
|
|
|
0.8.0 (2011-11-13)
|
|
++++++++++++++++++
|
|
|
|
* Keep-alive support!
|
|
* Complete removal of Urllib2
|
|
* Complete removal of Poster
|
|
* Complete removal of CookieJars
|
|
* New ConnectionError raising
|
|
* Safe_mode for error catching
|
|
* prefetch parameter for request methods
|
|
* OPTION method
|
|
* Async pool size throttling
|
|
* File uploads send real names
|
|
* Vendored in urllib3
|
|
|
|
0.7.6 (2011-11-07)
|
|
++++++++++++++++++
|
|
|
|
* Digest authentication bugfix (attach query data to path)
|
|
|
|
0.7.5 (2011-11-04)
|
|
++++++++++++++++++
|
|
|
|
* Response.content = None if there was an invalid response.
|
|
* Redirection auth handling.
|
|
|
|
0.7.4 (2011-10-26)
|
|
++++++++++++++++++
|
|
|
|
* Session Hooks fix.
|
|
|
|
0.7.3 (2011-10-23)
|
|
++++++++++++++++++
|
|
|
|
* Digest Auth fix.
|
|
|
|
|
|
0.7.2 (2011-10-23)
|
|
++++++++++++++++++
|
|
|
|
* PATCH Fix.
|
|
|
|
|
|
0.7.1 (2011-10-23)
|
|
++++++++++++++++++
|
|
|
|
* Move away from urllib2 authentication handling.
|
|
* Fully Remove AuthManager, AuthObject, &c.
|
|
* New tuple-based auth system with handler callbacks.
|
|
|
|
|
|
0.7.0 (2011-10-22)
|
|
++++++++++++++++++
|
|
|
|
* Sessions are now the primary interface.
|
|
* Deprecated InvalidMethodException.
|
|
* PATCH fix.
|
|
* New config system (no more global settings).
|
|
|
|
|
|
0.6.6 (2011-10-19)
|
|
++++++++++++++++++
|
|
|
|
* Session parameter bugfix (params merging).
|
|
|
|
|
|
0.6.5 (2011-10-18)
|
|
++++++++++++++++++
|
|
|
|
* Offline (fast) test suite.
|
|
* Session dictionary argument merging.
|
|
|
|
|
|
0.6.4 (2011-10-13)
|
|
++++++++++++++++++
|
|
|
|
* Automatic decoding of unicode, based on HTTP Headers.
|
|
* New ``decode_unicode`` setting.
|
|
* Removal of ``r.read/close`` methods.
|
|
* New ``r.faw`` interface for advanced response usage.*
|
|
* Automatic expansion of parameterized headers.
|
|
|
|
|
|
0.6.3 (2011-10-13)
|
|
++++++++++++++++++
|
|
|
|
* Beautiful ``requests.async`` module, for making async requests w/ gevent.
|
|
|
|
|
|
0.6.2 (2011-10-09)
|
|
++++++++++++++++++
|
|
|
|
* GET/HEAD obeys allow_redirects=False.
|
|
|
|
|
|
0.6.1 (2011-08-20)
|
|
++++++++++++++++++
|
|
|
|
* Enhanced status codes experience ``\o/``
|
|
* Set a maximum number of redirects (``settings.max_redirects``)
|
|
* Full Unicode URL support
|
|
* Support for protocol-less redirects.
|
|
* Allow for arbitrary request types.
|
|
* Bugfixes
|
|
|
|
|
|
0.6.0 (2011-08-17)
|
|
++++++++++++++++++
|
|
|
|
* New callback hook system
|
|
* New persistent sessions object and context manager
|
|
* Transparent Dict-cookie handling
|
|
* Status code reference object
|
|
* Removed Response.cached
|
|
* Added Response.request
|
|
* All args are kwargs
|
|
* Relative redirect support
|
|
* HTTPError handling improvements
|
|
* Improved https testing
|
|
* Bugfixes
|
|
|
|
|
|
0.5.1 (2011-07-23)
|
|
++++++++++++++++++
|
|
|
|
* International Domain Name Support!
|
|
* Access headers without fetching entire body (``read()``)
|
|
* Use lists as dicts for parameters
|
|
* Add Forced Basic Authentication
|
|
* Forced Basic is default authentication type
|
|
* ``python-requests.org`` default User-Agent header
|
|
* CaseInsensitiveDict lower-case caching
|
|
* Response.history bugfix
|
|
|
|
|
|
0.5.0 (2011-06-21)
|
|
++++++++++++++++++
|
|
|
|
* PATCH Support
|
|
* Support for Proxies
|
|
* HTTPBin Test Suite
|
|
* Redirect Fixes
|
|
* settings.verbose stream writing
|
|
* Querystrings for all methods
|
|
* URLErrors (Connection Refused, Timeout, Invalid URLs) are treated as explicitly raised
|
|
``r.requests.get('hwe://blah'); r.raise_for_status()``
|
|
|
|
|
|
0.4.1 (2011-05-22)
|
|
++++++++++++++++++
|
|
|
|
* Improved Redirection Handling
|
|
* New 'allow_redirects' param for following non-GET/HEAD Redirects
|
|
* Settings module refactoring
|
|
|
|
|
|
0.4.0 (2011-05-15)
|
|
++++++++++++++++++
|
|
|
|
* Response.history: list of redirected responses
|
|
* Case-Insensitive Header Dictionaries!
|
|
* Unicode URLs
|
|
|
|
|
|
0.3.4 (2011-05-14)
|
|
++++++++++++++++++
|
|
|
|
* Urllib2 HTTPAuthentication Recursion fix (Basic/Digest)
|
|
* Internal Refactor
|
|
* Bytes data upload Bugfix
|
|
|
|
|
|
|
|
0.3.3 (2011-05-12)
|
|
++++++++++++++++++
|
|
|
|
* Request timeouts
|
|
* Unicode url-encoded data
|
|
* Settings context manager and module
|
|
|
|
|
|
0.3.2 (2011-04-15)
|
|
++++++++++++++++++
|
|
|
|
* Automatic Decompression of GZip Encoded Content
|
|
* AutoAuth Support for Tupled HTTP Auth
|
|
|
|
|
|
0.3.1 (2011-04-01)
|
|
++++++++++++++++++
|
|
|
|
* Cookie Changes
|
|
* Response.read()
|
|
* Poster fix
|
|
|
|
|
|
0.3.0 (2011-02-25)
|
|
++++++++++++++++++
|
|
|
|
* Automatic Authentication API Change
|
|
* Smarter Query URL Parameterization
|
|
* Allow file uploads and POST data together
|
|
* New Authentication Manager System
|
|
- Simpler Basic HTTP System
|
|
- Supports all build-in urllib2 Auths
|
|
- Allows for custom Auth Handlers
|
|
|
|
|
|
0.2.4 (2011-02-19)
|
|
++++++++++++++++++
|
|
|
|
* Python 2.5 Support
|
|
* PyPy-c v1.4 Support
|
|
* Auto-Authentication tests
|
|
* Improved Request object constructor
|
|
|
|
0.2.3 (2011-02-15)
|
|
++++++++++++++++++
|
|
|
|
* New HTTPHandling Methods
|
|
- Response.__nonzero__ (false if bad HTTP Status)
|
|
- Response.ok (True if expected HTTP Status)
|
|
- Response.error (Logged HTTPError if bad HTTP Status)
|
|
- Response.raise_for_status() (Raises stored HTTPError)
|
|
|
|
|
|
0.2.2 (2011-02-14)
|
|
++++++++++++++++++
|
|
|
|
* Still handles request in the event of an HTTPError. (Issue #2)
|
|
* Eventlet and Gevent Monkeypatch support.
|
|
* Cookie Support (Issue #1)
|
|
|
|
|
|
0.2.1 (2011-02-14)
|
|
++++++++++++++++++
|
|
|
|
* Added file attribute to POST and PUT requests for multipart-encode file uploads.
|
|
* Added Request.url attribute for context and redirects
|
|
|
|
|
|
0.2.0 (2011-02-14)
|
|
++++++++++++++++++
|
|
|
|
* Birth!
|
|
|
|
|
|
0.0.1 (2011-02-13)
|
|
++++++++++++++++++
|
|
|
|
* Frustration
|
|
* Conception
|
|
|
|
|
|
|