#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.

diff --git a/Doc/library/http.cookies.rst b/Doc/library/http.cookies.rst
index 46c3bbd9d96ab1fbeb20e08e4f6d61f6d315f912..5c3fbc8df1ade442e6b06aa6fffb5d356f783faa 100644 (file)
--- 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

diff --git a/Doc/whatsnew/3.5.rst b/Doc/whatsnew/3.5.rst
index c13289a727bbdce185525be3fcbb6b9d20985d19..868b6b28d9865fc6b99a1f5c30c16f842020ef91 100644 (file)
--- a/Doc/whatsnew/3.5.rst
+++ b/Doc/whatsnew/3.5.rst
@@ -525,11 +525,12 @@ Deprecated Python modules, functions and methods
   ``True``, but this default is deprecated.  Specify the *decode_data* keyword
   with an appropriate value to avoid the deprecation warning.
 
-* :class:`~http.cookies.Morsel` has previously allowed for setting attributes
-  :attr:`~http.cookies.Morsel.key`, :attr:`~http.cookies.Morsel.value` and
-  :attr:`~http.cookies.Morsel.coded_value`. Use the preferred
-  :func:`~http.cookies.Morsel.set` method in order to avoid the deprecation
-  warning.
+* Directly assigning values to the :attr:`~http.cookies.Morsel.key`,
+  :attr:`~http.cookies.Morsel.value` and
+  :attr:`~http.cookies.Morsel.coded_value` of :class:`~http.cookies.Morsel`
+  objects is deprecated.  Use the :func:`~http.cookies.Morsel.set` method
+  instead.  In addition, the undocumented *LegalChars* parameter of
+  :func:`~http.cookies.Morsel.set` is deprecated, and is now ignored.
 
 * Passing a format string as keyword argument *format_string* to the
   :meth:`~string.Formatter.format` method of the :class:`string.Formatter`
@@ -635,6 +636,16 @@ Changes in the Python API
   string (e.g. ``'x+'`` instead of ``'x*'``).  Patterns that could only match
   an empty string (such as ``'\b'``) now raise an error.
 
+* The :class:`~http.cookies.Morsel` dict-like interface has been made self
+  consistent:  morsel comparison now takes the :attr:`~http.cookies.Morsel.key`
+  and :attr:`~http.cookies.Morsel.value` into account,
+  :meth:`~http.cookies.Morsel.copy` now results in a
+  :class:`~http.cookies.Morsel` instance rather than a *dict*, and
+  :meth:`~http.cookies.Morsel.update` will no raise an exception if any of the
+  keys in the update dictionary are invalid.  In addition, the undocumented
+  *LegalChars* parameter of :func:`~http.cookies.Morsel.set` is deprecated and
+  is now ignored.  (:issue:`2211`)
+
 Changes in the C API
 --------------------
 

diff --git a/Lib/http/cookies.py b/Lib/http/cookies.py
index 98489fb3c8af35e7a5a100e48a6872ba6bea82ed..26c9ac40c2c8a1c889da00730525f951f7f17280 100644 (file)
--- a/Lib/http/cookies.py
+++ b/Lib/http/cookies.py
@@ -366,7 +366,14 @@ class Morsel(dict):
     def isReservedKey(self, K):
         return K.lower() in self._reserved
 
-    def set(self, key, val, coded_val):
+    def set(self, key, val, coded_val, LegalChars=_LegalChars):
+        if LegalChars != _LegalChars:
+            import warnings
+            warnings.warn(
+                'LegalChars parameter is deprecated, ignored and will '
+                'be removed in future versions.', DeprecationWarning,
+                stacklevel=2)
+
         if key.lower() in self._reserved:
             raise CookieError('Attempt to set a reserved key %r' % (key,))
         if not _is_legal_key(key):

diff --git a/Lib/test/test_http_cookies.py b/Lib/test/test_http_cookies.py
index 5f1e74bbc6cb3df448b1664d67ca045bd3fa3bb9..cf0f6b9a40a317fbfd55a094eba03de104ae754d 100644 (file)
--- a/Lib/test/test_http_cookies.py
+++ b/Lib/test/test_http_cookies.py
@@ -261,6 +261,8 @@ class MorselTests(unittest.TestCase):
             morsel.value = ''
         with self.assertWarnsRegex(DeprecationWarning, r'\bcoded_value\b'):
             morsel.coded_value = ''
+        with self.assertWarnsRegex(DeprecationWarning, r'\bLegalChars\b'):
+            morsel.set('key', 'value', 'coded_value', LegalChars='.*')
 
     def test_eq(self):
         base_case = ('key', 'value', '"value"')