Implement a new parameter to generate only async stubs #631
Conversation
This file contains 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
This commit adds a new parameter `async_only` to the plugin, that when
present, will only generate the async stubs.
The current {}AsyncStub classes are "fake", they are not present in the
.py file, so they can only be used to write type hints. Using them also
only works if the user manually casts the sync stub to the async stub.
Since most users will only want to use either the sync or the async
stub, this new parameter will allow to generate only the stubs that are
suited for the user's use case, and allow them to have less hacky code.
Signed-off-by: Leandro Lucarella <[email protected]>
|
A draft until I get some confirmation that something like this would be accepted. Then I can continue updating the docs and tests (please let me know if anything should be updated). |
|
I think it would make more sense for this to be an enum option. Default to both, async only, sync only |
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.
This commit adds a new parameter
async_onlyto the plugin, that when present, will only generate theasyncstubs.The current
{}AsyncStubclasses are fake, they are not present in the .py file, so they can only be used to write type hints. Using them also only works if the user manually casts the sync stub to theasyncstub.Since most users will only want to use either the sync or the
asyncstub, this new parameter will allow generating only the stubs that are suited for the user's use case, and allow them to have less hacky code.Fixes #536.