docs: Add references to AsyncMock in unittest.mock.patch (#13681)
Update the docs as patch can now return an AsyncMock if the patched
object is an async function.
diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index 304ba53..9bb3427 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -1307,8 +1307,10 @@
is patched with a *new* object. When the function/with statement exits
the patch is undone.
- If *new* is omitted, then the target is replaced with a
- :class:`MagicMock`. If :func:`patch` is used as a decorator and *new* is
+ If *new* is omitted, then the target is replaced with an
+ :class:`AsyncMock` if the patched object is an async function or
+ a :class:`MagicMock` otherwise.
+ If :func:`patch` is used as a decorator and *new* is
omitted, the created mock is passed in as an extra argument to the
decorated function. If :func:`patch` is used as a context manager the created
mock is returned by the context manager.
@@ -1326,8 +1328,8 @@
patch to pass in the object being mocked as the spec/spec_set object.
*new_callable* allows you to specify a different class, or callable object,
- that will be called to create the *new* object. By default :class:`MagicMock` is
- used.
+ that will be called to create the *new* object. By default :class:`AsyncMock`
+ is used for async functions and :class:`MagicMock` for the rest.
A more powerful form of *spec* is *autospec*. If you set ``autospec=True``
then the mock will be created with a spec from the object being replaced.
@@ -1491,6 +1493,10 @@
...
>>> test()
+.. versionchanged:: 3.8
+
+ :func:`patch` now returns an :class:`AsyncMock` if the target is an async function.
+
patch.object
~~~~~~~~~~~~
@@ -2275,6 +2281,12 @@
:func:`create_autospec` and the *autospec* argument to :func:`patch`.
+.. versionchanged:: 3.8
+
+ :func:`create_autospec` now returns an :class:`AsyncMock` if the target is
+ an async function.
+
+
ANY
~~~