From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 10 Sep 2019 07:31:34 +0000 (-0700)
Subject: bpo-37383: Updates docs to reflect AsyncMock call_count after await. (GH-15761)
X-Git-Tag: v3.8.0rc1~241
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d4391aa5eb4767e19b7b380a836413e7c47f1fb4;p=python

bpo-37383: Updates docs to reflect AsyncMock call_count after await. (GH-15761)


* bpo-351428: Updates documentation to reflect AsyncMock call_count after await.

* Adds skip and fixes warning.

* Removes extra >>>.

* Adds ... in front of await mock().
(cherry picked from commit b9f65f01fd761da7799f36d29b54518399d3458e)

Co-authored-by: Lisa Roach <lisaroach14@gmail.com>
---

diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index 304ba53227..b2547546f3 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -514,6 +514,20 @@ 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