Add sublime_plugin stubs. #160
Conversation
FichteFoll
left a comment
FichteFoll
left a comment
There was a problem hiding this comment.
I didn't do a detailed review; just proceed with this.
gwenzek
left a comment
gwenzek
left a comment
There was a problem hiding this comment.
I think I spotted on issue for this PR.
In my InputHandler preview, validate and confirm receives only a string.
But https://github.com/jfcherng-sublime/ST-API-stubs/blob/master/sublime_plugin.pyi#L649 agrees with you.
| def next_input(self, args: dict) -> Optional[CommandInputHandler]: ... | ||
| def placeholder(self) -> str: ... | ||
| def initial_text(self) -> str: ... | ||
| def preview(self, arg: dict) -> Union[str, sublime.Html]: ... |
There was a problem hiding this comment.
I think this should be
def preview(self, arg: str)
def validate(self, arg: str)
def confirm(self, arg: str)
Also note that confirm can receive an event. Not sure how to handle this.
We could add def confirm_(self, arg: str, event: sublime.Event)
There was a problem hiding this comment.
I haven't verified this right now, but from the documentation, the arg received should be the value of a ListInputHandler's list item, which may be any serializable, meaning ListInputHandler must be a generic class.
TextInputHandler would then inherit CommandInputHandler[str].
This means that ListInputItem needs to be generic as well, but we don't have that at all currently since it's ST4 only.
There was a problem hiding this comment.
Gotcha. I only tried on TextInputHandler.
What's the plan for Python 3.8 and ST4? Is there a specific branch I should look at?
| class TextCommand(Command): | ||
| view: sublime.View | ||
|
|
||
| def run(self, edit: sublime.Edit) -> None: ... |
There was a problem hiding this comment.
This is one is tricky. TextCommand can accepts more argument.
But subclassing run(self, edit: sublime.Edit, **args: Any) by run(self, edit: sublime.Edit, my_cmd_argument: str) isn't allowed anyway.
There was a problem hiding this comment.
I think just having run: Callable[..., None] would be more inline of mypy philosophy of "no false positive"
|
@gwenzek I've addressed those issues in the linked PR. |
Will be useful for #136 and more.