summaryrefslogtreecommitdiffstats
path: root/Lib
diff options
context:
space:
mode:
Diffstat (limited to 'Lib')
-rw-r--r--Lib/inspect.py26
-rw-r--r--Lib/test/test_inspect.py45
2 files changed, 69 insertions, 2 deletions
diff --git a/Lib/inspect.py b/Lib/inspect.py
index e92c355..052f0bf 100644
--- a/Lib/inspect.py
+++ b/Lib/inspect.py
@@ -125,6 +125,7 @@ __all__ = [
"ismodule",
"isroutine",
"istraceback",
+ "markcoroutinefunction",
"signature",
"stack",
"trace",
@@ -391,12 +392,33 @@ def isgeneratorfunction(obj):
See help(isfunction) for a list of attributes."""
return _has_code_flag(obj, CO_GENERATOR)
+# A marker for markcoroutinefunction and iscoroutinefunction.
+_is_coroutine_marker = object()
+
+def _has_coroutine_mark(f):
+ while ismethod(f):
+ f = f.__func__
+ f = functools._unwrap_partial(f)
+ if not (isfunction(f) or _signature_is_functionlike(f)):
+ return False
+ return getattr(f, "_is_coroutine_marker", None) is _is_coroutine_marker
+
+def markcoroutinefunction(func):
+ """
+ Decorator to ensure callable is recognised as a coroutine function.
+ """
+ if hasattr(func, '__func__'):
+ func = func.__func__
+ func._is_coroutine_marker = _is_coroutine_marker
+ return func
+
def iscoroutinefunction(obj):
"""Return true if the object is a coroutine function.
- Coroutine functions are defined with "async def" syntax.
+ Coroutine functions are normally defined with "async def" syntax, but may
+ be marked via markcoroutinefunction.
"""
- return _has_code_flag(obj, CO_COROUTINE)
+ return _has_code_flag(obj, CO_COROUTINE) or _has_coroutine_mark(obj)
def isasyncgenfunction(obj):
"""Return true if the object is an asynchronous generator function.
diff --git a/Lib/test/test_inspect.py b/Lib/test/test_inspect.py
index 0f8217b..78e6e9e 100644
--- a/Lib/test/test_inspect.py
+++ b/Lib/test/test_inspect.py
@@ -202,6 +202,51 @@ class TestPredicates(IsTestBase):
gen_coroutine_function_example))))
self.assertTrue(inspect.isgenerator(gen_coro))
+ async def _fn3():
+ pass
+
+ @inspect.markcoroutinefunction
+ def fn3():
+ return _fn3()
+
+ self.assertTrue(inspect.iscoroutinefunction(fn3))
+ self.assertTrue(
+ inspect.iscoroutinefunction(
+ inspect.markcoroutinefunction(lambda: _fn3())
+ )
+ )
+
+ class Cl:
+ async def __call__(self):
+ pass
+
+ self.assertFalse(inspect.iscoroutinefunction(Cl))
+ # instances with async def __call__ are NOT recognised.
+ self.assertFalse(inspect.iscoroutinefunction(Cl()))
+
+ class Cl2:
+ @inspect.markcoroutinefunction
+ def __call__(self):
+ pass
+
+ self.assertFalse(inspect.iscoroutinefunction(Cl2))
+ # instances with marked __call__ are NOT recognised.
+ self.assertFalse(inspect.iscoroutinefunction(Cl2()))
+
+ class Cl3:
+ @inspect.markcoroutinefunction
+ @classmethod
+ def do_something_classy(cls):
+ pass
+
+ @inspect.markcoroutinefunction
+ @staticmethod
+ def do_something_static():
+ pass
+
+ self.assertTrue(inspect.iscoroutinefunction(Cl3.do_something_classy))
+ self.assertTrue(inspect.iscoroutinefunction(Cl3.do_something_static))
+
self.assertFalse(
inspect.iscoroutinefunction(unittest.mock.Mock()))
self.assertTrue(