diff options
| author | moliware <miguel@moliware.com> | 2011-06-19 22:36:50 +0200 |
|---|---|---|
| committer | moliware <miguel@moliware.com> | 2011-06-19 22:36:50 +0200 |
| commit | 3e7c682e66fb4b276c8343bb718d8b13037cea15 (patch) | |
| tree | 64edacaf313457c70f26c809d638a4324c3f92ad /requests/api.py | |
| parent | bbd1e40bd57322fb0f41a0ab202c2b788de053c5 (diff) | |
| download | python-requests-3e7c682e66fb4b276c8343bb718d8b13037cea15.tar.gz | |
Support for proxies
Diffstat (limited to 'requests/api.py')
| -rw-r--r-- | requests/api.py | 34 |
1 files changed, 22 insertions, 12 deletions
diff --git a/requests/api.py b/requests/api.py index cf2e575e..f3445e21 100644 --- a/requests/api.py +++ b/requests/api.py @@ -19,7 +19,7 @@ from .models import Request, Response, AuthManager, AuthObject, auth_manager __all__ = ('request', 'get', 'head', 'post', 'put', 'delete') def request(method, url, params=None, data=None, headers=None, cookies=None, files=None, auth=None, - timeout=None, allow_redirects=False): + timeout=None, allow_redirects=False, proxies=None): """Constructs and sends a :class:`Request <models.Request>`. Returns :class:`Response <models.Response>` object. :param method: method for the new :class:`Request` object. @@ -32,6 +32,7 @@ def request(method, url, params=None, data=None, headers=None, cookies=None, fil :param auth: (optional) AuthObject to enable Basic HTTP Auth. :param timeout: (optional) Float describing the timeout of the request. :param allow_redirects: (optional) Boolean. Set to True if POST/PUT/DELETE redirect following is allowed. + :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy. """ r = Request( @@ -44,14 +45,15 @@ def request(method, url, params=None, data=None, headers=None, cookies=None, fil files = files, auth = auth or auth_manager.get_auth(url), timeout = timeout or config.settings.timeout, - allow_redirects = allow_redirects + allow_redirects = allow_redirects, + proxies = proxies ) r.send() return r.response -def get(url, params=None, headers=None, cookies=None, auth=None, timeout=None): +def get(url, params=None, headers=None, cookies=None, auth=None, timeout=None, proxies=None): """Sends a GET request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. @@ -60,12 +62,14 @@ def get(url, params=None, headers=None, cookies=None, auth=None, timeout=None): :param cookies: (optional) CookieJar object to send with the :class:`Request`. :param auth: (optional) AuthObject to enable Basic HTTP Auth. :param timeout: (optional) Float describing the timeout of the request. + :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy. """ - return request('GET', url, params=params, headers=headers, cookies=cookies, auth=auth, timeout=timeout) + return request('GET', url, params=params, headers=headers, cookies=cookies, auth=auth, timeout=timeout, + proxies=proxies) -def head(url, params=None, headers=None, cookies=None, auth=None, timeout=None): +def head(url, params=None, headers=None, cookies=None, auth=None, timeout=None, proxies=None): """Sends a HEAD request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. @@ -74,13 +78,15 @@ def head(url, params=None, headers=None, cookies=None, auth=None, timeout=None): :param cookies: (optional) CookieJar object to send with the :class:`Request`. :param auth: (optional) AuthObject to enable Basic HTTP Auth. :param timeout: (optional) Float describing the timeout of the request. + :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy. """ - return request('HEAD', url, params=params, headers=headers, cookies=cookies, auth=auth, timeout=timeout) + return request('HEAD', url, params=params, headers=headers, cookies=cookies, auth=auth, timeout=timeout, + proxies=proxies) def post(url, data='', headers=None, files=None, cookies=None, auth=None, - timeout=None, allow_redirects=False, params=None): + timeout=None, allow_redirects=False, params=None, proxies=None): """Sends a POST request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. @@ -92,15 +98,16 @@ def post(url, data='', headers=None, files=None, cookies=None, auth=None, :param timeout: (optional) Float describing the timeout of the request. :param allow_redirects: (optional) Boolean. Set to True if redirect following is allowed. :param params: (optional) Dictionary of parameters, or bytes, to be sent in the query string for the :class:`Request`. + :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy. """ return request('POST', url, params=params, data=data, headers=headers, files=files, cookies=cookies, auth=auth, timeout=timeout, - allow_redirects=allow_redirects) + allow_redirects=allow_redirects, proxies=proxies) def put(url, data='', headers=None, files=None, cookies=None, auth=None, - timeout=None, allow_redirects=False, params=None): + timeout=None, allow_redirects=False, params=None, proxies=None): """Sends a PUT request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. @@ -112,14 +119,16 @@ def put(url, data='', headers=None, files=None, cookies=None, auth=None, :param timeout: (optional) Float describing the timeout of the request. :param allow_redirects: (optional) Boolean. Set to True if redirect following is allowed. :param params: (optional) Dictionary of parameters, or bytes, to be sent in the query string for the :class:`Request`. + :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy. """ return request('PUT', url, params=params, data=data, headers=headers, files=files, cookies=cookies, auth=auth, timeout=timeout, - allow_redirects=allow_redirects) + allow_redirects=allow_redirects, proxies=proxies) -def delete(url, params=None, headers=None, cookies=None, auth=None, timeout=None, allow_redirects=False): +def delete(url, params=None, headers=None, cookies=None, auth=None, timeout=None, allow_redirects=False, + proxies=None): """Sends a DELETE request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. @@ -129,7 +138,8 @@ def delete(url, params=None, headers=None, cookies=None, auth=None, timeout=None :param auth: (optional) AuthObject to enable Basic HTTP Auth. :param timeout: (optional) Float describing the timeout of the request. :param allow_redirects: (optional) Boolean. Set to True if redirect following is allowed. + :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy. """ return request('DELETE', url, params=params, headers=headers, cookies=cookies, auth=auth, - timeout=timeout, allow_redirects=allow_redirects) + timeout=timeout, allow_redirects=allow_redirects, proxies=proxies) |
