sirk390 / wxasync

asyncio support for wxpython

wxasync

asyncio support for wxpython

wxasync it a library for using python 3 asyncio (async/await) with wxpython. The library polls UI messages every 20ms and runs the asyncio message loop the rest of the time. When idle, the CPU usage is 0% on windows and about 1-2% on MacOS.

Installation

wxasync requires python 3.7. For earlier versions of python use wxasync 0.45.

Install using:

pip install wxasync

Usage

Create a WxAsyncApp instead of a wx.App

app = WxAsyncApp()

and use AsyncBind to bind an event to a coroutine.

async def async_callback():
    (...your code...)
    
AsyncBind(wx.EVT_BUTTON, async_callback, button1)

You can still use wx.Bind together with AsyncBind.

If you don't want to wait for an event, you just use StartCoroutine and it will be executed immediatly. It will return an asyncio.Task in case you need to cancel it.

task = StartCoroutine(update_clock_coroutine, frame)

If you need to stop it run:

task.cancel()

Any coroutine started using AsyncBind or using StartCoroutine is attached to a wx.Window. It is automatically cancelled when the Window is destroyed. This makes it easier to use, as you don't need to take care of cancelling them yourselve.

To show a Dialog, use AsyncShowDialog or AsyncShowDialogModal. This allows to use 'await' to wait until the dialog completes. Don't use dlg.ShowModal() directly as it would block the event loop.

You start the application using:

await app.MainLoop()

Below is full example with AsyncBind, WxAsyncApp, and StartCoroutine:

import wx
from wxasync import AsyncBind, WxAsyncApp, StartCoroutine
import asyncio
import time


class TestFrame(wx.Frame):
    def __init__(self, parent=None):
        super(TestFrame, self).__init__(parent)
        vbox = wx.BoxSizer(wx.VERTICAL)
        button1 =  wx.Button(self, label="Submit")
        self.edit =  wx.StaticText(self, style=wx.ALIGN_CENTRE_HORIZONTAL|wx.ST_NO_AUTORESIZE)
        self.edit_timer =  wx.StaticText(self, style=wx.ALIGN_CENTRE_HORIZONTAL|wx.ST_NO_AUTORESIZE)
        vbox.Add(button1, 2, wx.EXPAND|wx.ALL)
        vbox.AddStretchSpacer(1)
        vbox.Add(self.edit, 1, wx.EXPAND|wx.ALL)
        vbox.Add(self.edit_timer, 1, wx.EXPAND|wx.ALL)
        self.SetSizer(vbox)
        self.Layout()
        AsyncBind(wx.EVT_BUTTON, self.async_callback, button1)
        StartCoroutine(self.update_clock, self)
        
    async def async_callback(self, event):
        self.edit.SetLabel("Button clicked")
        await asyncio.sleep(1)
        self.edit.SetLabel("Working")
        await asyncio.sleep(1)
        self.edit.SetLabel("Completed")

    async def update_clock(self):
        while True:
            self.edit_timer.SetLabel(time.strftime('%H:%M:%S'))
            await asyncio.sleep(0.5)


async def main():            
    app = WxAsyncApp()
    frame = TestFrame()
    frame.Show()
    app.SetTopWindow(frame)
    await app.MainLoop()


asyncio.run(main())

Performance

Below is view of the performances (on windows Core I7-7700K 4.2Ghz):

Scenario	Latency	Latency (at max throughput)	Max Throughput(msg/s)
asyncio only (for reference)	0ms	17ms	571 325
wx only (for reference)	0ms	19ms	94 591
wxasync (GUI)	5ms	19ms	52 304
wxasync (GUI+asyncio)	5ms GUI / 0ms asyncio	24ms GUI / 12ms asyncio	40 302 GUI + 134 000 asyncio

The performance tests are included in the 'test' directory.