Skip to content

Make command classes backwards compatible with existing class hierarchies #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rwols wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Make command classes backwards compatible with existing class hierarchies #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
330dc81
Revert "Ensure Command.run() being a coroutine function (#36)"
rwols Aug 7, 2026
3e2560f
Allow running the *Command classes from the main thread
rwols Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 13 additions & 20 deletions src/sublime_aio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import asyncio
import concurrent.futures
import inspect
import io
import os
import sys
Expand Down Expand Up @@ -413,15 +414,11 @@ class ApplicationCommand(sublime_plugin.ApplicationCommand):
An async `Command` instantiated just once.
"""

def __init__(self):
""":meta private:"""
if not iscoroutinefunction(self.run):
raise TypeError(f"{type(self).__name__}.run() must be an asyncio coroutine function!")

def run_(self, edit_token: int, args: sublime.CommandArgs) -> None:
args = self.filter_args(args)
try:
call_coroutine(self.run(**args) if args else self.run())
if (maybe_coro := self.run(**args) if args else self.run()) and inspect.iscoroutine(maybe_coro):
call_coroutine(maybe_coro)
except TypeError as e:
if (
"required positional argument" in str(e)
Expand All @@ -448,17 +445,17 @@ class WindowCommand(sublime_plugin.WindowCommand):
retrieved via `self.window <window>`.
"""

def __init__(self, window: sublime.Window): # pyright: ignore[reportMissingSuperCall]
def __init__(self, window: sublime.Window):
""":meta private:"""
self.window: Window = Window(window.id()) # pyright: ignore[reportIncompatibleVariableOverride]
"""The asyncio supporting `Window` this command is attached to."""
if not iscoroutinefunction(self.run):
raise TypeError(f"{type(self).__name__}.run() must be an asyncio coroutine function!")

self.window: Window = Window(window.id())
""" The asyncio supporting `Window` this command is attached to. """

def run_(self, edit_token: int, args: sublime.CommandArgs) -> None:
args = self.filter_args(args)
try:
call_coroutine(self.run(**args) if args else self.run())
if (maybe_coro := self.run(**args) if args else self.run()) and inspect.iscoroutine(maybe_coro):
call_coroutine(maybe_coro)
except TypeError as e:
if (
"required positional argument" in str(e)
Expand Down Expand Up @@ -497,17 +494,13 @@ async def run(self):
```
"""

def __init__(self, view: sublime.View): # pyright: ignore[reportMissingSuperCall]
""":meta private:"""
self.view: View = View(view.id()) # pyright: ignore[reportIncompatibleVariableOverride]
"""The asyncio supporting `View` this command is attached to."""
if not iscoroutinefunction(self.run):
raise TypeError(f"{type(self).__name__}.run() must be an asyncio coroutine function!")

def run_(self, edit_token: int, args: sublime.CommandArgs) -> None:
args = self.filter_args(args)
try:
call_coroutine(self.run(**args) if args else self.run())
if inspect.iscoroutinefunction(self.run):
call_coroutine(self.run(**args) if args else self.run())
else:
self.run(edit_token, **args) if args else self.run(edit_token)
except TypeError as e:
if (
"required positional argument" in str(e)
Expand Down