Updated examples

Author: coretl

docs/examples/example_asyncio_ioc.py

@@ -1,42 +1,30 @@
 # Import the basic framework components.
-from softioc import softioc, builder
+from softioc import softioc, builder, asyncio_dispatcher
 from aioca import caget, caput
 import asyncio
 
+# Create an asyncio dispatcher, the event loop is now running
+dispatcher = asyncio_dispatcher.AsyncioDispatcher()
+
 # Set the record prefix
 builder.SetDeviceName("MY-DEVICE-PREFIX")
 
 # Create some records
 ai = builder.aIn('AI', initial_value=5)
-
-def update(val):
-    print("got here")
-    print(val)
-    ai.set(val)
-
-ao = builder.aOut('AO', initial_value=12.45, on_update=update)
+ao = builder.aOut('AO', initial_value=12.45, always_update=True,
+                  on_update=lambda v: ai.set(v))
 
 # Boilerplate get the IOC started
 builder.LoadDatabase()
-softioc.iocInit()
-
-# Perform some reading/writing to the PVs
-async def do_read_write():
-    print(await caget("MY-DEVICE-PREFIX:AO"))
-    print(await caget("MY-DEVICE-PREFIX:AI"))
-    await caput("MY-DEVICE-PREFIX:AO", "999")
-    await asyncio.sleep(10)
-    print(await caget("MY-DEVICE-PREFIX:AI"))
-    print(await caget("MY-DEVICE-PREFIX:AO"))
-
-#asyncio.run(do_read_write())
-
-print(asyncio.run(caget("MY-DEVICE-PREFIX:AI")))
-print(asyncio.run(caget("MY-DEVICE-PREFIX:AO")))
-print(asyncio.run(caput("MY-DEVICE-PREFIX:AO","999")))
+softioc.iocInit(dispatcher)
 
-print(asyncio.run(caget("MY-DEVICE-PREFIX:AI")))
-print(asyncio.run(caget("MY-DEVICE-PREFIX:AO")))
+# Start processes required to be run after iocInit
+async def update():
+    while True:
+        ai.set(ai.get() + 1)
+        await asyncio.sleep(1)
 
+asyncio.run_coroutine_threadsafe(update(), dispatcher.loop)
 
+# Finally leave the IOC running with an interactive shell.
 softioc.interactive_ioc(globals())

docs/examples/example_cothread_ioc.py

@@ -7,7 +7,8 @@
 
 # Create some records
 ai = builder.aIn('AI', initial_value=5)
-ao = builder.aOut('AO', initial_value=12.45, on_update=lambda v: ai.set(v))
+ao = builder.aOut('AO', initial_value=12.45, always_update=True,
+                  on_update=lambda v: ai.set(v))
 
 # Boilerplate get the IOC started
 builder.LoadDatabase()
@@ -19,7 +20,6 @@ def update():
         ai.set(ai.get() + 1)
         cothread.Sleep(1)
 
-
 cothread.Spawn(update)
 
 # Finally leave the IOC running with an interactive shell.

setup.cfg

@@ -40,7 +40,7 @@ extend-ignore =
 
 [tool:pytest]
 # Run pytest with all our checkers, and don't spam us with massive tracebacks on error
-addopts = --tb=native -vv --doctest-modules --ignore=iocStats --ignore=epicscorelibs
+addopts = --tb=native -vv --doctest-modules --ignore=iocStats --ignore=epicscorelibs --ignore=docs
 
 [coverage:run]
 # This is covered in the versiongit test suite so exclude it here

tests/test_asyncio.py

@@ -34,7 +34,10 @@ def asyncio_ioc():
 async def test_asyncio_ioc(asyncio_ioc):
     import asyncio
     from aioca import caget, caput, camonitor, CANothing, _catools
-    # Unregister the atexit handler as it conflicts with cothread
+    # Unregister the aioca atexit handler as it conflicts with the one installed
+    # by cothread. If we don't do this we get a seg fault. This is not a problem
+    # in production as we won't mix aioca and cothread, but we do mix them in
+    # the tests so need to do this.
     atexit.unregister(_catools._catools_atexit)
 
     # Start