Added docs regarding requests.session to docs/user/advanced.rst
authorTom Hogans <tomhsx@gmail.com>
Tue, 16 Aug 2011 06:00:11 +0000 (02:00 -0400)
committerTom Hogans <tomhsx@gmail.com>
Tue, 16 Aug 2011 06:00:11 +0000 (02:00 -0400)
docs/user/advanced.rst

index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..066ebdef0dfacc80bdc246b86e4cee9ee83c8990 100644 (file)
@@ -0,0 +1,22 @@
+.. _advanced:
+
+Advanced Usage
+==============
+
+This document covers more advanced features.
+
+Session Objects
+===============
+
+.. module:: requests.session 
+
+The Session object allows you to persist certain parameters across requests.  It also establishes a CookieJar by default and passes it along in any requests made from the Session instance.  For a complete list of allowed parameters, please see the *__attrs__* field in *requests/session.py*. ::
+
+    from requests.session import Session
+
+    s = Session()
+    s.get("http://httpbin.org/cookies/set/sessioncookie/123456789")
+    r = s.get("http://httpbin.org/cookies")
+    print r.content
+
+Note: Certain parameters are best set at the request.config level (i.e. a global proxy, user agent header).