From e32840f6319eb1879a4828dc410b50352877fb64 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Wed, 2 Nov 2011 20:39:06 -0400 Subject: [PATCH] fix request docs --- requests/api.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/requests/api.py b/requests/api.py index 34febf25..a139f3d5 100644 --- a/requests/api.py +++ b/requests/api.py @@ -29,6 +29,23 @@ def request(method, url, hooks=None, return_response=True, config=None): + """Constructs and sends a :class:`Request `. + Returns :class:`Response ` object. + + :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 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 'filename': file-like-objects for multipart encoding upload. + :param auth: (optional) Auth typle to enable Basic/Digest/Custom 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. + :param return_response: (optional) If False, an un-sent Request object will returned. + :param config: (optional) A configuration dictionary. + """ s = session() return s.request(