🚀 raise RuntimeError when eval async code with non asyncio event loop

Author: uriyyo

async-pydevd/async_pydevd/asyncio_patch.py

@@ -10,7 +10,17 @@
     pass
 
 
+def _is_async_debug_available(loop=None) -> bool:
+    if loop is None:
+        loop = asyncio.get_event_loop()
+
+    return loop.__class__.__module__.lstrip("_").startswith("asyncio")
+
+
 def _patch_asyncio_set_get_new():
+    if not _is_async_debug_available():
+        return
+
     if sys.platform.lower().startswith("win"):
         try:
             asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
@@ -20,7 +30,7 @@ def _patch_asyncio_set_get_new():
     apply()
 
     def _patch_loop_if_not_patched(loop: AbstractEventLoop):
-        if not hasattr(loop, "_nest_patched"):
+        if not hasattr(loop, "_nest_patched") and _is_async_debug_available(loop):
             _patch_loop(loop)
 
     def _patch_asyncio_api(func: Callable) -> Callable:

async-pydevd/async_pydevd/pydevd_patch.py

@@ -1,5 +1,13 @@
+import asyncio
 from typing import Any
 
+try:
+    _ = _is_async_debug_available  # noqa  # only for testing purposes
+except NameError:
+
+    def _is_async_debug_available(_=None) -> bool:
+        return True
+
 
 def is_async_code(code: str) -> bool:
     # TODO: use node visitor to check if code contains async/await
@@ -22,6 +30,14 @@ def make_code_async(code: str) -> str:
 
 def evaluate_expression(thread_id: object, frame_id: object, expression: str, doExec: bool) -> Any:
     if is_async_code(expression):
+        if not _is_async_debug_available():
+            cls = asyncio.get_event_loop().__class__
+
+            raise RuntimeError(
+                f"Can not evaluate async code with event loop {cls.__module__}.{cls.__qualname__}. "
+                "Only native asyncio event loop can be used for async code evaluating."
+            )
+
         doExec = False
 
     try:
@@ -58,11 +74,10 @@ def line_breakpoint_init(self: LineBreakpoint, *args, **kwargs):
 # Update old breakpoints
 import gc
 
-for obj in gc.get_objects():
+for obj in gc.get_objects():  # pragma: no cover
     if isinstance(obj, LineBreakpoint):
         normalize_line_breakpoint(obj)
 
-
 # 3. Add ability to use async code in console
 from _pydevd_bundle import pydevd_console_integration
 

async-pydevd/tests/test_asyncio_patch.py

@@ -13,22 +13,40 @@ class CustomEventLoop(BaseEventLoop):
     pass
 
 
+class AsyncioEventLoop(BaseEventLoop):
+    __module__ = "asyncio"
+
+
 def _test_asyncio_patch():
     from async_pydevd import asyncio_patch  # noqa # isort:skip
     from asyncio import get_event_loop, new_event_loop, set_event_loop  # isort:skip
 
     assert _is_patched(get_event_loop())
     assert _is_patched(new_event_loop())
 
-    loop = CustomEventLoop()
+    loop = AsyncioEventLoop()
     set_event_loop(loop)
     assert _is_patched(loop)
 
 
+def _test_asyncio_patch_non_default_loop():
+    from asyncio import get_event_loop, set_event_loop  # isort:skip
+
+    set_event_loop(CustomEventLoop())
+
+    from async_pydevd import asyncio_patch  # noqa # isort:skip
+
+    assert not _is_patched(get_event_loop())
+
+
 def test_asyncio_patch(run_in_process):
     run_in_process(_test_asyncio_patch)
 
 
+def test_asyncio_patch_non_default_loop(run_in_process):
+    run_in_process(_test_asyncio_patch_non_default_loop)
+
+
 def _test_windows_asyncio_policy():
     from async_pydevd import asyncio_patch  # noqa # isort:skip
     from asyncio.windows_events import WindowsSelectorEventLoopPolicy  # isort:skip

async-pydevd/tests/test_pydevd_patch.py

@@ -1,9 +1,9 @@
 import sys
 from unittest.mock import MagicMock
 
-from pytest import fixture, mark
+from pytest import fixture, mark, raises
 
-from .utils import ctxmanager  # noqa
+from .utils import ctxmanager, regular  # noqa
 
 
 def _as_async(code: str):
@@ -132,3 +132,21 @@ def _with_locals():
 
     assert "f" in g.gi_frame.f_locals
     assert g.gi_frame.f_locals["f"] == 10
+
+
+def test_async_evaluate_is_not_available_for_eventloop(mocker):
+    mocker.patch("async_pydevd.pydevd_patch._is_async_debug_available", return_value=False)
+
+    from async_pydevd.pydevd_patch import evaluate_expression
+
+    with raises(
+        RuntimeError,
+        match=r"^Can not evaluate async code with event loop asyncio.unix_events._UnixSelectorEventLoop. "
+        r"Only native asyncio event loop can be used for async code evaluating.$",
+    ):
+        evaluate_expression(
+            object(),
+            object(),
+            "await regular()",
+            True,
+        )

helpers/poetry.lock

@@ -49,7 +49,8 @@ fun Sdk.whenSupport(block: () -> Unit) {
         block()
 }
 
-fun pydevd_async_init() = """
+val pydevd_async_init: () -> String = {
+    """
 def _patch_pydevd():
 ${PYDEVD_ASYNC_PLUGIN.prependIndent("    ").split("\n").dropLast(5).joinToString("\n")}
 
@@ -58,6 +59,7 @@ import sys
 if not hasattr(sys, "__async_eval__"):
     _patch_pydevd()
 """.trimIndent()
+}.memoize()
 
 val PYDEVD_ASYNC_PLUGIN = """
 import asyncio
@@ -278,7 +280,17 @@ except ImportError:
     pass
 
 
+def _is_async_debug_available(loop=None) -> bool:
+    if loop is None:
+        loop = asyncio.get_event_loop()
+
+    return loop.__class__.__module__.lstrip("_").startswith("asyncio")
+
+
 def _patch_asyncio_set_get_new():
+    if not _is_async_debug_available():
+        return
+
     if sys.platform.lower().startswith("win"):
         try:
             asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
@@ -288,7 +300,7 @@ def _patch_asyncio_set_get_new():
     apply()
 
     def _patch_loop_if_not_patched(loop: AbstractEventLoop):
-        if not hasattr(loop, "_nest_patched"):
+        if not hasattr(loop, "_nest_patched") and _is_async_debug_available(loop):
             _patch_loop(loop)
 
     def _patch_asyncio_api(func: Callable) -> Callable:
@@ -434,8 +446,16 @@ def async_eval(expr: str, _globals: Optional[dict] = None, _locals: Optional[dic
 
 sys.__async_eval__ = async_eval
 
+import asyncio
 from typing import Any
 
+try:
+    _ = _is_async_debug_available  # noqa  # only for testing purposes
+except NameError:
+
+    def _is_async_debug_available(_=None) -> bool:
+        return True
+
 
 def is_async_code(code: str) -> bool:
     # TODO: use node visitor to check if code contains async/await
@@ -458,6 +478,14 @@ original_evaluate = pydevd_vars.evaluate_expression
 
 def evaluate_expression(thread_id: object, frame_id: object, expression: str, doExec: bool) -> Any:
     if is_async_code(expression):
+        if not _is_async_debug_available():
+            cls = asyncio.get_event_loop().__class__
+
+            raise RuntimeError(
+                f"Can not evaluate async code with event loop {cls.__module__}.{cls.__qualname__}. "
+                "Only native asyncio event loop can be used for async code evaluating."
+            )
+
         doExec = False
 
     try:
@@ -498,7 +526,6 @@ for obj in gc.get_objects():
     if isinstance(obj, LineBreakpoint):
         normalize_line_breakpoint(obj)
 
-
 # 3. Add ability to use async code in console
 from _pydevd_bundle import pydevd_console_integration