Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Closes #1280 #1283

merged 2 commits into from Apr 4, 2013
Jump to file or symbol
Failed to load files and symbols.
+37 −7
@@ -75,8 +75,42 @@ request, and then the request's headers::
>>> r.request.headers
{'Accept-Encoding': 'identity, deflate, compress, gzip',
- 'Accept': '*/*', 'User-Agent': 'python-requests/0.13.1'}
+ 'Accept': '*/*', 'User-Agent': 'python-requests/1.2.0'}
+Prepared Requests
+Whenever you receive a :class:`Response <requests.models.Response>` object
+from an API call or a Session call, the ``request`` attribute is actually the
+``PreparedRequest`` that was used. In some cases you may wish to do some extra
+work to the body or headers (or anything else really) before sending a
+request. The simple recipe for this is the following::
+ from requests import Request, Session
+ s = Session()
+ prepped = Request('GET', # or any other method, 'POST', 'PUT', etc.
+ url,
+ data=data
+ headers=headers
+ # ...
+ ).prepare()
+ # do something with prepped.body
+ # do something with prepped.headers
+ resp = s.send(prepped,
+ stream=stream,
+ verify=verify,
+ proxies=proxies,
+ cert=cert,
+ timeout=timeout,
+ # etc.
+ )
+ print(resp.status_code)
+Since you are not doing anything special with the ``Request`` object, you
+prepare it immediately and modified the ``PreparedRequest`` object. You then
+send that with the other parameters you would have sent to ``requests.*`` or
SSL Cert Verification
@@ -274,12 +274,8 @@ def request(self, method, url,
: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 stream: (optional) whether to immediately download the response
+ content. Defaults to ``False``.
: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).