Switch away from pytest-asyncio (#25)

Author: blink1073

README.md

@@ -40,10 +40,16 @@ The `pytest_jupyter.jupyter_client` plugin provides an installed
 that provides a factory function that starts a kernel using the `echo` kernel
 by default.
 
-Note: The server plugin also includes the client plugin, so you can use both
+*Note*: The server plugin also includes the client plugin, so you can use both
 sets of fixtures with `"pytest_jupyter.jupyter_server"`.  Both the `client`
 and `server` plugins also include the core fixtures.
 
+*Note*: The client and server plugins use `pytest-tornasync` for async
+test suite running.  It may not compatible with `pytest-asyncio`, meaning
+that all fixtures must be synchronous.  You can use the `asyncio_loop` fixture
+and run `asyncio_loop.run_until_complete` against an async function in your
+fixtures if needed.
+
 The server fixures use the echo kernel by default.  To override this behavior,
 override the `jp_server_config` fixture and add the following config:
 

pyproject.toml

@@ -24,7 +24,6 @@ classifiers = [
 ]
 dependencies = [
     "pytest",
-    "pytest-asyncio",
     "jupyter_core"
 ]
 requires-python = ">=3.8"
@@ -39,12 +38,12 @@ docs = [
 client = [
     "jupyter_client>=7.4.0",
     "ipykernel>=6.14",
+    "pytest-tornasync>=0.6"
 ]
 server = [
     "jupyter_server>=1.21",
     "nbformat>=5.3",
     "pytest-jupyter[client]",
-    "pytest-tornasync>=0.6"
 ]
 test = [
     "pytest-timeout"
@@ -89,7 +88,6 @@ addopts = "-raXs --durations 10 --color=yes --doctest-modules"
 testpaths = [
     "tests"
 ]
-asyncio_mode = "strict"
 timeout = 10
 # Restore this setting to debug failures
 timeout_method = "thread"

pytest_jupyter/jupyter_client.py

@@ -7,7 +7,6 @@
 from pathlib import Path
 
 import pytest
-import pytest_asyncio
 from jupyter_core import paths
 
 try:
@@ -56,8 +55,8 @@ def zmq_context():
     ctx.term()
 
 
-@pytest_asyncio.fixture
-async def start_kernel(echo_kernel_spec):
+@pytest.fixture
+def start_kernel(echo_kernel_spec, asyncio_loop):
     kms = []
     kcs = []
 
@@ -73,7 +72,7 @@ async def inner(kernel_name="echo", **kwargs):
         kc.stop_channels()
 
     for km in kms:
-        await km.shutdown_kernel(now=True)
+        asyncio_loop.run_until_complete(km.shutdown_kernel(now=True))
         assert km.context.closed
 
 

pytest_jupyter/jupyter_server.py

@@ -14,7 +14,6 @@
 
 import jupyter_core.paths
 import pytest
-import pytest_asyncio
 
 # The try block is needed so that the documentation can
 # still build without needed to install all the dependencies.
@@ -52,9 +51,12 @@
 pytest_plugins = ["pytest_tornasync", "pytest_jupyter.jupyter_client"]
 
 
-@pytest_asyncio.fixture
-async def asyncio_loop():
-    return asyncio.get_running_loop()
+@pytest.fixture
+def asyncio_loop():
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    yield loop
+    loop.close()
 
 
 @pytest.fixture(autouse=True)

tests/test_jupyter_client.py

@@ -1,6 +1,5 @@
 from unittest.mock import Mock
 
-import pytest
 from jupyter_client.session import Session
 
 from pytest_jupyter.echo_kernel import EchoKernel
@@ -10,7 +9,6 @@ def test_zmq_context(zmq_context):
     assert isinstance(zmq_context.underlying, int)
 
 
-@pytest.mark.asyncio
 async def test_start_kernel(start_kernel):
     km, kc = await start_kernel()
     assert km.kernel_name == "echo"

tests/test_jupyter_server.py

@@ -2,30 +2,25 @@
 import os
 from unittest.mock import MagicMock
 
-import pytest
 from jupyter_server.auth import Authorizer
 from jupyter_server.serverapp import ServerApp
 from tornado.websocket import WebSocketHandler
 
 
-@pytest.mark.asyncio
 async def test_serverapp(jp_serverapp):
     assert isinstance(jp_serverapp, ServerApp)
 
 
-@pytest.mark.asyncio
 async def test_get_api_spec(jp_fetch):
     response = await jp_fetch("api", "spec.yaml", method="GET")
     assert response.code == 200
 
 
-@pytest.mark.asyncio
 async def test_send_request(send_request):
     code = await send_request("api/spec.yaml", method="GET")
     assert code == 200
 
 
-@pytest.mark.asyncio
 async def test_connection(jp_fetch, jp_ws_fetch, jp_http_port, jp_auth_header):
     # Create kernel
     r = await jp_fetch("api", "kernels", method="POST", body="{}")
@@ -41,7 +36,6 @@ async def test_connection(jp_fetch, jp_ws_fetch, jp_http_port, jp_auth_header):
     ws.close()
 
 
-@pytest.mark.asyncio
 async def test_authorizer(jp_server_authorizer, jp_serverapp, jp_base_url):
     auth: Authorizer = jp_server_authorizer(parent=jp_serverapp)
     assert isinstance(auth, Authorizer)
@@ -56,7 +50,6 @@ async def test_authorizer(jp_server_authorizer, jp_serverapp, jp_base_url):
     assert auth.match_url_to_resource("/api/shutdown") == "server"
 
 
-@pytest.mark.asyncio
 async def test_create_notebook(jp_create_notebook):
     nb = jp_create_notebook("foo.ipynb")
     assert "nbformat" in nb