gh-72889: remove redundant `mock.Mock()._is_coroutine = False` workarounds by graingert · Pull Request #94926 · python/cpython · GitHub

these work-arounds were made redundant by python/asyncio#459

Issue: Fix asyncio.iscoroutinefunction to handle Mock objects #72889

when asyncio.iscoroutinefunction was implemented as:

Lines 245 to 248 in 2f84144

    
           def iscoroutinefunction(func): 
        
               """Return True if func is a decorated coroutine function.""" 
        
               return (getattr(func, '_is_coroutine', False) or 
        
                       _inspect_iscoroutinefunction(func))

this meant

self.loop._add_reader = mock.Mock()
assert asyncio.iscoroutinefunction(self.loop._add_reader) is True  # mock objects have a truthy _is_coroutine attribute!
self.loop._add_reader._is_coroutine = False
assert asyncio.iscoroutinefunction(self.loop._add_reader) is False  # patching it works around the issue

however the implementation was changed to use a marker object:

cpython/Lib/asyncio/coroutines.py

Lines 16 to 23 in ec4745b

    
           # A marker for iscoroutinefunction. 
        
           _is_coroutine = object() 
        
           def iscoroutinefunction(func): 
        
               """Return True if func is a decorated coroutine function.""" 
        
               return (inspect.iscoroutinefunction(func) or 
        
                       getattr(func, '_is_coroutine', None) is _is_coroutine)

and so now the _is_coroutine = False work-around is redundant:

self.loop._add_reader = mock.Mock()
assert asyncio.iscoroutinefunction(self.loop._add_reader) is False  # mock objects have an _is_coroutine but it's not the asyncio.coroutines._is_coroutine sentinel
self.loop._add_reader._is_coroutine = False
assert asyncio.iscoroutinefunction(self.loop._add_reader) is False  # it's still False so the workaround is redundant

I don't think this needs a news entry

Since this just changes tests and the tests pass, I think this is okay.

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

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

…rkarounds (pythonGH-94926) (cherry picked from commit 07aeb74) Co-authored-by: Thomas Grainger <tagrain@gmail.com>

…nds (GH-94926) (cherry picked from commit 07aeb74) Co-authored-by: Thomas Grainger <tagrain@gmail.com>

remove redundant mock.Mock()._is_coroutine = False workarounds

bfafdb5

graingert requested review from 1st1 and asvetlov as code owners July 17, 2022 13:56

bedevere-bot added awaiting review tests Tests in the Lib/test dir labels Jul 17, 2022

graingert commented Jul 17, 2022

View reviewed changes

Merge branch 'main' into remove-redudant-mock-is-coroutine-workarounds

d794dfd

gvanrossum added topic-asyncio skip news needs backport to 3.11 only security fixes labels Jul 17, 2022

gvanrossum approved these changes Jul 17, 2022

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Jul 17, 2022

gvanrossum merged commit 07aeb74 into python:main Jul 17, 2022

bedevere-bot removed the awaiting merge label Jul 17, 2022

bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 17, 2022

graingert deleted the remove-redudant-mock-is-coroutine-workarounds branch July 17, 2022 17:23

miss-islington added a commit that referenced this pull request Jul 17, 2022

gh-72889 : Remove redundant mock.Mock()._is_coroutine = False workarou…

8d0249e

…nds (GH-94926) (cherry picked from commit 07aeb74) Co-authored-by: Thomas Grainger <tagrain@gmail.com>

mdboom mentioned this pull request Aug 12, 2022

Metabug: Improving C-level coverage #94808

Open

gh-72889: remove redundant `mock.Mock()._is_coroutine = False` workarounds by graingert · Pull Request #94926 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-72889: remove redundant mock.Mock()._is_coroutine = False workarounds - #94926

gh-72889: remove redundant mock.Mock()._is_coroutine = False workarounds#94926
gvanrossum merged 2 commits into
python:mainfrom
graingert:remove-redudant-mock-is-coroutine-workarounds

graingert commented Jul 17, 2022 •
edited by bedevere-bot
Loading

Uh oh!

Uh oh!

graingert Jul 17, 2022 •
edited
Loading

Uh oh!

Uh oh!

graingert commented Jul 17, 2022

Uh oh!

gvanrossum left a comment

Uh oh!

miss-islington commented Jul 17, 2022

Uh oh!

bedevere-bot commented Jul 17, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		self.loop._add_reader = mock.Mock()
		self.loop._add_reader._is_coroutine = False

	def iscoroutinefunction(func):
	"""Return True if func is a decorated coroutine function."""
	return (getattr(func, '_is_coroutine', False) or
	_inspect_iscoroutinefunction(func))

	# A marker for iscoroutinefunction.
	_is_coroutine = object()


	def iscoroutinefunction(func):
	"""Return True if func is a decorated coroutine function."""
	return (inspect.iscoroutinefunction(func) or
	getattr(func, '_is_coroutine', None) is _is_coroutine)

gh-72889: remove redundant `mock.Mock()._is_coroutine = False` workarounds by graingert · Pull Request #94926 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-72889: remove redundant mock.Mock()._is_coroutine = False workarounds - #94926

gh-72889: remove redundant mock.Mock()._is_coroutine = False workarounds#94926gvanrossum merged 2 commits intopython:mainpython/cpython:mainfrom graingert:remove-redudant-mock-is-coroutine-workaroundsgraingert/cpython:remove-redudant-mock-is-coroutine-workaroundsCopy head branch name to clipboard

Conversation

graingert commented Jul 17, 2022 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

graingert Jul 17, 2022 • 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!

graingert commented Jul 17, 2022

Uh oh!

gvanrossum left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Jul 17, 2022

Uh oh!

bedevere-bot commented Jul 17, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gh-72889: remove redundant mock.Mock()._is_coroutine = False workarounds#94926
gvanrossum merged 2 commits into
python:mainfrom
graingert:remove-redudant-mock-is-coroutine-workarounds

graingert commented Jul 17, 2022 •
edited by bedevere-bot
Loading

graingert Jul 17, 2022 •
edited
Loading