[Python-checkins] [3.8] bpo-38136: Updates await_count and call_count to be different things (GH-16192) (GH-16431)
Lisa Roach
webhook-mailer at python.org
Fri Sep 27 18:44:38 EDT 2019
https://github.com/python/cpython/commit/52bdd414ed9da7c62c312c542803753986a0040a
commit: 52bdd414ed9da7c62c312c542803753986a0040a
branch: 3.8
author: Lisa Roach <lisaroach14 at gmail.com>
committer: GitHub <noreply at github.com>
date: 2019-09-27T15:44:34-07:00
summary:
[3.8] bpo-38136: Updates await_count and call_count to be different things (GH-16192) (GH-16431)
files:
A Misc/NEWS.d/next/Library/2019-09-16-09-54-42.bpo-38136.MdI-Zb.rst
M Doc/library/unittest.mock.rst
M Lib/unittest/mock.py
M Lib/unittest/test/testmock/testasync.py
M Lib/unittest/test/testmock/testmock.py
diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index b446ddb3598f..300f28c8e2ce 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -514,21 +514,6 @@ the *new_callable* argument to :func:`patch`.
>>> mock.call_count
2
- For :class:`AsyncMock` the :attr:`call_count` is only iterated if the function
- has been awaited:
-
- >>> mock = AsyncMock()
- >>> mock() # doctest: +SKIP
- <coroutine object AsyncMockMixin._mock_call at ...>
- >>> mock.call_count
- 0
- >>> async def main():
- ... await mock()
- ...
- >>> asyncio.run(main())
- >>> mock.call_count
- 1
-
.. attribute:: return_value
Set this to configure the value returned by calling the mock:
@@ -907,19 +892,22 @@ object::
.. method:: assert_awaited()
- Assert that the mock was awaited at least once.
+ Assert that the mock was awaited at least once. Note that this is separate
+ from the object having been called, the ``await`` keyword must be used:
>>> mock = AsyncMock()
- >>> async def main():
- ... await mock()
+ >>> async def main(coroutine_mock):
+ ... await coroutine_mock
...
- >>> asyncio.run(main())
+ >>> coroutine_mock = mock()
+ >>> mock.called
+ True
>>> mock.assert_awaited()
- >>> mock_2 = AsyncMock()
- >>> mock_2.assert_awaited()
Traceback (most recent call last):
...
AssertionError: Expected mock to have been awaited.
+ >>> asyncio.run(main(coroutine_mock))
+ >>> mock.assert_awaited()
.. method:: assert_awaited_once()
@@ -1004,14 +992,15 @@ object::
... await mock(*args, **kwargs)
...
>>> calls = [call("foo"), call("bar")]
- >>> mock.assert_has_calls(calls)
+ >>> mock.assert_has_awaits(calls)
Traceback (most recent call last):
...
- AssertionError: Calls not found.
+ AssertionError: Awaits not found.
Expected: [call('foo'), call('bar')]
+ Actual: []
>>> asyncio.run(main('foo'))
>>> asyncio.run(main('bar'))
- >>> mock.assert_has_calls(calls)
+ >>> mock.assert_has_awaits(calls)
.. method:: assert_not_awaited()
diff --git a/Lib/unittest/mock.py b/Lib/unittest/mock.py
index 30f4663e5ef4..5ea562428a12 100644
--- a/Lib/unittest/mock.py
+++ b/Lib/unittest/mock.py
@@ -1070,14 +1070,20 @@ def __call__(self, /, *args, **kwargs):
# can't use self in-case a function / method we are mocking uses self
# in the signature
self._mock_check_sig(*args, **kwargs)
+ self._increment_mock_call(*args, **kwargs)
return self._mock_call(*args, **kwargs)
def _mock_call(self, /, *args, **kwargs):
+ return self._execute_mock_call(*args, **kwargs)
+
+ def _increment_mock_call(self, /, *args, **kwargs):
self.called = True
self.call_count += 1
# handle call_args
+ # needs to be set here so assertions on call arguments pass before
+ # execution in the case of awaited calls
_call = _Call((args, kwargs), two=True)
self.call_args = _call
self.call_args_list.append(_call)
@@ -1117,6 +1123,10 @@ def _mock_call(self, /, *args, **kwargs):
# follow the parental chain:
_new_parent = _new_parent._mock_new_parent
+ def _execute_mock_call(self, /, *args, **kwargs):
+ # seperate from _increment_mock_call so that awaited functions are
+ # executed seperately from their call
+
effect = self.side_effect
if effect is not None:
if _is_exception(effect):
diff --git a/Lib/unittest/test/testmock/testasync.py b/Lib/unittest/test/testmock/testasync.py
index af53210d97b3..86b0d0ee9a13 100644
--- a/Lib/unittest/test/testmock/testasync.py
+++ b/Lib/unittest/test/testmock/testasync.py
@@ -3,8 +3,8 @@
import re
import unittest
-from unittest.mock import (call, AsyncMock, patch, MagicMock, create_autospec,
- _AwaitEvent)
+from unittest.mock import (ANY, call, AsyncMock, patch, MagicMock,
+ create_autospec, _AwaitEvent, sentinel, _CallList)
def tearDownModule():
@@ -591,11 +591,173 @@ class AsyncMockAssert(unittest.TestCase):
def setUp(self):
self.mock = AsyncMock()
- async def _runnable_test(self, *args):
- if not args:
- await self.mock()
- else:
- await self.mock(*args)
+ async def _runnable_test(self, *args, **kwargs):
+ await self.mock(*args, **kwargs)
+
+ async def _await_coroutine(self, coroutine):
+ return await coroutine
+
+ def test_assert_called_but_not_awaited(self):
+ mock = AsyncMock(AsyncClass)
+ with self.assertWarns(RuntimeWarning):
+ # Will raise a warning because never awaited
+ mock.async_method()
+ self.assertTrue(asyncio.iscoroutinefunction(mock.async_method))
+ mock.async_method.assert_called()
+ mock.async_method.assert_called_once()
+ mock.async_method.assert_called_once_with()
+ with self.assertRaises(AssertionError):
+ mock.assert_awaited()
+ with self.assertRaises(AssertionError):
+ mock.async_method.assert_awaited()
+
+ def test_assert_called_then_awaited(self):
+ mock = AsyncMock(AsyncClass)
+ mock_coroutine = mock.async_method()
+ mock.async_method.assert_called()
+ mock.async_method.assert_called_once()
+ mock.async_method.assert_called_once_with()
+ with self.assertRaises(AssertionError):
+ mock.async_method.assert_awaited()
+
+ asyncio.run(self._await_coroutine(mock_coroutine))
+ # Assert we haven't re-called the function
+ mock.async_method.assert_called_once()
+ mock.async_method.assert_awaited()
+ mock.async_method.assert_awaited_once()
+ mock.async_method.assert_awaited_once_with()
+
+ def test_assert_called_and_awaited_at_same_time(self):
+ with self.assertRaises(AssertionError):
+ self.mock.assert_awaited()
+
+ with self.assertRaises(AssertionError):
+ self.mock.assert_called()
+
+ asyncio.run(self._runnable_test())
+ self.mock.assert_called_once()
+ self.mock.assert_awaited_once()
+
+ def test_assert_called_twice_and_awaited_once(self):
+ mock = AsyncMock(AsyncClass)
+ coroutine = mock.async_method()
+ with self.assertWarns(RuntimeWarning):
+ # The first call will be awaited so no warning there
+ # But this call will never get awaited, so it will warn here
+ mock.async_method()
+ with self.assertRaises(AssertionError):
+ mock.async_method.assert_awaited()
+ mock.async_method.assert_called()
+ asyncio.run(self._await_coroutine(coroutine))
+ mock.async_method.assert_awaited()
+ mock.async_method.assert_awaited_once()
+
+ def test_assert_called_once_and_awaited_twice(self):
+ mock = AsyncMock(AsyncClass)
+ coroutine = mock.async_method()
+ mock.async_method.assert_called_once()
+ asyncio.run(self._await_coroutine(coroutine))
+ with self.assertRaises(RuntimeError):
+ # Cannot reuse already awaited coroutine
+ asyncio.run(self._await_coroutine(coroutine))
+ mock.async_method.assert_awaited()
+
+ def test_assert_awaited_but_not_called(self):
+ with self.assertRaises(AssertionError):
+ self.mock.assert_awaited()
+ with self.assertRaises(AssertionError):
+ self.mock.assert_called()
+ with self.assertRaises(TypeError):
+ # You cannot await an AsyncMock, it must be a coroutine
+ asyncio.run(self._await_coroutine(self.mock))
+
+ with self.assertRaises(AssertionError):
+ self.mock.assert_awaited()
+ with self.assertRaises(AssertionError):
+ self.mock.assert_called()
+
+ def test_assert_has_calls_not_awaits(self):
+ kalls = [call('foo')]
+ with self.assertWarns(RuntimeWarning):
+ # Will raise a warning because never awaited
+ self.mock('foo')
+ self.mock.assert_has_calls(kalls)
+ with self.assertRaises(AssertionError):
+ self.mock.assert_has_awaits(kalls)
+
+ def test_assert_has_mock_calls_on_async_mock_no_spec(self):
+ with self.assertWarns(RuntimeWarning):
+ # Will raise a warning because never awaited
+ self.mock()
+ kalls_empty = [('', (), {})]
+ self.assertEqual(self.mock.mock_calls, kalls_empty)
+
+ with self.assertWarns(RuntimeWarning):
+ # Will raise a warning because never awaited
+ self.mock('foo')
+ self.mock('baz')
+ mock_kalls = ([call(), call('foo'), call('baz')])
+ self.assertEqual(self.mock.mock_calls, mock_kalls)
+
+ def test_assert_has_mock_calls_on_async_mock_with_spec(self):
+ a_class_mock = AsyncMock(AsyncClass)
+ with self.assertWarns(RuntimeWarning):
+ # Will raise a warning because never awaited
+ a_class_mock.async_method()
+ kalls_empty = [('', (), {})]
+ self.assertEqual(a_class_mock.async_method.mock_calls, kalls_empty)
+ self.assertEqual(a_class_mock.mock_calls, [call.async_method()])
+
+ with self.assertWarns(RuntimeWarning):
+ # Will raise a warning because never awaited
+ a_class_mock.async_method(1, 2, 3, a=4, b=5)
+ method_kalls = [call(), call(1, 2, 3, a=4, b=5)]
+ mock_kalls = [call.async_method(), call.async_method(1, 2, 3, a=4, b=5)]
+ self.assertEqual(a_class_mock.async_method.mock_calls, method_kalls)
+ self.assertEqual(a_class_mock.mock_calls, mock_kalls)
+
+ def test_async_method_calls_recorded(self):
+ with self.assertWarns(RuntimeWarning):
+ # Will raise warnings because never awaited
+ self.mock.something(3, fish=None)
+ self.mock.something_else.something(6, cake=sentinel.Cake)
+
+ self.assertEqual(self.mock.method_calls, [
+ ("something", (3,), {'fish': None}),
+ ("something_else.something", (6,), {'cake': sentinel.Cake})
+ ],
+ "method calls not recorded correctly")
+ self.assertEqual(self.mock.something_else.method_calls,
+ [("something", (6,), {'cake': sentinel.Cake})],
+ "method calls not recorded correctly")
+
+ def test_async_arg_lists(self):
+ def assert_attrs(mock):
+ names = ('call_args_list', 'method_calls', 'mock_calls')
+ for name in names:
+ attr = getattr(mock, name)
+ self.assertIsInstance(attr, _CallList)
+ self.assertIsInstance(attr, list)
+ self.assertEqual(attr, [])
+
+ assert_attrs(self.mock)
+ with self.assertWarns(RuntimeWarning):
+ # Will raise warnings because never awaited
+ self.mock()
+ self.mock(1, 2)
+ self.mock(a=3)
+
+ self.mock.reset_mock()
+ assert_attrs(self.mock)
+
+ a_mock = AsyncMock(AsyncClass)
+ with self.assertWarns(RuntimeWarning):
+ # Will raise warnings because never awaited
+ a_mock.async_method()
+ a_mock.async_method(1, a=3)
+
+ a_mock.reset_mock()
+ assert_attrs(a_mock)
def test_assert_awaited(self):
with self.assertRaises(AssertionError):
@@ -641,20 +803,20 @@ def test_assert_awaited_once_with(self):
def test_assert_any_wait(self):
with self.assertRaises(AssertionError):
- self.mock.assert_any_await('NormalFoo')
+ self.mock.assert_any_await('foo')
- asyncio.run(self._runnable_test('foo'))
+ asyncio.run(self._runnable_test('baz'))
with self.assertRaises(AssertionError):
- self.mock.assert_any_await('NormalFoo')
+ self.mock.assert_any_await('foo')
- asyncio.run(self._runnable_test('NormalFoo'))
- self.mock.assert_any_await('NormalFoo')
+ asyncio.run(self._runnable_test('foo'))
+ self.mock.assert_any_await('foo')
asyncio.run(self._runnable_test('SomethingElse'))
- self.mock.assert_any_await('NormalFoo')
+ self.mock.assert_any_await('foo')
def test_assert_has_awaits_no_order(self):
- calls = [call('NormalFoo'), call('baz')]
+ calls = [call('foo'), call('baz')]
with self.assertRaises(AssertionError) as cm:
self.mock.assert_has_awaits(calls)
@@ -664,7 +826,7 @@ def test_assert_has_awaits_no_order(self):
with self.assertRaises(AssertionError):
self.mock.assert_has_awaits(calls)
- asyncio.run(self._runnable_test('NormalFoo'))
+ asyncio.run(self._runnable_test('foo'))
with self.assertRaises(AssertionError):
self.mock.assert_has_awaits(calls)
@@ -675,7 +837,7 @@ def test_assert_has_awaits_no_order(self):
self.mock.assert_has_awaits(calls)
def test_assert_has_awaits_ordered(self):
- calls = [call('NormalFoo'), call('baz')]
+ calls = [call('foo'), call('baz')]
with self.assertRaises(AssertionError):
self.mock.assert_has_awaits(calls, any_order=True)
@@ -683,11 +845,11 @@ def test_assert_has_awaits_ordered(self):
with self.assertRaises(AssertionError):
self.mock.assert_has_awaits(calls, any_order=True)
- asyncio.run(self._runnable_test('foo'))
+ asyncio.run(self._runnable_test('bamf'))
with self.assertRaises(AssertionError):
self.mock.assert_has_awaits(calls, any_order=True)
- asyncio.run(self._runnable_test('NormalFoo'))
+ asyncio.run(self._runnable_test('foo'))
self.mock.assert_has_awaits(calls, any_order=True)
asyncio.run(self._runnable_test('qux'))
diff --git a/Lib/unittest/test/testmock/testmock.py b/Lib/unittest/test/testmock/testmock.py
index 817c54822630..6dc2725427ec 100644
--- a/Lib/unittest/test/testmock/testmock.py
+++ b/Lib/unittest/test/testmock/testmock.py
@@ -842,6 +842,7 @@ def test():
def test_setting_call(self):
mock = Mock()
def __call__(self, a):
+ self._increment_mock_call(a)
return self._mock_call(a)
type(mock).__call__ = __call__
@@ -2043,7 +2044,7 @@ def trace(frame, event, arg): # pragma: no cover
)
mocks = [
- Mock, MagicMock, NonCallableMock, NonCallableMagicMock
+ Mock, MagicMock, NonCallableMock, NonCallableMagicMock, AsyncMock
]
for mock in mocks:
diff --git a/Misc/NEWS.d/next/Library/2019-09-16-09-54-42.bpo-38136.MdI-Zb.rst b/Misc/NEWS.d/next/Library/2019-09-16-09-54-42.bpo-38136.MdI-Zb.rst
new file mode 100644
index 000000000000..78cad245e67d
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2019-09-16-09-54-42.bpo-38136.MdI-Zb.rst
@@ -0,0 +1,3 @@
+Changes AsyncMock call count and await count to be two different counters.
+Now await count only counts when a coroutine has been awaited, not when it
+has been called, and vice-versa. Update the documentation around this.
More information about the Python-checkins
mailing list