diff options
Diffstat (limited to 'requests/api.py')
-rw-r--r-- | requests/api.py | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/requests/api.py b/requests/api.py new file mode 100644 index 0000000..0e27410 --- /dev/null +++ b/requests/api.py @@ -0,0 +1,121 @@ +# -*- coding: utf-8 -*- + +""" +requests.api +~~~~~~~~~~~~ + +This module impliments the Requests API. + +:copyright: (c) 2011 by Kenneth Reitz. +:license: ISC, see LICENSE for more details. + +""" + +import requests +import config +from .models import Request, Response, AuthManager, AuthObject, auth_manager + + +__all__ = ('request', 'get', 'head', 'post', 'put', 'delete') + + + +def request(method, url, **kwargs): + """Constructs and sends a :class:`Request <models.Request>`. Returns :class:`Response <models.Response>` object. + + :param method: method for the new :class:`Request` object. + :param url: URL for the new :class:`Request` object. + :param params: (optional) Dictionary of GET/HEAD/DELETE Parameters to send with the :class:`Request`. + :param data: (optional) Bytes/Dictionary of PUT/POST Data to send with the :class:`Request`. + :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`. + :param cookies: (optional) CookieJar object to send with the :class:`Request`. + :param files: (optional) Dictionary of 'filename': file-like-objects for multipart encoding upload. + :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. + """ + data = kwargs.pop('data', dict()) or kwargs.pop('params', dict()) + + r = Request(method=method, url=url, data=data, headers=kwargs.pop('headers', dict()), + cookiejar=kwargs.get('cookies', None), + files=kwargs.get('files', None), + auth=kwargs.get('auth', auth_manager.get_auth(url)), + timeout=kwargs.get('timeout', config.settings.timeout), + allow_redirects=kwargs.get('allow_redirects', None) + ) + + r.send() + + return r.response + + +def get(url, params={}, headers={}, cookies=None, auth=None, **kwargs): + """Sends a GET request. Returns :class:`Response` object. + + :param url: URL for the new :class:`Request` object. + :param params: (optional) Dictionary of GET Parameters to send with the :class:`Request`. + :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`. + :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. + """ + + return request('GET', url, params=params, headers=headers, cookies=cookies, auth=auth, **kwargs) + + +def head(url, params={}, headers={}, cookies=None, auth=None, **kwargs): + """Sends a HEAD request. Returns :class:`Response` object. + + :param url: URL for the new :class:`Request` object. + :param params: (optional) Dictionary of GET Parameters to send with the :class:`Request`. + :param headers: (optional) Dictionary of HTTP Headers to sent with the :class:`Request`. + :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. + """ + + return request('HEAD', url, params=params, headers=headers, cookies=cookies, auth=auth, **kwargs) + + +def post(url, data={}, headers={}, files=None, cookies=None, auth=None, **kwargs): + """Sends a POST request. Returns :class:`Response` object. + + :param url: URL for the new :class:`Request` object. + :param data: (optional) Dictionary of POST data to send with the :class:`Request`. + :param headers: (optional) Dictionary of HTTP Headers to sent with the :class:`Request`. + :param files: (optional) Dictionary of 'filename': file-like-objects for multipart encoding upload. + :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. + """ + + return request('POST', url, data=data, headers=headers, files=files, cookies=cookies, auth=auth, **kwargs) + + +def put(url, data='', headers={}, files={}, cookies=None, auth=None, **kwargs): + """Sends a PUT request. Returns :class:`Response` object. + + :param url: URL for the new :class:`Request` object. + :param params: (optional) Bytes of PUT Data to send with the :class:`Request`. + :param headers: (optional) Dictionary of HTTP Headers to sent with the :class:`Request`. + :param files: (optional) Dictionary of 'filename': file-like-objects for multipart encoding upload. + :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. + """ + + return request('PUT', url, data=data, headers=headers, files=files, cookies=cookies, auth=auth, **kwargs) + + +def delete(url, params={}, headers={}, cookies=None, auth=None, **kwargs): + """Sends a DELETE request. Returns :class:`Response` object. + + :param url: URL for the new :class:`Request` object. + :param params: (optional) Dictionary of DELETE Parameters to send with the :class:`Request`. + :param headers: (optional) Dictionary of HTTP Headers to sent with the :class:`Request`. + :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. + """ + + return request('DELETE', url, params=params, headers=headers, cookies=cookies, auth=auth, **kwargs) |