Visitar URL original
bpo-37555: Update _CallList.__contains__ to respect ANY by ElizabethU · Pull Request #14700 · python/cpython · GitHub
Skip to content

bpo-37555: Update _CallList.__contains__ to respect ANY #14700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pganssle merged 20 commits into from
Sep 13, 2019
Merged

bpo-37555: Update _CallList.__contains__ to respect ANY #14700

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
94ddf54
Flip equality to use mock calls' __eq__
ElizabethU Jul 11, 2019
b4c7d78
bpo-37555: Regression test demonstrating assert_has_calls not working…
ElizabethU Jul 14, 2019
ad99a9d
Revert "Flip equality to use mock calls' __eq__"
ElizabethU Jul 14, 2019
49c5310
bpo-37555: Add regression tests for mock ANY ordering issues
ElizabethU Jul 15, 2019
874fb69
bpo-37555: Fix _CallList and _Call order sensitivity
ElizabethU Jul 18, 2019
d72d6f5
bpo-37555: Ensure _call_matcher returns _Call object
ElizabethU Jul 20, 2019
f0e8411
Adding ACK and news entry
ElizabethU Jul 20, 2019
f295eac
bpo-37555: Replacing __eq__ with == to sidestep NotImplemented
ElizabethU Jul 20, 2019
18e964b
bpo-37555: cleaning up changes unnecessary to the final product
ElizabethU Jul 20, 2019
883841a
bpo-37555: Fixed call on bound arguments to respect args and kwargs
ElizabethU Jul 20, 2019
f4844c7
Revert "bpo-37555: Add regression tests for mock ANY ordering issues"
ElizabethU Jul 22, 2019
84489c8
Revert "bpo-37555: cleaning up changes unnecessary to the final product"
ElizabethU Jul 22, 2019
344ef17
Revert "bpo-37555: Replacing __eq__ with == to sidestep NotImplemented"
ElizabethU Jul 22, 2019
bdf430d
Revert "bpo-37555: Fix _CallList and _Call order sensitivity"
ElizabethU Jul 22, 2019
d3522b1
Updated NEWS.d
ElizabethU Jul 22, 2019
f47699d
bpo-37555: Add tests checking every function using _call_matcher both…
ElizabethU Aug 4, 2019
38650c9
bpo-37555: Ensure all assert methods using _call_matcher are actually…
ElizabethU Aug 5, 2019
24973c0
Remove AnyCompare and use call objects everywhere.
tirkarthi Aug 19, 2019
001d708
Revert "Remove AnyCompare and use call objects everywhere."
ElizabethU Sep 13, 2019
25dec66
Check for exception in assert_any_await
ElizabethU Sep 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
bpo-37555: Fix _CallList and _Call order sensitivity 
_Call and _CallList depend on ordering to correctly process that an object being compared to ANY with __eq__ should return True. This fix updates the comparison to check both a == b and b == a and return True if either condition is met, fixing situations from the tests in the previous two commits where assertEqual would not be commutative if checking _Call or _CallList objects. This seems like a reasonable fix considering that the Python data model specifies that if an object doesn't know how to compare itself to another object it should return NotImplemented, and that on getting NotImplemented from a == b, it should try b == a, implying that good behavior for __eq__ is commutative. This also flips the order of comparison in _CallList's __contains__ method, guaranteeing ANY will be on the left and have it's __eq__ called for equality checking, fixing the interaction between assert_has_calls and ANY.

Co-author: Neal Finne <neal@neal.finne.com>
  • Loading branch information
@ElizabethU
ElizabethU committed Jul 18, 2019
commit 874fb697b8376fcea130116e56189061f944fde6
17 changes: 13 additions & 4 deletions Lib/unittest/mock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Comment thread
pganssle marked this conversation as resolved.
Outdated
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.__eq__(other_list) or other_list.__eq__(self_list)


def _check_and_set_parent(parent, value, name, new_name):
# function passed to create_autospec will have mock
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.__eq__(other_params)
or other_params.__eq__(self_params)
)


__ne__ = object.__ne__
Expand Down