Add handle_response to normalize @on_method return values#15
Merged
Conversation
Plugin methods can now yield/return Result, List[Result], or use generators without calling send_results() explicitly. Introduces types.py to break the result.py→plugin.py circular import, and response.py with handle_response() applied transparently in the on_method wrapper. Async generators are handled in EventHandler.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
handle_response()function that transparently normalizes what@on_method-decorated functions return — no more boilerplatesend_results()callsyield Result(...), return aList[Result], or use generators; existing methods returningJsonRPCResponseorJsonRPCRequestcontinue to work unchangedpyflowlauncher/types.pyto hold theMethodalias, breaking a latent circular import betweenresult.pyandplugin.pyEventHandler._await_maybeNew usage
Test plan
pytest tests/— all 57 tests pass (15 new intests/test_response.py)Result,List[Result], sync generator (single/multiple/list yields),JsonRPCRequestpass-through,JsonRPCResponsepass-through,None@plugin.on_methodwith generator, single return, list return