import sublime_aioFirst plugin importing sublime_aio starts a global event loop
in a dedicated background thread, which runs forever
and is shared across plugins.
Commands and event handlers are dispatched asynchronously, causing no messurable delay on UI thread.
Note
ST's asynchronous event handler methods (e.g. on_modified_async)
are not supported as task scheduling in UI thread is faster.
This package demonstrates power of asyncio and simdjson to handle hundrets of thousands of completions smoothly, without blocking Sublime Text's UI in any way.
Both, EventListener and ViewEventListener are supported.
import simdjson
import sublime_aio
class CompletionListener(sublime_aio.ViewEventListener):
parser = simdjson.Parser()
async def on_query_completions(self, prefix, locations):
doc = self.parser.parse(data)
return (i["label"] for i in doc["items"])
async def on_modified(self):
print(f"{self.view!r} got modified on io loop!")
@sublime_aio.debounced(200)
async def on_selection_modified(self):
print(f"Selection of {self.view!r} got modified on io loop!")import sublime_aio
class TextChangeListener(sublime_aio.TextChangeListener):
async def on_text_changed(self, changes):
print(f"{self.buffer!r} changed: {changes}")
async def on_reload(self):
print(f"{self.buffer!r} reloaded")
async def on_revert(self):
print(f"{self.buffer!r} reverted")Replace sublime_plugin.ApplicationCommand by sublime_aio.ApplicationCommand
to implement commands running asynchronously on global event loop.
import sublime_aio
import sublime_plugin
class NameInputHandler(sublime_plugin.TextInputHandler):
def placeholder(self):
return "Enter your name"
class MyAsyncCommand(sublime_aio.ApplicationCommand):
def input_description(self):
return "Name:"
def input(self, args):
if "name" not in args:
return NameInputHandler()
async def run(self, name):
print(f"Hello {name}!")Corresponding Default.sublime-commands
[
{
"caption": "My Async Command",
"command": "my_async"
},
]import sublime_aio
import sublime_plugin
class NameInputHandler(sublime_plugin.TextInputHandler):
def placeholder(self):
return "Enter your name"
class MyAsyncWindowCommand(sublime_aio.WindowCommand):
def input_description(self):
return "Name:"
def input(self, args):
if "name" not in args:
return NameInputHandler()
async def run(self, name):
print(f"Hello {name} on {self.window}!")Corresponding Default.sublime-commands
[
{
"caption": "My Async Window Command",
"command": "my_async_window"
},
]Due to asynchronous command execution and current ST API restrictions,
sublime_aio can't provide an asynchronous TextCommand.
The edit token required for text manipulation is only valid
during synchronous command execution.
Instead a sublime_aio.ViewCommand is provided
to implement view-specific commands
which do not directly alter content.
import sublime_aio
import sublime_plugin
class NameInputHandler(sublime_plugin.TextInputHandler):
def placeholder(self):
return "Enter your name"
class MyAsyncViewCommand(sublime_aio.ViewCommand):
def input_description(self):
return "Name:"
def input(self, args):
if "name" not in args:
return NameInputHandler()
async def run(self, name):
print(f"Inserting \"{name}\" to {self.view} on io loop!")
self.view.run_command("insert", {"characters": name})Corresponding Default.sublime-commands
[
{
"caption": "My Async View Command",
"command": "my_async_view"
},
]Use sublime_aio.run_coroutine() to call a coroutine from synchronous code.
It will be executed on event loop's background thread.
import sublime_aio
async def init1():
await asyncio.sleep(1.5)
print("Init Task 1 done!")
async def init2():
await asyncio.sleep(1.0)
print("Init Task 2 done!")
async def init_plugin():
print("Initializing plugin...")
task1 = asyncio.create_task(init1())
task2 = asyncio.create_task(init2())
await asyncio.gather(task1, task2)
def plugin_loaded():
def on_done(fut):
print("All up and running!")
# Initialize plugin on asyncio event loop
sublime_aio.run_coroutine(init_plugin()).add_done_callback(on_done)