Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Closes #1280 #1283

Merged
merged 2 commits into from

2 participants

@sigmavirus24
Collaborator

I'll close #1280 after you merge this by hand. I forgot to include it in the commit message.

@sigmavirus24 sigmavirus24 Closes #1280
Correct the doc-string for Session#request that I copied without thinking
about.
1abd137
@sigmavirus24
Collaborator

Sorry, had to rebase and whatnot

@sigmavirus24
Collaborator

Also added documentation about using PreparedRequests. I might split that off into a separate pull request if you'd rather.

@kennethreitz
Owner

<3

@kennethreitz kennethreitz merged commit dccfc5b into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Apr 2, 2013
  1. @sigmavirus24

    Closes #1280

    sigmavirus24 authored
    Correct the doc-string for Session#request that I copied without thinking
    about.
  2. @sigmavirus24
This page is out of date. Refresh to see the latest.
Showing with 37 additions and 7 deletions.
  1. +35 −1 docs/user/advanced.rst
  2. +2 −6 requests/sessions.py
View
36 docs/user/advanced.rst
@@ -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
+``Sesssion.*``.
SSL Cert Verification
---------------------
View
8 requests/sessions.py
@@ -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).
Something went wrong with that request. Please try again.