diff options
Diffstat (limited to 'requests/api.py')
| -rw-r--r-- | requests/api.py | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/requests/api.py b/requests/api.py index e0bf346..4a39211 100644 --- a/requests/api.py +++ b/requests/api.py @@ -7,12 +7,13 @@ requests.api This module implements the Requests API. :copyright: (c) 2012 by Kenneth Reitz. -:license: ISC, see LICENSE for more details. +:license: Apache2, see LICENSE for more details. """ from . import sessions + def request(method, url, **kwargs): """Constructs and sends a :class:`Request <Request>`. Returns :class:`Response <Response>` object. @@ -20,7 +21,7 @@ def request(method, url, **kwargs): :param method: method for the new :class:`Request` object. :param url: URL for the new :class:`Request` object. :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`. - :param data: (optional) Dictionary or bytes to send in the body of the :class:`Request`. + :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`. :param cookies: (optional) Dict or CookieJar object to send with the :class:`Request`. :param files: (optional) Dictionary of 'name': file-like-objects (or {'name': ('filename', fileobj)}) for multipart encoding upload. @@ -28,17 +29,19 @@ def request(method, url, **kwargs): :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. - :param return_response: (optional) If False, an un-sent Request object will returned. - :param session: (optional) A :class:`Session` object to be used for the request. - :param config: (optional) A configuration dictionary. :param verify: (optional) if ``True``, the SSL cert will be verified. A CA_BUNDLE path can also be provided. - :param prefetch: (optional) if ``True``, the response content will be immediately downloaded. + :param stream: (optional) if ``False``, the response content will be immediately downloaded. :param cert: (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair. - """ - s = kwargs.pop('session') if 'session' in kwargs else sessions.session() - return s.request(method=method, url=url, **kwargs) + Usage:: + + >>> import requests + >>> req = requests.request('GET', 'http://httpbin.org/get') + <Response [200]> + """ + session = sessions.Session() + return session.request(method=method, url=url, **kwargs) def get(url, **kwargs): @@ -70,7 +73,6 @@ def head(url, **kwargs): :param \*\*kwargs: Optional arguments that ``request`` takes. """ - kwargs.setdefault('allow_redirects', False) return request('head', url, **kwargs) @@ -78,7 +80,7 @@ def post(url, data=None, **kwargs): """Sends a POST request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. - :param data: (optional) Dictionary or bytes to send in the body of the :class:`Request`. + :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. :param \*\*kwargs: Optional arguments that ``request`` takes. """ @@ -89,7 +91,7 @@ def put(url, data=None, **kwargs): """Sends a PUT request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. - :param data: (optional) Dictionary or bytes to send in the body of the :class:`Request`. + :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. :param \*\*kwargs: Optional arguments that ``request`` takes. """ @@ -100,7 +102,7 @@ def patch(url, data=None, **kwargs): """Sends a PATCH request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. - :param data: (optional) Dictionary or bytes to send in the body of the :class:`Request`. + :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. :param \*\*kwargs: Optional arguments that ``request`` takes. """ |