Ideas for asyncio

[rwols]

I'm planning to rely completely on asyncio for ST4 and LSP, and I want to be able to run tests with asyncio.

I'm envisioning this possibility:

from my_package import get_my_custom_loop
from unittesting import AsyncTestCase
import asyncio


class MyTestSuite(AsyncTestCase):

    # customization point: allow the user to define its own loop
    # if this function is not overridden, UnitTesting should provide its own loop
    def get_running_loop(self) -> asyncio.AbstractEventLoop:
        return get_my_custom_loop()

    # customization point: are the tests in this suite allowed to run all at once or one after the other?
    def allowed_to_run_parallel(self) -> bool:
        return False

    # customization point if get_running_loop is overridden: we want to know if the loop is running on the UI thread
    # or not
    def loop_is_on_main_thread(self) -> bool:
        return False

    # an actual test
    async def test_foo(self) -> None:
        await asyncio.sleep(1)
        self.assertTrue(True)

See also: sublimehq/sublime_text#3129

[randy3k]

it seems that we could borrow some idea from https://github.com/kwarunek/aiounittest

[deathaxe]

Asyncio is supported by underlying unittest library via IsolatedAsyncioTestCase class. Note this class starting a dedicated thread running an isolated eventloop in.

see: #278

That's not very different to how sublime_aio provides a global event loop.

Running an asyncio event loop on ST's main thread would require a custom event loop implementation running code via sublime.set_timeout(), which as a result may additional work to avoid compatibility issues with libraries such as anyio or sniffio.