gh-84753: Make inspect.iscoroutinefunction() work with AsyncMock #94050

sileht · 2022-06-21T09:36:29Z

The inspect version was not working with unittest.mock.AsyncMock.

This change moves the asyncio fix for AsyncMock in inspect module and
make asyncio.iscoroutinefunction an alias of inspect.iscoroutinefunction.

Issue: inspect.iscorutinefunction() returns False for unittest.mock.AsyncMock instances #84753

cpython-cla-bot · 2022-06-21T09:36:31Z

All commit authors signed the Contributor License Agreement.

bedevere-bot · 2022-06-21T09:36:33Z

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

sileht · 2022-06-21T09:42:05Z

@vstinner Can you take a look?

graingert · 2022-06-21T10:30:20Z

this shouldn't be needed AsyncMock already sets

cpython/Lib/unittest/mock.py

Lines 2175 to 2178 in 5fcfdd8

    
           code_mock = NonCallableMock(spec_set=CodeType) 
        
           code_mock.co_flags = inspect.CO_COROUTINE 
        
           self.__dict__['__code__'] = code_mock

cjw296 · 2022-06-21T10:42:57Z

Lib/inspect.py

@@ -406,12 +406,15 @@ def isgeneratorfunction(obj):
    See help(isfunction) for a list of attributes."""
    return _has_code_flag(obj, CO_GENERATOR)

+# A marker for iscoroutinefunction.
+_is_coroutine = object()


Why is this here instead of re-using asyncio.coroutines._is_coroutine?

I moved it from asyncio to inspect as the code using it is now located in inspect module.

_is_coroutine feels like a property of asyncio, not inspect. I think it should stay where it is.

sileht · 2022-06-21T11:09:16Z

this shouldn't be needed AsyncMock already sets

cpython/Lib/unittest/mock.py

Lines 2175 to 2178 in 5fcfdd8

code_mock = NonCallableMock(spec_set=CodeType)

code_mock.co_flags = inspect.CO_COROUTINE

self.__dict__['__code__'] = code_mock

The test cases I added passed was passing for asyncio version, but was not for the inspect version. So something doesn't work as expected.

graingert · 2022-06-21T11:24:23Z

looks like this issue is because mock.AsyncMock() doesn't pass inspect.isfunction:

from unittest import mock
import inspect

m = mock.AsyncMock()
with mock.patch("inspect.isfunction", new=lambda x: True):
    assert inspect.iscoroutinefunction(m)

Originally posted by @graingert in #84753 (comment)

graingert · 2022-06-21T11:26:20Z

Could CallableMixin mess about with __instancecheck__/__subclasscheck__/__class__ to pass isinstance(AsyncMock(), types.FunctionType)?

sileht · 2022-06-24T14:09:30Z

Could CallableMixin mess about with __instancecheck__/__subclasscheck__/__class__ to pass isinstance(AsyncMock(), types.FunctionType)?

I tried but this doesn't seem to work, I suspect this fall in isinstance C optimisation and __instancecheck__ and friends are never called.

graingert · 2022-06-24T14:25:03Z

I'm relying on inspect.iscoroutinefunction to reveal things that really really are Coroutine Functions, partials or methods and asyncio.iscoroutinefunction to reveal things that are Duck typed as a Coroutine Function

sileht · 2022-06-24T14:34:29Z

I'm relying on inspect.iscoroutinefunction to reveal things that really really are Coroutine Functions, partials or methods and asyncio.iscoroutinefunction to reveal things that are Duck typed as a Coroutine Function

According to the doc, the only difference is asyncio.iscoroutinefunction also works for deprecated generator based coroutine
This legacy coroutine will(have ?) be removed for 3.11, so now both functions should be the same.

sileht · 2022-06-24T14:41:46Z

But, I agree that my solution doesn't work. We should keep the _is_coroutine hack as-is until generated coroutine are removed and found another solution to make isfunction pass for AsyncMock().

sileht · 2022-06-28T17:40:18Z

I found another solution, I think it's cleaner.

Lib/test/test_inspect.py

vstinner · 2022-06-28T22:47:49Z

Lib/inspect.py

-        return False
-    return bool(f.__code__.co_flags & flag)
+    if isfunction(f) or _signature_is_functionlike(f):
+        return bool(f.__code__.co_flags & flag)


Can you try to preserve current coding style? Return early with False if a condition is false? Pseudo-code:

if not isfunction(f): return False if not _signature_is_functionlike(f): return False return bool(f.__code__.co_flags & flag)

miss-islington · 2022-06-30T17:08:42Z

Thanks @sileht for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

pythonGH-94050) The inspect version was not working with unittest.mock.AsyncMock. The fix introduces special-casing of AsyncMock in `inspect.iscoroutinefunction` equivalent to the one performed in `asyncio.iscoroutinefunction`. Co-authored-by: Łukasz Langa <[email protected]> (cherry picked from commit 4261b6b) Co-authored-by: Mehdi ABAAKOUK <[email protected]>

bedevere-bot · 2022-06-30T17:08:59Z

GH-94460 is a backport of this pull request to the 3.11 branch.

pythonGH-94050) The inspect version was not working with unittest.mock.AsyncMock. The fix introduces special-casing of AsyncMock in `inspect.iscoroutinefunction` equivalent to the one performed in `asyncio.iscoroutinefunction`. Co-authored-by: Łukasz Langa <[email protected]> (cherry picked from commit 4261b6b) Co-authored-by: Mehdi ABAAKOUK <[email protected]>

bedevere-bot · 2022-06-30T17:09:12Z

GH-94461 is a backport of this pull request to the 3.10 branch.

sileht · 2022-06-30T17:09:51Z

Thanks all! That was fast 🚀

…94050) (GH-94461) The inspect version was not working with unittest.mock.AsyncMock. The fix introduces special-casing of AsyncMock in `inspect.iscoroutinefunction` equivalent to the one performed in `asyncio.iscoroutinefunction`. Co-authored-by: Łukasz Langa <[email protected]> (cherry picked from commit 4261b6b) Co-authored-by: Mehdi ABAAKOUK <[email protected]>

…94050) (GH-94460) The inspect version was not working with unittest.mock.AsyncMock. The fix introduces special-casing of AsyncMock in `inspect.iscoroutinefunction` equivalent to the one performed in `asyncio.iscoroutinefunction`. Co-authored-by: Łukasz Langa <[email protected]> (cherry picked from commit 4261b6b) Co-authored-by: Mehdi ABAAKOUK <[email protected]>

The wording used in pythonGH-94050 suggests narrower scope than what was actually implemented. This commit clarifies the full impact of pythonGH-94050 in the change log.

tirkarthi · 2022-08-23T14:34:59Z

This change seems to have caused a regression reported in #96127

sileht requested review from cjw296, 1st1 and asvetlov as code owners June 21, 2022 09:36

bedevere-bot added the awaiting review label Jun 21, 2022

sileht force-pushed the iscoroutinefix branch from a90d15d to 6950183 Compare June 21, 2022 09:40

jd approved these changes Jun 21, 2022

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Jun 21, 2022

cjw296 reviewed Jun 21, 2022

View reviewed changes

sileht force-pushed the iscoroutinefix branch from 6950183 to 2dfabda Compare June 21, 2022 11:04

sileht force-pushed the iscoroutinefix branch from 2dfabda to 9c7050b Compare June 28, 2022 17:39

sileht force-pushed the iscoroutinefix branch from 9c7050b to bbae9f1 Compare June 28, 2022 17:40

graingert reviewed Jun 28, 2022

View reviewed changes

Lib/test/test_inspect.py Show resolved Hide resolved

sileht force-pushed the iscoroutinefix branch 3 times, most recently from fe4fc4e to 970f727 Compare June 28, 2022 17:56

vstinner reviewed Jun 28, 2022

View reviewed changes

sileht force-pushed the iscoroutinefix branch from 970f727 to ceb50a1 Compare June 29, 2022 06:58

sileht changed the title ~~gh-84753: sync iscoroutinefunction of asyncio and inspect module~~ gh-84753: make inspect.iscoroutinefunction() works with AsyncMock Jun 29, 2022

ambv changed the title ~~gh-84753: make inspect.iscoroutinefunction() works with AsyncMock~~ gh-84753: Make inspect.iscoroutinefunction() work with AsyncMock Jun 30, 2022

Make Blurb clearer

812d7f3

ambv added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Jun 30, 2022

ambv merged commit 4261b6b into python:main Jun 30, 2022

bedevere-bot removed the awaiting merge label Jun 30, 2022

bedevere-bot removed the needs backport to 3.11 only security fixes label Jun 30, 2022

bedevere-bot removed the needs backport to 3.10 only security fixes label Jun 30, 2022

ambv mentioned this pull request Jun 30, 2022

inspect.iscorutinefunction() returns False for unittest.mock.AsyncMock instances #84753

Closed

ambv mentioned this pull request Jul 5, 2022

gh-84753: Clarify change made to inspect functions #94554

Merged

graingert mentioned this pull request Jul 17, 2022

make asyncio.iscoroutinefunction a deprecated alias of inspect.iscoroutinefunction and remove asyncio.coroutines._is_coroutine #94912

Closed

sobolevn mentioned this pull request Aug 27, 2022

gh-96127: Fix inspect.signature call on mocks #96335

Merged

maximlt mentioned this pull request Dec 22, 2023

Unpack partial in iscoroutinefunction holoviz/param#894

Merged

1 task

da-woods mentioned this pull request Mar 25, 2024

[BUG] Generators after being cythonized cannot be inspect as generators cython/cython#6096

Closed

illia-v mentioned this pull request Nov 9, 2024

Deprecate asyncio.iscoroutinefunction #122858

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-84753: Make inspect.iscoroutinefunction() work with AsyncMock #94050

gh-84753: Make inspect.iscoroutinefunction() work with AsyncMock #94050

sileht commented Jun 21, 2022 •

edited by bedevere-bot

Loading

cpython-cla-bot bot commented Jun 21, 2022 •

edited

Loading

bedevere-bot commented Jun 21, 2022

sileht commented Jun 21, 2022

graingert commented Jun 21, 2022

cjw296 Jun 21, 2022

sileht Jun 21, 2022

cjw296 Jun 21, 2022

sileht commented Jun 21, 2022

graingert commented Jun 21, 2022

graingert commented Jun 21, 2022 •

edited

Loading

sileht commented Jun 24, 2022

graingert commented Jun 24, 2022

sileht commented Jun 24, 2022

sileht commented Jun 24, 2022 •

edited

Loading

sileht commented Jun 28, 2022

vstinner Jun 28, 2022

sileht Jun 29, 2022

miss-islington commented Jun 30, 2022

bedevere-bot commented Jun 30, 2022

bedevere-bot commented Jun 30, 2022

sileht commented Jun 30, 2022

tirkarthi commented Aug 23, 2022

gh-84753: Make inspect.iscoroutinefunction() work with AsyncMock #94050

gh-84753: Make inspect.iscoroutinefunction() work with AsyncMock #94050

Conversation

sileht commented Jun 21, 2022 • edited by bedevere-bot Loading

cpython-cla-bot bot commented Jun 21, 2022 • edited Loading

bedevere-bot commented Jun 21, 2022

sileht commented Jun 21, 2022

graingert commented Jun 21, 2022

cjw296 Jun 21, 2022

Choose a reason for hiding this comment

sileht Jun 21, 2022

Choose a reason for hiding this comment

cjw296 Jun 21, 2022

Choose a reason for hiding this comment

sileht commented Jun 21, 2022

graingert commented Jun 21, 2022

graingert commented Jun 21, 2022 • edited Loading

sileht commented Jun 24, 2022

graingert commented Jun 24, 2022

sileht commented Jun 24, 2022

sileht commented Jun 24, 2022 • edited Loading

sileht commented Jun 28, 2022

vstinner Jun 28, 2022

Choose a reason for hiding this comment

sileht Jun 29, 2022

Choose a reason for hiding this comment

miss-islington commented Jun 30, 2022

bedevere-bot commented Jun 30, 2022

bedevere-bot commented Jun 30, 2022

sileht commented Jun 30, 2022

tirkarthi commented Aug 23, 2022

sileht commented Jun 21, 2022 •

edited by bedevere-bot

Loading

cpython-cla-bot bot commented Jun 21, 2022 •

edited

Loading

graingert commented Jun 21, 2022 •

edited

Loading

sileht commented Jun 24, 2022 •

edited

Loading