Add assert_called() and assert_called_once() methods for mock objects

[AmitSaha]

BPO	26323
Nosy	@vstinner, @rbtcollins, @voidspace, @kushaldas, @The-Compiler
Files	issue26323.patch: Patch issue26323.patch: Modified patch issue26323.patch: Updated patch issue26323.patch issue26323.patch: Updated patch with docs issue26323.patch: Updated patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/voidspace'
closed_at = <Date 2016-03-12.01:08:34.151>
created_at = <Date 2016-02-10.00:00:45.206>
labels = ['type-feature', 'library']
title = 'Add assert_called() and assert_called_once() methods for mock objects'
updated_at = <Date 2016-03-12.01:08:34.151>
user = 'https://bugs.python.org/AmitSaha'

bugs.python.org fields:

activity = <Date 2016-03-12.01:08:34.151>
actor = 'berker.peksag'
assignee = 'michael.foord'
closed = True
closed_date = <Date 2016-03-12.01:08:34.151>
closer = 'berker.peksag'
components = ['Library (Lib)']
creation = <Date 2016-02-10.00:00:45.206>
creator = 'Amit.Saha'
dependencies = []
files = ['41903', '41904', '41946', '41952', '41961', '41997']
hgrepos = []
issue_num = 26323
keywords = ['patch']
message_count = 24.0
messages = ['259960', '259981', '260143', '260144', '260409', '260410', '260412', '260428', '260432', '260451', '260453', '260454', '260456', '260487', '260646', '260647', '260656', '260722', '260728', '260836', '261584', '261605', '261606', '261623']
nosy_count = 8.0
nosy_names = ['vstinner', 'rbcollins', 'michael.foord', 'python-dev', 'kushal.das', 'Amit.Saha', 'The Compiler', 'Amit Saha']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue26323'
versions = ['Python 3.6']

[AmitSaha]

Would a patch for adding a assert_called() method to mocked objects be welcome for inclusion? We do have a assert_not_called() method, so I think this may be a good idea. Please let me know and I will work on it.

[The-Compiler]

I agree this would be useful. "assert themock.called" (or self.assertTrue) works, but always trips me up.

[AmitSaha]

Please take a look at the attached patch.

[AmitSaha]

Fixed the test name

[vstinner]

If we go into this direction, I suggest to add *two* methods:

• assert_called(): called at least once
• assert_called_once(): called exactly once

I would be more consitent with the existing API:

https://docs.python.org/dev/library/unittest.mock.html#unittest.mock.Mock.assert_not_called

https://docs.python.org/dev/library/unittest.mock.html#unittest.mock.Mock.assert_called_with

https://docs.python.org/dev/library/unittest.mock.html#unittest.mock.Mock.assert_called_once_with

[vstinner]

I would be more consitent with the existing API:

Hum, I'm not sure that I was clear.

If we only add assert_called() (without assert_called_once()), users may use assert_called() to check if a function is called exactly once which would be a mistake.

[AmitSaha]

Thanks for your comments. I am +1 to those additions and would be happy to update the patch. Let me know if I should go ahead.

[kushaldas]

Go ahead and update the patch for assert_called_once and related tests.

[AmitSaha]

Added assert_call_once()

[vstinner]

I reviewed your patch.

[AmitSaha]

Thanks for the review. Updated patch addressing the comments.

[AmitSaha]

Updated patch