bpo-37555: Update _CallList.__contains__ to respect ANY

Lib/unittest/mock.py

@@ -337,13 +337,19 @@ def __contains__(self, value):
 
         for i in range(0, len_self - len_value + 1):
             sub_list = self[i:i+len_value]
-            if sub_list == value:
+            if value == sub_list:
                 return True
         return False
 
     def __repr__(self):
         return pprint.pformat(list(self))
 
+    def __eq__(self, other):
+        self_list = list(self)
+        other_list = list(other)
+        # checking equality both directions is necessary for ANY to work
+        return self_list == other_list or other_list == self_list
+
 
 def _check_and_set_parent(parent, value, name, new_name):
     # function passed to create_autospec will have mock
@@ -814,7 +820,7 @@ def _call_matcher(self, _call):
             else:
                 name, args, kwargs = _call
             try:
-                return name, sig.bind(*args, **kwargs)
+                return call(name, sig.bind(*args, **kwargs))
             except TypeError as e:
                 return e.with_traceback(None)
         else:
@@ -2293,7 +2299,6 @@ def _format_call_signature(name, args, kwargs):
     return message % formatted_args
 
 
-
 class _Call(tuple):
     """
     A tuple for holding the results of a call to a mock, either in the form
@@ -2403,8 +2408,12 @@ def __eq__(self, other):
         if self_name and other_name != self_name:
             return False
 
-        # this order is important for ANY to work!
-        return (other_args, other_kwargs) == (self_args, self_kwargs)
+        self_params = self_args, self_kwargs
+        other_params = other_args, other_kwargs
+        return (
+            self_params == other_params
+            or other_params == self_params
+        )
 
 
     __ne__ = object.__ne__

Lib/unittest/test/testmock/testhelpers.py

@@ -63,7 +63,19 @@ def __ne__(self, other): pass
             ]
             self.assertEqual(expected, mock.mock_calls)
             self.assertEqual(mock.mock_calls, expected)
+            mock.assert_has_calls(expected)
 
+    def test_assert_has_calls_with_any_and_spec_set(self):
+        # This is a regression test for bpo-37555
+        class Foo(object):
+            def __eq__(self, other): pass
+            def __ne__(self, other): pass
+
+        mock = Mock(spec_set=Foo)
+        expected = [call(ANY)]
+        mock(Foo())
+
+        mock.assert_has_calls(expected)
 
 
 class CallTest(unittest.TestCase):
@@ -310,6 +322,16 @@ def test_call_list(self):
         kall = call(1).method(2)(3).foo.bar.baz(4)(5).__int__()
         self.assertEqual(kall.call_list(), mock.mock_calls)
 
+    def test_call_list_with_any_comparison_order(self):
+        class Foo:
+            def __eq__(self, other): pass
+            def __ne__(self, other): pass
+
+        mock = MagicMock()
+        mock(Foo())
+
+        self.assertEqual(call(ANY).call_list(), mock.mock_calls)
+        self.assertEqual(mock.mock_calls, call(ANY).call_list())
 
     def test_call_any(self):
         self.assertEqual(call, ANY)
@@ -319,6 +341,16 @@ def test_call_any(self):
         self.assertEqual(m.mock_calls, [ANY])
         self.assertEqual([ANY], m.mock_calls)
 
+    def test_call_any_comparison_order(self):
+        class Foo:
+            def __eq__(self, other): pass
+            def __ne__(self, other): pass
+
+        m = MagicMock()
+        m(Foo())
+
+        self.assertEqual(m.mock_calls[0], call(ANY))
+        self.assertEqual(call(ANY), m.mock_calls[0])
 
     def test_two_args_call(self):
         args = _Call(((1, 2), {'a': 3}), two=True)

Misc/ACKS

@@ -496,6 +496,7 @@ Tomer Filiba
 Segev Finer
 Jeffrey Finkelstein
 Russell Finn
+Neal Finne
 Dan Finnie
 Nils Fischbeck
 Frederik Fix
@@ -1699,6 +1700,7 @@ Roger Upole
 Daniel Urban
 Michael Urman
 Hector Urtubia
+Elizabeth Uselton
 Lukas Vacek
 Ville Vainio
 Andi Vajda

Misc/NEWS.d/next/Library/2019-07-19-20-13-48.bpo-37555.S5am28.rst

@@ -0,0 +1,4 @@
+Fix `NonCallableMock._call_matcher` returning tuple instead of `_Call` object
+when `self._spec_signature` exists. Additionally fix `__eq__` to be
+commutative on `_Call` and `_CallList`, to better account for `ANY`. Patch by
+Elizabeth Uselton