Handle asyncio loop setup/teardown in sphinx doctests

Author: nocarryr

doc/source/conf.py

@@ -67,6 +67,7 @@ def _load_custom_sections(self):
     'sphinx.ext.viewcode',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
+    'pytest_doctestplus.sphinx.doctestplus',
     'propertyobj',
     'builtinproperty',
     'eventobj',

doc/source/conftest.py

@@ -2,15 +2,18 @@
 import pytest
 import asyncio
 
-def receiver_setup(request, doctest_namespace):
-    node_name = request.node.name
+
+@pytest.fixture(scope='function')
+def new_loop(request, doctest_namespace):
     policy = asyncio.get_event_loop_policy()
     loop = policy.new_event_loop()
     policy.set_event_loop(loop)
-    # logger.info(f'{request.node=}, {request.function=}, {request.module=}')
-    # logger.info(f'event loop: {loop!r}')
-    # doctest_namespace['_asyncio'] = asyncio
-    # doctest_namespace['_loop'] = loop
+    doctest_namespace['loop'] = loop
+    yield loop
+    loop.close()
+    policy.set_event_loop(None)
+
+def receiver_setup(request, loop):
 
     cleanup_coro = None
 
@@ -47,8 +50,10 @@ async def cleanup():
     asyncio.set_event_loop_policy(None)
 
 @pytest.fixture(scope="function", autouse=True)
-def doctest_stuff(request, doctest_namespace):
+def doctest_stuff(request, new_loop, doctest_namespace):
     node_name = request.node.name
+    loop = asyncio.get_event_loop()
+    assert loop is new_loop
     if node_name == 'receiver.rst':
         yield from receiver_setup(request, doctest_namespace)
     else:

doc/source/receiver.rst

@@ -25,8 +25,7 @@ Starting and stopping can be done by calling the :meth:`UmdReceiver.open` and
     ...     await receiver.open()
     ...     ...
     ...     await receiver.close()
-    >>> loop = asyncio.get_event_loop()
-    >>> loop.run_until_complete(run())
+    >>> asyncio.run(run())
 
 or it can be used as an :term:`asynchronous context manager`
 in an :keyword:`async with` block
@@ -39,8 +38,7 @@ in an :keyword:`async with` block
     ...     receiver = UmdReceiver()
     ...     async with receiver:
     ...         ...
-    >>> loop = asyncio.get_event_loop()
-    >>> loop.run_until_complete(run())
+    >>> asyncio.run(run())
 
 
 Object Access
@@ -89,7 +87,6 @@ They are indexed 1 through 4 and their screen index is 1.
     ...     for name in props_changed:
     ...         value = getattr(tally, name)
     ...         print(f'tally_updated: {tally!r}.{name} = {value}')
-    >>> loop = asyncio.get_event_loop()
     >>> receiver = UmdReceiver()
     >>> receiver.bind(
     ...     on_screen_added=screen_added,

doc/source/sender.rst

@@ -33,8 +33,7 @@ Starting and stopping can be done by calling the :meth:`UmdSender.open` and
     ...     await sender.open()
     ...     ...
     ...     await sender.close()
-    >>> loop = asyncio.get_event_loop()
-    >>> loop.run_until_complete(run())
+    >>> asyncio.run(run())
 
 or it can be used as an :term:`asynchronous context manager`
 in an :keyword:`async with` block
@@ -47,8 +46,7 @@ in an :keyword:`async with` block
     ...     sender = UmdSender(clients=[('127.0.0.1', 65000)])
     ...     async with sender:
     ...         ...
-    >>> loop = asyncio.get_event_loop()
-    >>> loop.run_until_complete(run())
+    >>> asyncio.run(run())
 
 
 Object Access
@@ -96,6 +94,7 @@ and :term:`TallyColor` arguments are used.
     >>> from pprint import pprint
     >>> from tslumd import UmdSender, TallyType, TallyColor
     >>> sender = UmdSender(clients=[('127.0.0.1', 65000)])
+    >>> loop.run_until_complete(sender.open())
     >>> for cam_num in range(1, 5):
     ...     sender.set_tally_text((1, cam_num), f'Camera {cam_num}') # Creates a new Tally
     >>> pprint(sender.tallies)
@@ -114,6 +113,7 @@ and :term:`TallyColor` arguments are used.
      (1, 2): <Tally: ((1, 2) - "Camera 2")>,
      (1, 3): <Tally: ((1, 3) - "Camera 3")>,
      (1, 4): <Tally: ((1, 4) - "Handheld")>}
+    >>> loop.run_until_complete(sender.close())
 
 
 Direct Tally Changes