docs: Added how-to guide on changing the event loop scope of a fixture.

Signed-off-by: Michael Seifert <[email protected]>

Author: seifertm

docs/source/how-to-guides/change_fixture_loop.rst

@@ -0,0 +1,7 @@
+===============================================
+How to change the event loop scope of a fixture
+===============================================
+The event loop scope of an asynchronous fixture is specified via the *loop_scope* keyword argument to :ref:`pytest_asyncio.fixture <decorators/pytest_asyncio_fixture>`. The following fixture runs in the module-scoped event loop:
+
+.. include:: change_fixture_loop_example.py
+    :code: python

docs/source/how-to-guides/change_fixture_loop_example.py

@@ -0,0 +1,15 @@
+import asyncio
+
+import pytest
+
+import pytest_asyncio
+
+
+@pytest_asyncio.fixture(loop_scope="module")
+async def current_loop():
+    return asyncio.get_running_loop()
+
+
+@pytest.mark.asyncio(loop_scope="module")
+async def test_runs_in_module_loop(current_loop):
+    assert current_loop is asyncio.get_running_loop()

docs/source/how-to-guides/index.rst

@@ -5,6 +5,7 @@ How-To Guides
 .. toctree::
   :hidden:
 
+  change_fixture_loop
   run_class_tests_in_same_loop
   run_module_tests_in_same_loop
   run_package_tests_in_same_loop

docs/source/reference/decorators/index.rst

@@ -1,3 +1,5 @@
+.. _decorators/pytest_asyncio_fixture:
+
 ==========
 Decorators
 ==========