Winloop and NiceGUI: Potential speed improvement?

[evnchn]

Kicked started by #184 leading me to a rabbit hole.

Today I learnt that besides asyncio there are trio & anyio, and that asyncio allows to configure something called an "event loop", with uvloop being the prominent fast one which doesn't run on Windows but winloop does.

---

With that out of the way, as we all know, NiceGUI runs on Uvicorn, which officially supports 'auto', 'asyncio', 'uvloop' only, with a PR in progress at uvicorn #2435

Call me decently surprised when I tried the example in the winloop readme page, fix some changed symbols (WinLoopPolicy -> EventLoopPolicy), put NiceGUI with ui.run_with, and NiceGUI actually running with winloop!!!.

---

Attached please find evidence.

And the code I used:

https://gist.github.com/evnchn/1772e80587775f9603ae91606aa7fdf1

Could be huge if the description provided by winloop devs in README is true:

Window's python asyncio standard library is garbage especially when Windows Defender decides to eat half of your ram

[evnchn]

Behaviour on Ctrl+C (KeyboardInterrupt)

Before add winloop.install()

A bit of delay, classic Windows. Now you know why I do taskkill /f /im python.exe

After add winloop.install()

Delay is much less, though not instant but much better already.

---

Notably, the run_until_complete originally comes from base_events.py in asyncio, but now comes from winloop\\loop.pyx

It seems that we are indeed using winloop in this example.

Proclaimed speed improvement from winloop:

https://github.com/Vizonex/Winloop?tab=readme-ov-file#tcp-connections

That's pretty decent, if you ask me.

[rodja]

Wow. Very impressive. Thanks for sharing. Is that something we could integrate into NiceGUI directly?

[evnchn]

Well maybe someone can try their hands on modifying the much more popularly used ui.run function to sort of do the same.

But, that is a bit outside of my skill set. I have tried to monkeypatch said function to do what I want in the past, but I just can't quite wrap my head around it. And uvicorn source code is even harder to understand.

Moreover, this just instinctively feels, wrong... Because uvicorn official documentation states that the loop parameter should be a string, not a loop object.

[evnchn]

Well, no need to modify ui.run. For reasons beyond my understanding, we just need to attach it in app.on_startup.

Check: https://github.com/evnchn/nicegui-winloop-easy

Help is needed to test this more completely.

[evnchn]

@falkoschindler If we do embark on putting winloop into NiceGUI (think: ui.run(winloop=True)), should we add Windows in the test workflow? https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#standard-github-hosted-runners-for-public-repositories

[evnchn]

On perhaps the idea of running test on a selected number of versions, I would recommend 3.11 on Linux ("At Zauberzeug we mainly use 3.11", and I guess it is most probably Linux-based) and 3.8 on Windows (least features, generally hardest to deal with?)

[evnchn]

But wait. If the use of GitHub-hosted runners on public repositories is free and unlimited, then I would recommend to not reduce the number of test?

[rodja]

We should be aware of the environmental impact. Running all our tests will transform harvested power into heat without producing much knowledge. I'm in favour of reducing the compute as much as possible.

[evnchn]

That's a fair point.

Though, my room is cold and I need to turn on the warmer anyways, so I am thinking how I can put my Windows laptop (which after removing the Lid driver thinks itself is a desktop when it is plugged in) as a self-hosted runner to warm the room.

While this also potentially makes tests complete faster (not sure but potentially the tasks will take a longer time if we add more platforms to test because GitHub would probably allocate a certain amount computational power to us and divides that along the tests, otherwise a repo can just add tons of tests and use tons of computational power)

[Vizonex]

Good luck. Feel free to throw us an issue if you need anything.