doc

Author: pcrespov

packages/pytest-simcore/src/pytest_simcore/asyncio_event_loops.py

@@ -1,12 +1,19 @@
+"""
+Our choice of plugin to test asyncio functionality is pytest-asyncio
+
+Some other pytest plugins, e.g. pytest-aiohttp, define their own event loop
+policies and event loops, which can conflict with pytest-asyncio.
+
+This files unifies the event loop policy and event loop used by pytest-asyncio throughout
+all the tests in this repository.
+
+"""
+
 import asyncio
 
 import pytest
 import uvloop
 
-pytest_plugins = [
-    "aiohttp.pytest_plugin",  # No need to install pytest-aiohttp separately
-]
-
 
 @pytest.fixture(scope="session")
 def event_loop_policy():
@@ -19,21 +26,30 @@ def event_loop_policy():
 
 @pytest.fixture
 async def loop() -> asyncio.AbstractEventLoop:
-    """Override the event loop inside aiohttp.pytest_plugin with the one from pytest-asyncio.
+    """Override the event loop inside `aiohttp.pytest_plugin` with the one from `pytest-asyncio`.
+
+    This provides the necessary fixtures to use pytest-asyncio with aiohttp!!!
+
+    USAGE:
+
+        pytest_plugins = [
+            "aiohttp.pytest_plugin",  # No need to install pytest-aiohttp separately
+        ]
 
 
+    ERRORS:
         Otherwise error like this will be raised:
 
-    >        if connector._loop is not loop:
-    >           raise RuntimeError("Session and connector has to use same event loop")
-    E           RuntimeError: Session and connector has to use same event loop
+        >        if connector._loop is not loop:
+        >           raise RuntimeError("Session and connector has to use same event loop")
+        E           RuntimeError: Session and connector has to use same event loop
 
-    .venv/lib/python3.11/site-packages/aiohttp/client.py:375: RuntimeError
+        .venv/lib/python3.11/site-packages/aiohttp/client.py:375: RuntimeError
 
-    >        if connector._loop is not loop:
-    >           raise RuntimeError("Session and connector has to use same event loop")
-    >E           RuntimeError: Session and connector has to use same event loop
+        >        if connector._loop is not loop:
+        >           raise RuntimeError("Session and connector has to use same event loop")
+        >E           RuntimeError: Session and connector has to use same event loop
 
-    .venv/lib/python3.11/site-packages/aiohttp/client.py:375: RuntimeError
+        .venv/lib/python3.11/site-packages/aiohttp/client.py:375: RuntimeError
     """
     return asyncio.get_running_loop()