]> granicus.if.org Git - python/commitdiff
Fix #18007 : Document CookieJar.add_cookie_header request parameter changes in 3.3
authorSenthil Kumaran <senthil@uthcode.com>
Thu, 23 May 2013 12:27:38 +0000 (05:27 -0700)
committerSenthil Kumaran <senthil@uthcode.com>
Thu, 23 May 2013 12:27:38 +0000 (05:27 -0700)
Doc/library/http.cookiejar.rst

index 40f24f23b95c7473187a4b17d7f4828a04162ad9..34bfa875efe24b4e27dd8ca3bf1d5329930a51c3 100644 (file)
@@ -154,9 +154,15 @@ contained :class:`Cookie` objects.
 
    The *request* object (usually a :class:`urllib.request..Request` instance)
    must support the methods :meth:`get_full_url`, :meth:`get_host`,
-   :meth:`get_type`, :meth:`unverifiable`, :meth:`get_origin_req_host`,
-   :meth:`has_header`, :meth:`get_header`, :meth:`header_items`, and
-   :meth:`add_unredirected_header`, as documented by :mod:`urllib.request`.
+   :meth:`get_type`, :meth:`unverifiable`, :meth:`has_header`,
+   :meth:`get_header`, :meth:`header_items`, :meth:`add_unredirected_header`
+   and :attr:`origin_req_host` attribute as documented by
+   :mod:`urllib.request`.
+
+   .. versionchanged:: 3.3
+
+    *request* object needs :attr:`origin_req_host` attribute. Dependency on a
+    deprecated method :meth:`get_origin_req_host` has been removed.
 
 
 .. method:: CookieJar.extract_cookies(response, request)
@@ -174,11 +180,15 @@ contained :class:`Cookie` objects.
 
    The *request* object (usually a :class:`urllib.request.Request` instance)
    must support the methods :meth:`get_full_url`, :meth:`get_host`,
-   :meth:`unverifiable`, and :meth:`get_origin_req_host`, as documented by
-   :mod:`urllib.request`.  The request is used to set default values for
+   :meth:`unverifiable`, and :attr:`origin_req_host` attribute, as documented
+   by :mod:`urllib.request`.  The request is used to set default values for
    cookie-attributes as well as for checking that the cookie is allowed to be
    set.
 
+   .. versionchanged:: 3.3
+
+    *request* object needs :attr:`origin_req_host` attribute. Dependency on a
+    deprecated method :meth:`get_origin_req_host` has been removed.
 
 .. method:: CookieJar.set_policy(policy)