bpo-37047: Refactor AsyncMock setup logic for autospeccing by tirkarthi · Pull Request #13574 · python/cpython

tirkarthi · 2019-05-25T19:48:07Z

Initialize awaited attribute for AsyncMock during autospec.
Fix late binding issue for mock helpers API to ensure correct function is called during attribute access.
Document newly implemented async methods.
Fix assert_not_awaited error message.

https://bugs.python.org/issue37047

* Handle late binding while setting attributes on AsyncMock during create_autospec. * Refactor out async mock setup logic outside the function. * Add awaited attribute during setup. * Fix assert_not_awaited error message.

tirkarthi · 2019-05-25T19:58:03Z

I am not sure if a NEWS entry is needed since the changes were not released but added one just in case it doesn't make it for 3.8 beta 1. Note to self and reviewer :

_is_async_obj and _is_async_func look very much same. Except there is isawaitable which also seems to accept coroutine. Since only coroutine function has to be accepted as spec I have kept them separate.
I have added test for much of the attribute access. So test might seem little verbose and can be removed since we can assuming one method call working properly would make sure late binding is handled.
autospec=True for patch uses create_autospec internally so a test has been added for the same.
I haven't added a test for error message change.

pablogsal · 2019-05-25T21:18:50Z

CC: @mariocj89

mariocj89 · 2019-05-25T22:40:58Z



+def _is_async_func(func):
+ if getattr(func, '__code__', None):


Is it possible to have an async callable class? If so this won’t work.
Would a check for ‘callable’ work here?

I don't understand "Asunción callable class" Do you mean something like async class Foo: pass which I think is not supported. Please add an example of the same.

There is no async version of callable() builtin like acallable().
asyncio.iscoroutinefunction() works for functions only

👍 note that the following will probably produce a standard mock rather than an async mock:
classA: asyncdef__call__(self): awaitasyncio.sleep(1) a=A() # Creating a spec for a will not quite likely not create the right kind of mock, as a does not have __code__.
We can cover this in a different PR if possible I guess.

Yes, it produces a MagicMock but there could be a class with a mix of sync and async dunder methods too so not sure of the behavior and how to detect classes like this. I would like to cover it as part of different PR since this contain fixes for create_autospec. Thanks for catching this.
fromunittest.mockimportcreate_autospecclassA: asyncdef__call__(self): awaitasyncio.sleep(1) a=create_autospec(A) b=a() print(a) print(b())
<MagicMock spec='A' id='4410501232'> <MagicMock name='mock()()' id='4416843600'>

Totally fair indeed.

mariocj89 · 2019-05-25T22:47:38Z

+ 'assert_any_await',
+ 'assert_has_awaits',
+ 'assert_not_awaited'):
+ def f(attribute, *args, **kwargs):


I would use a different name than arte for this function. It makes it harder to read.
Or even better, take this function out of the loop.

Why do we do this over directly assigning the result of getattr here? Is it because the mock might still not be configured? Just confirming.

I would use a different name than arte for this function. It makes it harder to read. Or even better, take this function out of the loop.
I moved it out of the loop and used a different variable name. I have added a comment. Feel free to suggest if it can be rephrased better.
Why do we do this over directly assigning the result of getattr here? Is it because the mock might still not be configured? Just confirming.
Yes, this is similar to a synchronous function being specced where a new function object is returned that needs to be configured like in _setup_func where synchronous mock helpers are attached to function object and when called delegate to mock's helper. The original async setup code was trying to do the same except defining a named function for every helper it uses a wrapper function and uses getattr to get the corresponding method as it is being called.
defassert_called_with(*args, **kwargs): returnmock.assert_called_with(*args, **kwargs) funcopy.assert_called_with=assert_called_with# Could be rewritten as in this PRdefwrapper(attribute, *args, **kwargs): returngetattr(mock, attr)(*args, **kwargs) setattr(funcopy, 'assert_called_with', partial(wrapper, 'assert_called_with'))

…of the loop

mariocj89 · 2019-05-27T10:32:43Z

@@ -0,0 +1,2 @@
+Handle late binding and attribute access in AsyncMock setup for
+autospeccing. Document newly implemented async methods in MagicMock.


Note: If you want to make this a link you can convert the AsyncMock and MagicMock to
:class:unittest.mock.AsyncMock and :class:unittest.mock.MagicMock

Done. Thanks.

1st1 · 2019-05-27T11:48:12Z

@tirkarthi Do you want me or Andrew to merge this?

tirkarthi · 2019-05-27T12:46:44Z

@1st1 Yes, this can be merged and all the items listed in the issue are complete. Thanks for the review everyone.

1st1 · 2019-05-27T12:56:34Z

Thank you, @tirkarthi!

…13574) Handle late binding and attribute access in unittest.mock.AsyncMock setup for autospeccing.

tirkarthi added 8 commits May 26, 2019 01:05

Refactor create_autospec and async mock setup logic.
e1ae653
* Handle late binding while setting attributes on AsyncMock during create_autospec. * Refactor out async mock setup logic outside the function. * Add awaited attribute during setup. * Fix assert_not_awaited error message.

Add new async method implementation to docs
5157982

Rename async_func_1 to async_func_args
f5742d7

Move patch with autospec to respective group
0edc644

Rephrase assert_not_awaited like assert_not_called
f4508e8

Remove unused variable
9cd0344

Fix grammar to use and
1b2ca22

Use _is_async_func
e1dd0ef

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

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

Add NEWS
8e6500c

pablogsal requested review from 1st1, cjw296 and lisroach May 25, 2019 21:18

mariocj89 reviewed May 25, 2019
View reviewed changes

Rename the variable that is also loop variable and move function out …
260bb94
…of the loop

asvetlov approved these changes May 26, 2019
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels May 26, 2019

mariocj89 approved these changes May 27, 2019
View reviewed changes

Use markup for NEWS
6ad528d

mariocj89 approved these changes May 27, 2019
View reviewed changes

1st1 approved these changes May 27, 2019
View reviewed changes

1st1 merged commit ff6b2e6 into python:masterMay 27, 2019

bedevere-bot removed the awaiting merge label May 27, 2019

mariocj89 mentioned this pull request May 30, 2019
docs: Add references to AsyncMock in unittest.mock.patch #13681
Merged

DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
bpo-37047: Refactor AsyncMock setup logic for autospeccing (pythonGH-…
01e82eb
…13574) Handle late binding and attribute access in unittest.mock.AsyncMock setup for autospeccing.



		def _is_async_func(func):
		if getattr(func, '__code__', None):

		@@ -0,0 +1,2 @@
		Handle late binding and attribute access in AsyncMock setup for
		autospeccing. Document newly implemented async methods in MagicMock.

Uh oh!

Uh oh!

Conversation

tirkarthi commented May 25, 2019• edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tirkarthi commented May 25, 2019

Uh oh!

pablogsal commented May 25, 2019

Uh oh!

mariocj89May 25, 2019• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariocj89May 26, 2019• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariocj89May 27, 2019• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

1st1 commented May 27, 2019

Uh oh!

tirkarthi commented May 27, 2019

Uh oh!

1st1 commented May 27, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

tirkarthi commented May 25, 2019•
edited by bedevere-bot
Loading

mariocj89May 25, 2019•
edited
Loading

mariocj89May 26, 2019•
edited
Loading

mariocj89May 27, 2019•
edited
Loading