Restore Session.request docstring

Resolves #1251
This commit is contained in:
Ian Cordasco
2013-03-27 23:46:21 -04:00
parent 88177ec33f
commit aca91e06f2
+33
View File
@@ -252,6 +252,39 @@ class Session(SessionRedirectMixin):
stream=None,
verify=None,
cert=None):
"""Constructs a :class:`Request <Request>`, prepares it and sends it.
Returns :class:`Response <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 tuple or callable 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 by default.
: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. See
``request.defaults`` for allowed keys and their default values.
:param prefetch: (optional) whether to immediately download the response
content. Defaults to ``True``.
:param verify: (optional) if ``True``, the SSL cert will be verified.
A CA_BUNDLE path can also be provided.
:param cert: (optional) if String, path to ssl client cert file (.pem).
If Tuple, ('cert', 'key') pair.
"""
cookies = cookies or {}
proxies = proxies or {}