Project description

Requests is the only Non-GMO HTTP library for Python, safe for human
consumption.

Warning: Recreational use of other HTTP libraries may result in dangerous side-effects,
including: security vulnerabilities, verbose code, reinventing the wheel,
constantly reading documentation, depression, headaches, or even death.

Requests allows you to send organic, grass-fed HTTP/1.1 requests, without the
need for manual labor. There’s no need to manually add query strings to your
URLs, or to form-encode your POST data. Keep-alive and HTTP connection pooling
are 100% automatic, powered by urllib3,
which is embedded within Requests.

Besides, all the cool kids are doing it. Requests is one of the most
downloaded Python packages of all time, pulling in over 7,000,000 downloads
every month. You don’t want to be left out!

Installation

Documentation

How to 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.

Release History

2.12.1 (2016-11-16)

Bugfixes

Updated setuptools ‘security’ extra for the new PyOpenSSL backend in urllib3.

Miscellaneous

Updated bundled urllib3 to 1.19.1.

2.12.0 (2016-11-15)

Improvements

Updated support for internationalized domain names from IDNA2003 to IDNA2008.
This updated support is required for several forms of IDNs and is mandatory
for .de domains.

Much improved heuristics for guessing content lengths: Requests will no
longer read an entire StringIO into memory.

Much improved logic for recalculating Content-Length headers for
PreparedRequest objects.

Improved tolerance for file-like objects that have no tell method but
do have a seek method.

Anything that is a subclass of Mapping is now treated like a dictionary
by the data= keyword argument.

Requests now tolerates empty passwords in proxy credentials, rather than
stripping the credentials.

If a request is made with a file-like object as the body and that request is
redirected with a 307 or 308 status code, Requests will now attempt to
rewind the body object so it can be replayed.

Bugfixes

When calling response.close, the call to close will be propagated
through to non-urllib3 backends.

Fixed issue where the ALL_PROXY environment variable would be preferred
over scheme-specific variables like HTTP_PROXY.

Fixed a bug where Requests would not correctly correlate cookies set when
using custom Host headers if those Host headers did not use the native
string type for the platform.

Miscellaneous

Updated bundled urllib3 to 1.19.

Updated bundled certifi certs to 2016.09.26.

2.11.1 (2016-08-17)

Bugfixes

Fixed a bug when using iter_content with decode_unicode=True for
streamed bodies would raise AttributeError. This bug was introduced in
2.11.

Strip Content-Type and Transfer-Encoding headers from the header block when
following a redirect that transforms the verb from POST/PUT to GET.

2.11.0 (2016-08-08)

Improvements

Added support for the ALL_PROXY environment variable.

Reject header values that contain leading whitespace or newline characters to
reduce risk of header smuggling.

Bugfixes

Fixed occasional TypeError when attempting to decode a JSON response that
occurred in an error case. Now correctly returns a ValueError.

Requests would incorrectly ignore a non-CIDR IP address in the NO_PROXY
environment variables: Requests now treats it as a specific IP.

Fixed a bug when sending JSON data that could cause us to encounter obscure
OpenSSL errors in certain network conditions (yes, really).

Added type checks to ensure that iter_content only accepts integers and
None for chunk sizes.

Fixed issue where responses whose body had not been fully consumed would have
the underlying connection closed but not returned to the connection pool,
which could cause Requests to hang in situations where the HTTPAdapter
had been configured to use a blocking connection pool.

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.

2.8.1 (2015-10-13)

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.

2.6.2 (2015-04-23)

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. 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.2 (2015-02-23)

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)

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.