docs: Add references to AsyncMock in unittest.mock.patch #13681

mariocj89 · 2019-05-30T13:41:39Z

Update the docs as patch can now return an AsyncMock if the patched object is an async function.

Just noticed this, happy to create a bug report & news entry but not sure if it is worth it.

Relates-to: #9296

cjw296 · 2019-05-30T13:48:18Z

Doc/library/unittest.mock.rst

-    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


Is it just async functions? What about async methods? Is there such a thing as an async __init__ or __new__?

This is what it is controlling it: https://github.com/python/cpython/blob/master/Lib/unittest/mock.py#L49 It is checking for __code__ so it seems to be only for functions at the moment.

I was wondering about that for callable class. My main concern was what if I change a function by a callable instance but it seems there is no good way to check that at the moment. asyncio.iscoroutinefunction works only for functions.

Hmm, doesn't seem sensible to make changes to the docs until the rest of this is bottomed out.

Note this is landed already and docs are updated in some other places. The documentation for "patch" does not do what it says it does for async functions right now. Also, I am not sure at all this is going to change, why do you think so?

This looks like correct wording to me, perhaps we will find a way to make the callable check a little more granular but there is no reason to block this PR on what might be a future change in implementation.

tirkarthi · 2019-05-30T16:06:57Z

Thank you @mariocj89 for this. I had the same concern while fixing warnings caused due to this change in behavior in the testsuite : https://bugs.python.org/issue37015#msg343352 . I am okay with this being an AsyncMock because it means that there was a coroutine created and it was not awaited where raising a warning makes sense and the user can resort to using MagicMock if they are want it to be not awaited. I would prefer thoughts from @asvetlov @1st1 to discuss this behavior change from 3.7 to ensure the documentation is also updated and if needed an issue for this do discuss. I believe create_autospec has similar behavior :

cpython/Lib/unittest/mock.py

Line 2612 in 98ef920

if asyncio.iscoroutinefunction(original):

cjw296 · 2019-05-30T16:12:46Z

I guess my reticence on this comes party from the fact that the AsyncMock stuff is something I'm still quite unsure about. If I'm honest, I was surprised to see the PR landed when it did and I'm a little concerned about unintended consequences of the stuff that has been added, along with the chance that this now means the backport is pretty much stuck until it can ditch support for all python versions that don't have the required async syntax.

mariocj89 · 2019-05-30T16:46:30Z

ensure the documentation is also updated

Good point, I'll add a "versionadded" tag for the patch function.

I believe create_autospec has similar behavior :

Good point, I'll add a "versionadded" to mark the change.

I guess my reticence on this comes party from the fact that the AsyncMock stuff is something I'm still quite unsure about.

If you are saying that you are looking at reverting this behaviour soon, then sure, but otherwise we have out of date documentation, as beta 1 of 3.8 is getting released tomorrow. Not saying that we have to rush things, but people (from tomorrow) won't be seeing this change in the docs.

Even if anything was reverted, we can revert the docs and implementation together at the same time.

Update the docs as patch can now return an AsyncMock if the patched object is an async function.

cjw296 · 2019-05-30T17:35:29Z

@mariocj89 - reverting would be quite an extreme move, and one I'm not comfortable taking, particularly with my very limited knowledge of async stuff. @asvetlo merged the original PR, IIRC, and it sounded like he's part of a team that had been using this already.

I'm not sure what the best way to bottom out the remaining issues might be, including the questions I asked above.

asvetlov · 2019-06-02T10:42:46Z

I'll review the PR just after the feature freeze.
Sorry, I'm pretty busy before this date (tomorrow, actually).

mariocj89 · 2019-08-27T16:51:07Z

Gentle ping @asvetlov

This is a change in 3.8 that will go undocumented otherwise.

lisroach

I think this documentation looks good, @asvetlov I'll wait to merge so you have a chance to take a look as well.

lisroach · 2019-09-09T10:53:56Z

Doc/library/unittest.mock.rst

-    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


This looks like correct wording to me, perhaps we will find a way to make the callable check a little more granular but there is no reason to block this PR on what might be a future change in implementation.

asvetlov

LGTM, please merge.

:class:`AsyncMock`

doesn't exist in the module documentation though.

bedevere-bot · 2019-09-09T14:18:09Z

@lisroach: Please replace # with GH- in the commit message next time. Thanks!

lisroach · 2019-09-09T14:19:12Z

I thought I did @bedevere-bot :(

cjw296 · 2019-09-09T15:11:50Z

This catches me just about every time too :'(

miss-islington · 2019-09-10T12:38:12Z

Thanks @mariocj89 for the PR, and @lisroach for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

) Update the docs as patch can now return an AsyncMock if the patched object is an async function. (cherry picked from commit f5e7f39) Co-authored-by: Mario Corchero <[email protected]>

bedevere-bot · 2019-09-10T12:38:23Z

GH-15842 is a backport of this pull request to the 3.8 branch.

Update the docs as patch can now return an AsyncMock if the patched object is an async function. (cherry picked from commit f5e7f39) Co-authored-by: Mario Corchero <[email protected]>

Update the docs as patch can now return an AsyncMock if the patched object is an async function.

bedevere-bot added the docs Documentation in the Doc dir label May 30, 2019

the-knights-who-say-ni added the CLA signed label May 30, 2019

bedevere-bot added the awaiting review label May 30, 2019

mariocj89 force-pushed the pu/docs-patch-async branch from f11000f to fc631e8 Compare May 30, 2019 13:42

cjw296 reviewed May 30, 2019

View reviewed changes

docs: Add references to AsyncMock in unittest.mock.patch

c9cbe98

Update the docs as patch can now return an AsyncMock if the patched object is an async function.

mariocj89 force-pushed the pu/docs-patch-async branch from fc631e8 to c9cbe98 Compare May 30, 2019 17:02

auvipy approved these changes May 30, 2019

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels May 30, 2019

asvetlov self-assigned this Jun 2, 2019

tirkarthi mentioned this pull request Aug 26, 2019

bpo-37955: mock.patch incorrect reference to Mock #15521

Merged

lisroach added skip issue skip news labels Sep 9, 2019

lisroach approved these changes Sep 9, 2019

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Sep 9, 2019

asvetlov approved these changes Sep 9, 2019

View reviewed changes

lisroach merged commit f5e7f39 into python:master Sep 9, 2019

bedevere-bot removed the awaiting merge label Sep 9, 2019

mariocj89 deleted the pu/docs-patch-async branch September 9, 2019 14:22

lisroach added the needs backport to 3.8 only security fixes label Sep 10, 2019

bedevere-bot removed the needs backport to 3.8 only security fixes label Sep 10, 2019

websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020

docs: Add references to AsyncMock in unittest.mock.patch (python#13681)

65a1e1c

Update the docs as patch can now return an AsyncMock if the patched object is an async function.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add references to AsyncMock in unittest.mock.patch #13681

docs: Add references to AsyncMock in unittest.mock.patch #13681

mariocj89 commented May 30, 2019 •

edited

Loading

cjw296 May 30, 2019

mariocj89 May 30, 2019 •

edited

Loading

cjw296 May 30, 2019

mariocj89 May 30, 2019 •

edited

Loading

lisroach Sep 9, 2019

tirkarthi commented May 30, 2019

cjw296 commented May 30, 2019

mariocj89 commented May 30, 2019

cjw296 commented May 30, 2019

asvetlov commented Jun 2, 2019

mariocj89 commented Aug 27, 2019 •

edited

Loading

lisroach left a comment

lisroach Sep 9, 2019

asvetlov left a comment •

edited

Loading

bedevere-bot commented Sep 9, 2019

lisroach commented Sep 9, 2019

cjw296 commented Sep 9, 2019

miss-islington commented Sep 10, 2019

bedevere-bot commented Sep 10, 2019

docs: Add references to AsyncMock in unittest.mock.patch #13681

docs: Add references to AsyncMock in unittest.mock.patch #13681

Conversation

mariocj89 commented May 30, 2019 • edited Loading

cjw296 May 30, 2019

Choose a reason for hiding this comment

mariocj89 May 30, 2019 • edited Loading

Choose a reason for hiding this comment

cjw296 May 30, 2019

Choose a reason for hiding this comment

mariocj89 May 30, 2019 • edited Loading

Choose a reason for hiding this comment

lisroach Sep 9, 2019

Choose a reason for hiding this comment

tirkarthi commented May 30, 2019

cjw296 commented May 30, 2019

mariocj89 commented May 30, 2019

cjw296 commented May 30, 2019

asvetlov commented Jun 2, 2019

mariocj89 commented Aug 27, 2019 • edited Loading

lisroach left a comment

Choose a reason for hiding this comment

lisroach Sep 9, 2019

Choose a reason for hiding this comment

asvetlov left a comment • edited Loading

Choose a reason for hiding this comment

bedevere-bot commented Sep 9, 2019

lisroach commented Sep 9, 2019

cjw296 commented Sep 9, 2019

miss-islington commented Sep 10, 2019

bedevere-bot commented Sep 10, 2019

mariocj89 commented May 30, 2019 •

edited

Loading

mariocj89 May 30, 2019 •

edited

Loading

mariocj89 May 30, 2019 •

edited

Loading

mariocj89 commented Aug 27, 2019 •

edited

Loading

asvetlov left a comment •

edited

Loading