summaryrefslogtreecommitdiffstats
path: root/Doc/library/http.cookies.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2015-03-29 21:09:21 (GMT)
committerR David Murray <rdmurray@bitdance.com>2015-03-29 21:09:21 (GMT)
commit1813c1701f8e7e9287bccf66d1b4b8348c432168 (patch)
tree07d91a6490d90cdfbd84618daf79354c831343bd /Doc/library/http.cookies.rst
parent0deefd5a9402e3bd13ed899f9b939062faf98114 (diff)
downloadcpython-1813c1701f8e7e9287bccf66d1b4b8348c432168.zip
cpython-1813c1701f8e7e9287bccf66d1b4b8348c432168.tar.gz
cpython-1813c1701f8e7e9287bccf66d1b4b8348c432168.tar.bz2
#2211: properly document the Morsel behavior changes.
Also deprecate the undocumented set argument instead of removing it already in 3.5. Initial patch by Demian Brecht.
Diffstat (limited to 'Doc/library/http.cookies.rst')
-rw-r--r--Doc/library/http.cookies.rst35
1 files changed, 29 insertions, 6 deletions
diff --git a/Doc/library/http.cookies.rst b/Doc/library/http.cookies.rst
index 46c3bbd..5c3fbc8 100644
--- a/Doc/library/http.cookies.rst
+++ b/Doc/library/http.cookies.rst
@@ -143,14 +143,17 @@ Morsel Objects
The keys are case-insensitive.
+ .. versionchanged:: 3.5
+ :meth:`~Morsel.__eq__` now takes :attr:`~Morsel.key` and :attr:`~Morsel.value`
+ into account.
+
.. attribute:: Morsel.value
The value of the cookie.
.. deprecated:: 3.5
- Setting :attr:`~Morsel.value` directly has been deprecated in favour of
- using :func:`~Morsel.set`
+ assigning to ``value``; use :meth:`~Morsel.set` instead.
.. attribute:: Morsel.coded_value
@@ -158,8 +161,7 @@ Morsel Objects
The encoded value of the cookie --- this is what should be sent.
.. deprecated:: 3.5
- Setting :attr:`~Morsel.coded_value` directly has been deprecated in
- favour of using :func:`~Morsel.set`
+ assigning to ``coded_value``; use :meth:`~Morsel.set` instead.
.. attribute:: Morsel.key
@@ -167,14 +169,17 @@ Morsel Objects
The name of the cookie.
.. deprecated:: 3.5
- Setting :attr:`~Morsel.key` directly has been deprecated in
- favour of using :func:`~Morsel.set`
+ assigning to ``key``; use :meth:`~Morsel.set` instead.
.. method:: Morsel.set(key, value, coded_value)
Set the *key*, *value* and *coded_value* attributes.
+ .. deprecated:: 3.5
+ The undocumented *LegalChars* parameter is ignored and will be removed in
+ a future version.
+
.. method:: Morsel.isReservedKey(K)
@@ -205,6 +210,24 @@ Morsel Objects
The meaning for *attrs* is the same as in :meth:`output`.
+.. method:: Morsel.update(values)
+
+ Update the values in the Morsel dictionary with the values in the dictionary
+ *values*. Raise an error if any of the keys in the *values* dict is not a
+ valid :rfc:`2109` attribute.
+
+ .. versionchanged:: 3.5
+ an error is raised for invalid keys.
+
+
+.. method:: Morsel.copy(value)
+
+ Return a shallow copy of the Morsel object.
+
+ .. versionchanged:: 3.5
+ return a Morsel object instead of a dict.
+
+
.. _cookie-example:
Example