.. autofunction:: request
----------------------
-
-.. autoclass:: requests.Request
- :inherited-members:
-
-.. autoclass:: Response
- :inherited-members:
-
----------------------
-
.. autofunction:: head
.. autofunction:: get
.. autofunction:: post
.. autofunction:: delete
------------------
+Lower-Level Classes
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: requests.Request
+ :inherited-members:
+
+.. autoclass:: Response
+ :inherited-members:
-.. autofunction:: session
+Sessions
+--------
.. autoclass:: Session
:inherited-members:
:param auth: Auth handler or (user, pass) tuple.
:param cookies: dictionary or CookieJar of cookies to attach to this request.
:param hooks: dictionary of callback hooks, for internal usage.
+
+ Usage::
+
+ >>> import requests
+ >>> req = requests.Request('GET', 'http://httpbin.org/get')
+ >>> req.prepare()
+ <PreparedRequest [GET]>
+
"""
def __init__(self,
method=None,
"""The fully mutable :class:`PreparedRequest <PreparedRequest>` object,
containing the exact bytes that will be sent to the server.
- Generated from a :class:`Request <Request>` object or manually.
+ Generated from either a :class:`Request <Request>` object or manually.
+
+ Usage::
+
+ >>> import requests
+ >>> req = requests.Request('GET', 'http://httpbin.org/get')
+ >>> r = req.prepare()
+ <PreparedRequest [GET]>
+
+ >>> s = requests.Session()
+ >>> s.send(r)
+ <Response [200]>
+
"""
def __init__(self):
class Session(SessionRedirectMixin):
- """A Requests session."""
+ """A Requests session.
+
+ Provides cookie persistience, connection-pooling, and configuration.
+
+ Basic Usage::
+
+ >>> import requests
+ >>> s = requests.Session()
+ >>> s.get('http://httpbin.org/get')
+ 200
+ """
def __init__(self):
#: :class:`Session <Session>`.
self.headers = default_headers()
- #: Authentication tuple or object to attach to
+ #: Default Authentication tuple or object to attach to
#: :class:`Request <Request>`.
self.auth = None
#: representing multivalued query parameters.
self.params = {}
- #: Stream response content.
+ #: Stream response content default.
self.stream = False
- #: SSL Verification.
+ #: SSL Verification default.
self.verify = True
- #: SSL certificate.
+ #: SSL certificate default.
self.cert = None
#: Maximum number of redirects to follow.
self.max_redirects = DEFAULT_REDIRECT_LIMIT
- #: Should we trust the environment
+ #: Should we trust the environment?
self.trust_env = True
# Set up a CookieJar to be used by default