[issue22609] Constructors of some mapping classes don't accept `self` keyword argument

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Thank you for your review Berker.

> Is there a reason not to use assertWarnsRegex?

Initially the patch was written for 2.7. Fixing WeakValueDictionary in 2.7 
needs first fix UserDict (issue22958). That is why I returned to this issue.

> Also, there are already collections.UserDict() usages in the test file, so
> I'd remove the "from collections import UserDict" import.

These tests originally was written for test_collections.

Updated patch addresses Berker's comment.

----------
Added file: http://bugs.python.org/file38754/UserDict_self_and_dict_keywords_2.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue22609>
_______________________________________
-------------- next part --------------
diff -r 34bd8fee3006 Lib/collections/__init__.py
--- a/Lib/collections/__init__.py	Tue Mar 31 07:20:03 2015 +0300
+++ b/Lib/collections/__init__.py	Tue Mar 31 08:19:07 2015 +0300
@@ -924,7 +924,23 @@ class ChainMap(MutableMapping):
 class UserDict(MutableMapping):
 
     # Start by filling-out the abstract methods
-    def __init__(self, dict=None, **kwargs):
+    def __init__(*args, **kwargs):
+        if not args:
+            raise TypeError("descriptor '__init__' of 'UserDict' object "
+                            "needs an argument")
+        self, *args = args
+        if len(args) > 1:
+            raise TypeError('expected at most 1 arguments, got %d' % len(args))
+        if args:
+            dict = args[0]
+        else:
+            if 'dict' in kwargs:
+                dict = kwargs.pop('dict')
+                import warnings
+                warnings.warn("Passing 'dict' as keyword argument is "
+                              "deprecated", DeprecationWarning, stacklevel=2)
+            else:
+                dict = None
         self.data = {}
         if dict is not None:
             self.update(dict)
diff -r 34bd8fee3006 Lib/test/test_userdict.py
--- a/Lib/test/test_userdict.py	Tue Mar 31 07:20:03 2015 +0300
+++ b/Lib/test/test_userdict.py	Tue Mar 31 08:19:07 2015 +0300
@@ -2,6 +2,7 @@
 
 from test import support, mapping_tests
 import collections
+from collections import UserDict
 
 d0 = {}
 d1 = {"one": 1}
@@ -29,7 +30,8 @@ class UserDictTest(mapping_tests.TestHas
         self.assertEqual(collections.UserDict(one=1, two=2), d2)
         # item sequence constructor
         self.assertEqual(collections.UserDict([('one',1), ('two',2)]), d2)
-        self.assertEqual(collections.UserDict(dict=[('one',1), ('two',2)]), d2)
+        with self.assertWarnsRegex(DeprecationWarning, 'dict'):
+            self.assertEqual(collections.UserDict(dict=[('one',1), ('two',2)]), d2)
         # both together
         self.assertEqual(collections.UserDict([('one',1), ('two',2)], two=3, three=5), d3)
 
@@ -139,6 +141,30 @@ class UserDictTest(mapping_tests.TestHas
         self.assertEqual(t.popitem(), ("x", 42))
         self.assertRaises(KeyError, t.popitem)
 
+    def test_init(self):
+        for kw in 'self', 'other', 'iterable':
+            self.assertEqual(list(collections.UserDict(**{kw: 42}).items()),
+                             [(kw, 42)])
+        self.assertEqual(list(collections.UserDict({}, dict=42).items()),
+                         [('dict', 42)])
+        self.assertEqual(list(collections.UserDict({}, dict=None).items()),
+                         [('dict', None)])
+        with self.assertWarnsRegex(DeprecationWarning, 'dict'):
+            self.assertEqual(list(collections.UserDict(dict={'a': 42}).items()),
+                             [('a', 42)])
+        self.assertRaises(TypeError, collections.UserDict, 42)
+        self.assertRaises(TypeError, collections.UserDict, (), ())
+        self.assertRaises(TypeError, collections.UserDict.__init__)
+
+    def test_update(self):
+        for kw in 'self', 'dict', 'other', 'iterable':
+            d = collections.UserDict()
+            d.update(**{kw: 42})
+            self.assertEqual(list(d.items()), [(kw, 42)])
+        self.assertRaises(TypeError, collections.UserDict().update, 42)
+        self.assertRaises(TypeError, collections.UserDict().update, {}, {})
+        self.assertRaises(TypeError, collections.UserDict.update)
+
     def test_missing(self):
         # Make sure UserDict doesn't have a __missing__ method
         self.assertEqual(hasattr(collections.UserDict, "__missing__"), False)