Visitar URL original
gh-94912: Added marker for non-standard coroutine function detection by carltongibson 路 Pull Request #99247 路 python/cpython 路 GitHub
Skip to content

gh-94912: Added marker for non-standard coroutine function detection #99247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gvanrossum merged 16 commits into from
Dec 18, 2022
Merged

gh-94912: Added marker for non-standard coroutine function detection #99247

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
4cf8e98
Added initial test and docs drafts.
carltongibson Nov 8, 2022
6b8fa87
Make first case pass setting code flags.
carltongibson Nov 15, 2022
fa22a16
Adjust iscoroutinefunction() to look for async __call__.
carltongibson Nov 15, 2022
513d358
馃摐馃 Added by blurb_it.
blurb-it[bot] Nov 17, 2022
397a975
Moved to decorator; extra tests.
carltongibson Nov 17, 2022
d156eab
Added tests for lambda, @classmethod, and @staticmethod cases.
carltongibson Nov 23, 2022
34859de
Adjusted docs signature for review comment.
carltongibson Nov 23, 2022
47a9fea
Improve grammar in NEWS file
gvanrossum Nov 23, 2022
cd6c491
Adjusted docs.
carltongibson Nov 29, 2022
629dd81
Updated for review comments.
carltongibson Nov 30, 2022
a518c0f
Merge branch 'main' into fix-issue-XXXXX
gvanrossum Nov 30, 2022
c6d2b88
Use marker for implementation.
carltongibson Dec 6, 2022
b7249a8
Added "What's New..." entry.
carltongibson Dec 6, 2022
3bc72e2
Adjusted implementation.
carltongibson Dec 8, 2022
c073cf7
Renamed to _is_coroutine_marker.
carltongibson Dec 13, 2022
5ffba32
Adjusted implementation and docs.
carltongibson Dec 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Moved to decorator; extra tests.
  • Loading branch information
@carltongibson
carltongibson committed Nov 17, 2022
commit 397a975bc331733aafdc843611180759e135f012
12 changes: 11 additions & 1 deletion Lib/inspect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@
"ismodule",
"isroutine",
"istraceback",
"markcoroutinefunction",
"signature",
"stack",
"trace",
Expand Down Expand Up @@ -391,13 +392,22 @@ def isgeneratorfunction(obj):
See help(isfunction) for a list of attributes."""
return _has_code_flag(obj, CO_GENERATOR)

def markcoroutinefunction(func):
"""
Decorator to ensure callable is recognised as a coroutine function.
"""
func.__code__ = func.__code__.replace(
co_flags=func.__code__.co_flags | CO_COROUTINE
)
return func

def iscoroutinefunction(obj):
"""Return true if the object is a coroutine function.

Coroutine functions are defined with "async def" syntax.
"""
return _has_code_flag(obj, CO_COROUTINE) or (
Comment thread
gvanrossum marked this conversation as resolved.
Outdated
callable(obj) and _has_code_flag(obj.__call__, CO_COROUTINE)
not isclass(obj) and callable(obj) and _has_code_flag(obj.__call__, CO_COROUTINE)
)

def isasyncgenfunction(obj):
Expand Down
39 changes: 19 additions & 20 deletions Lib/test/test_inspect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,30 +202,29 @@ def test_iscoroutine(self):
gen_coroutine_function_example))))
self.assertTrue(inspect.isgenerator(gen_coro))

# Use subtest initially to see both failures.
with self.subTest("Wrapper not recognised."):
# First case: sync function returning an awaitable.
async def _fn3():
pass
async def _fn3():
pass

def fn3():
return _fn3()
@inspect.markcoroutinefunction
Comment thread
carltongibson marked this conversation as resolved.
def fn3():
return _fn3()

# TODO: Move this to decorator function.
fn3.__code__ = fn3.__code__.replace(
co_flags=fn3.__code__.co_flags | inspect.CO_COROUTINE
)
self.assertTrue(inspect.iscoroutinefunction(fn3))

self.assertTrue(inspect.iscoroutinefunction(fn3))
class Cl:
async def __call__(self):
pass

self.assertFalse(inspect.iscoroutinefunction(Cl))
self.assertTrue(inspect.iscoroutinefunction(Cl()))

class Cl2:
@inspect.markcoroutinefunction
def __call__(self):
pass

with self.subTest("Awaitable instance not recongnised."):
# Second case: a class with an async def __call__.
# - instance is awaitable.
class Cl:
async def __call__(self):
pass
cl = Cl()
self.assertTrue(inspect.iscoroutinefunction(cl))
self.assertFalse(inspect.iscoroutinefunction(Cl2))
self.assertTrue(inspect.iscoroutinefunction(Cl2()))

self.assertFalse(
inspect.iscoroutinefunction(unittest.mock.Mock()))
Expand Down