kennethreitz/requests
1
0
Fork 0
mirror of https://github.com/kennethreitz/requests.git synced 2026-06-05 22:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2536 from smiley/master

Browse Source 
Document that "PreparedRequest.prepare_cookies" can only be called once
This commit is contained in:
Kenneth Reitz
2015-04-06 18:29:17 -04:00
parent a57c87a459 e3c7b43fc9
commit b0c008c593
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
requests/models.py
+9 -1
View File
@@ -501,7 +501,15 @@ class PreparedRequest(RequestEncodingMixin, RequestHooksMixin):
self.prepare_content_length(self.body)
def prepare_cookies(self, cookies):
"""Prepares the given HTTP cookie data."""
"""Prepares the given HTTP cookie data.
This function eventually generates a ``Cookie`` header from the
given cookies using cookielib. Due to cookielib's design, the header
will not be regenerated if it already exists, meaning this function
can only be called once for the life of the
:class:`PreparedRequest <PreparedRequest>` object. Any subsequent calls
to ``prepare_cookies`` will have no actual effect, unless the "Cookie"
header is removed beforehand."""
if isinstance(cookies, cookielib.CookieJar):
self._cookies = cookies