Skip to content

[WIP] bpo-17013: Implement WaitableMock to create Mock objects that can wait until called #12818

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

Closed
tirkarthi wants to merge 8 commits into from
Closed

[WIP] bpo-17013: Implement WaitableMock to create Mock objects that can wait until called #12818

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
826a69e
Initial commit for WaitableMock
tirkarthi Apr 13, 2019
aa73fbc
Add tests and docs
tirkarthi Apr 13, 2019
0f0482e
Add NEWS entry
tirkarthi Apr 13, 2019
f51f5b7
Use defaultdict for event object creation
tirkarthi Apr 13, 2019
a941ca1
Use proper attributes and assert for mock_calls
tirkarthi Apr 13, 2019
3031310
Remove unused lambda for defaultdict
tirkarthi Apr 13, 2019
c67715b
Don't use default event for empty args and use helper for thread crea…
tirkarthi Apr 13, 2019
5b59f34
Allow defaultdict to take care of missing event objects
tirkarthi Apr 14, 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
Allow defaultdict to take care of missing event objects
  • Loading branch information
@tirkarthi
tirkarthi committed Apr 14, 2019
commit 5b59f340d99d092a1cac973ccae8784a39682e4b
8 changes: 1 addition & 7 deletions Lib/unittest/mock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2495,7 +2495,6 @@ class WaitableMock(MagicMock):

def __init__(self, *args, event_class=threading.Event, **kwargs):
_safe_super(WaitableMock, self).__init__(*args, **kwargs)
self._event_class = event_class
self._event = event_class()
Copy link
Copy Markdown
Member

@vstinner vstinner Apr 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The usage self._event vs self._expected_calls which contains events is non obvious. Can add a comment to explain where each event is used and how.

self._expected_calls = defaultdict(event_class)

Expand All @@ -2522,12 +2521,7 @@ def wait_until_called_with(self, *args, timeout=1.0):

`timeout` - time to wait for in seconds. Defaults to 1.
Copy link
Copy Markdown
Contributor

@mariocj89 mariocj89 Apr 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t have a great alternative, but feels a pity if users cannot wait for calls that had a timeout parameter as discussed in the issue.

Copy link
Copy Markdown
Member Author

@tirkarthi tirkarthi Apr 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I would wait if someone has a less conflicting name or perhaps receive kwargs_dict as a dictionary instead of (**kwargs, timeout) that fixes conflict but the API would be nice to pass keyword arguments as **kwargs itself.

"""
if args not in self._expected_calls:
event = self._event_class()
self._expected_calls[args] = event
else:
event = self._expected_calls[args]

event = self._expected_calls[args]
return event.wait(timeout=timeout)


Expand Down