diff options
| author | Michael <github@unlikely.org> | 2016-08-03 13:03:34 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-08-03 13:03:34 -0700 |
| commit | 07b7872df8df67eaf61e6374c39767219e9155d7 (patch) | |
| tree | d6f7c94c973750828a595f9801ef5fba4a02d307 /docs | |
| parent | be12b27d7120b9f3e56dbaa889661abf6f5ff7f2 (diff) | |
| download | python-requests-07b7872df8df67eaf61e6374c39767219e9155d7.tar.gz | |
Add a bit about RequestsCookieJar to Cookies section
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/user/quickstart.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 3be3489f..ea87eecc 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -416,6 +416,19 @@ parameter:: >>> r = requests.get(url, cookies=cookies) >>> r.text '{"cookies": {"cookies_are": "working"}}' + +Cookies are returned in a :class:`~requests.cookies.RequestsCookieJar`, +which acts like a ``dict`` but also offers a more complete interface, +suitable for use over multiple domains or paths. Cookie jars can +also be passed in to requests:: + + >>> jar = requests.cookies.RequestsCookieJar() + >>> jar.set('tasty_cookie', 'yum', site='httpbin.org', path='/cookies') + >>> jar.set('gross_cookie', 'blech', site='httpbin.org', path='/elsewhere') + >>> url = 'http://httpbin.org/cookies' + >>> r = requests.get(url, cookies=jar) + >>> r.text + '{"cookies": {"tasty_cookie": "yum"}}' Redirection and History |